メインコンテンツまでスキップ

音声メッセージのステータスレポート受信 API

PaaSoo プラットフォームは、音声メッセージの送信プロセス中に、ステータスレポート（Delivery Report）をユーザーが事前に指定したコールバック URL（USER_CALLBACK_URL）にプッシュします。このレポートを通じて、通話が正常に接続されたか、相手が拒否したか応答しなかったか、通話時間、課金状況などの詳細情報をタイムリーに把握することができます。

1. コールバック方式​

備考
  • HTTP Method：GET
  • コールバック URL：USER_CALLBACK_URL（ステータスレポートを受信するためにサーバーに設定したアドレス）。コールバックが到達すると、以下のフィールドを含むクエリパラメータが付与されます。

2. パラメータの説明​

パラメータ型説明サンプル
callIdstringメッセージ ID。各音声レコードの一意識別子であり、送信時に返される messageid に対応します。30035c-3ed097-1000
callerIdstring発信元番号 (from)。最大 20 文字。カスタマイズが必要な場合は、テクニカルサポートまたはアカウントマネージャーにご連絡ください。815012345678
statusintegerステータス値：
  • 0：発信動作が終了しました（その後、statusCode に基づいて通話ステータスを区別できます）。
  • 400：拒否または異常。直接発信が拒否された場合など。
0
statusCodestringステータスレポートコード：
  • completed：通話が正常に接続され、再生が完了しました。
  • rejected：ブラックリストや残高不足など、通信ゲートウェイまたは規制上の理由により拒否されました。詳細は errorCode と組み合わせて分析できます。
  • failed：発信は開始されましたが、相手が応答しなかった、またはその他の理由により再生に失敗しました。
completed
errorCodestringエラーステータスコード。99 はその他のキャリアエラーを示します。さらに詳細を知りたい場合は、テクニカルサポートチーム（support@paasoo.com）にお問い合わせください。99-その他のキャリアエラー
receiveTimestringプラットフォームがこのステータスを受信した時間（ISO8601、UTC+0）。2024-04-26T08:31:49Z
statusTimestringステータスレポートが生成された時間（ISO8601、UTC+0）。2024-04-26T08:32:49Z
startTimestring通話開始時間（ISO8601、UTC+0）。2024-04-26T08:32:49Z
endTimestring通話終了時間（ISO8601、UTC+0）。2024-04-26T08:32:49Z
hangupCausestring切断理由の説明。《SIP 切断理由コード対応表》 を参照できます。NORMAL_CLEARING
hangupCodestringSIP 切断ステータスコード。《SIP 切断理由コード対応表》 を参照できます。200
tostring宛先番号。国番号を含みます。819011111111
pricenumber今回の通話の消費金額。0.000016
currencystring課金に使用される通貨。EUR
callDurationinteger通話時間（課金秒数）。9
countryIsostring宛先番号がある国の ISO コード。JP
networkstring宛先番号が使用しているキャリアのネットワークコード。44010
chargedstringこの通話に課金するかどうか：yes / no。yes

3. コールバックのサンプル​

3.1 成功サンプル​

https://USER_CALLBACK_URL?callId=30035c-3ed097-1000&status=0&statusCode=completed&hangupCause=NORMAL_CLEARING&hangupCode=200&to=819011111111&callerId=815012345678&statusTime=2024-04-26T08:32:49Z&price=0.000016&callDuration=9&countryIso=JP&network=44010&startTime=2024-04-26T08:32:40Z&endTime=2024-04-26T08:32:49Z&receiveTime=2024-04-26T08:32:49Z&charged=yes&currency=EUR

3.2 失敗サンプル​

https://USER_CALLBACK_URL?callId=300395-d87d44-4000&errorCode=99&status=0&statusCode=failed&hangupCause=NORMAL_CLEARING&hangupCode=480&to=819011111111&callerId=815012345678&callDuration=0&countryIso=JP&network=44010&endTime=2024-10-22T07:31:59Z&statusTime=2024-10-22T07:31:59Z&receiveTime=2024-10-22T07:31:58Z&charged=no&currency=JPY
注意

コールバックを正常に受信して処理した後、受信成功を示すために HTTP ステータスコード 200 を返してください。200 以外を返した場合、または応答がない場合は、受信失敗と見なされ、プラットフォームは 5/10/30 分の再試行間隔メカニズムに従って再送信します。

テクニカルサポート

API 連携の過程で技術的な問題やビジネスに関する疑問が生じた場合は、いつでも当社の開発者サポートチーム（support@paasoo.com）までご連絡ください。誠心誠意、技術的なサポートを提供いたします。