跳至主要内容

語音信息狀態報告接收 API

PaaSoo 平台會在語音訊息傳送過程中，將狀態報告（Delivery Report）推送至用戶事先指定的回呼位址（USER_CALLBACK_URL）。透過該報告，您可以及時了解通話是否成功接通、對方是否拒接或未接聽、通話時間和計費情況等詳細資訊。

1. 回呼方式​

資訊
  • HTTP Method：GET
  • 回呼位址：USER_CALLBACK_URL（您在伺服器設定的接收狀態報告的位址）。回呼到達時將附帶包括以下欄位的查詢參數。

2. 參數說明​

參數類型描述範例
callIdstring訊息 ID，每條語音記錄的唯一標識，可與發送時返回的 messageid 相對應。30035c-3ed097-1000
callerIdstring主叫號碼 (from)，最多 20 個字元；若需自訂，請聯絡技術支援或客戶經理。+886912345678
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目標號碼，包含國際電話代碼。886912345678
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=886912345678&callerId=432354364554&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=886912345678&callerId=12727772019&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。我們將竭誠為您提供技術協助。