メッセージ送信結果の取得

API リファレンス

‍

メッセージの送信結果を取得します。

‍

GET /v2/messages/:identifier

‍

‍

リクエストパラメータ

‍

Path Parameters

‍

‍

エラーコード

エラー定義 参照。

‍

レスポンス

ステータスコード 200 OK と以下のプロパティを含む JSON オブジェクトを返します。

‍

送信完了

{
  "provider": "line",
  "result": {
    "status": "success"
  }
}

‍

送信予約中

{
  "provider": "line",
  "result": {
    "status": "reserved"
  }
}

‍

送信処理中

{
  "provider": "line",
  "result": {
    "status": "processing"
  }
}

‍

送信失敗（ソーシャルPLUS のシステム要因による場合）

{
  "provider": "line",
  "result": {
    "status": "failed",
    "error": {
      "code": 0,
      "message": "Failed to send message."
    }
  }
}

‍

送信失敗（プロバイダー要因による場合）

{
  "provider": "line",
  "result": {
    "status": "failed",
    "error": {
      "code": 1,
      "message": "Provider server error.",
      "from_provider": {
        "message": "Authentication failed due to the following reason: accessToken expired(2). Confirm that the access token in the authorization header is valid."
      }
    }
  }
}

‍

上記の from_provider.message にはプロバイダーから返されたエラーメッセージをそのまま含みます。詳細はプロバイダー（LINE）のエラーレスポンス仕様をご確認ください。

‍

実行サンプル

curl -L -X GET https://msgapi.socialplus.jp/v2/messages/{identifier} \
  -H 'Accept: application/json' \
  -H 'X-API-Key: {API Key}'

‍