配信ステータス取得API

delivery要素(配信ステータス取得_配信ID・リクエストID指定時レスポンス)

配信ステータス取得APIで取得した情報をまとめる要素です。

<delivery id="0">
    <deliver_id>xxxxxx</deliver_id>
    <request_id>xxxxxxx</request_id>
    <action>xxxxxxx</action>
    <status code="0">XXXXXXXX</status>
    <sent_cnt>0</sent_cnt>
    <error_cnt >0</error_cnt>
    <result code="0">処理が正常に終了しました</result>
</delivery>

構成要素

以下の要素で構成されます。

  1. deliver_id
  2. request_id
  3. action
  4. status
  5. sent_cnt
  6. error_cnt
  7. result

deliver_id

レスポンスで指定された配信IDを表す要素です。

<deliver_id>xxxxxx</deliver_id>
構成要素 配信予約APIでリクエストした結果、発行された配信ID

request_id

同一のリクエストIDで送信された場合は、重複した指示と判定し、エラーを返します。
レスポンスには、リクエストで設定した値と同じ値が設定されます。

<request_id>xxxx</request_id>
構成要素 半角英数64文字以内の文字列

action

request_idを指定して条件取得を行った場合に、該当する処理のactionを返却する要素です。
指定したrequest_idで実行したactionを取得できます。

<action>XXXXX</action>
構成要素 reserve・delete

status

配信IDやリクエストIDで指定した配信の現在のステータスを返却する要素です。

<status code="0">XXXXXXXX</status>
構成要素 配信予約API・配信予約削除APIで指定した配信データの現在のステータスメッセージ
属性名 内容 数値/文字列 意味
code ステータス 数値 1：配信待ち
2：配信完了
3：配信失敗
4：配信中
5：削除
6：処理失敗

sent_cnt

指定された配信において、配信が成功した件数を返却する要素です。ステータスが不明の場合、この要素はレスポンスに含まれません。

<sent_cnt>0</sent_cnt>
構成要素 配信成功件数

error_cnt

指定された配信において、配信がエラーとなった件数を返却する要素です。ステータスが不明の場合、この要素はレスポンスに含まれません。

<error_cnt >0</error_cnt>
構成要素 配信エラー件数

result

詳細は以下ページを参照してください。

result要素(レスポンス)