跳到主要内容

语音信息状态报告接收 API

PaaSoo 平台会在语音信息传送过程中，将状态报告（Delivery Report）推送至用户事先指定的回调地址（USER_CALLBACK_URL）。通过该报告，您可以及时了解通话是否成功接通、对方是否拒接或未接听、通话时长和计费情况等详细信息。

1.回调方式​

信息
  • HTTP Method：GET
  • 回调地址：USER_CALLBACK_URL（您在服务器配置的接收状态报告的地址）。回调到达时将附带包括以下字段的查询参数。

2.参数说明​

参数类型描述示例
callIdstring消息ID，每条语音记录的唯一标识，可与发送时返回的 messageid 相对应。30035c-3ed097-1000
callerIdstring主叫号码 (from)，最多 20 个字符；若需自定义，请联系技术支持或客户经理。+85299998888
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目标号码，包含国家区号。8618911111111
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=8618911111111&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=8618911111111&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。我们将竭诚为您提供技术协助。