配信ステータス取得API

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

取得情報を束ねる要素です。

<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>

構成要素

以下の項目が、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 指定で条件取得を行った場合に、該当する処理の aution について表示する要素です。
指定した 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要素(レスポンス)