文档首页 > > API参考> 语音验证码API> 语音验证码呼叫状态通知API

语音验证码呼叫状态通知API

分享
更新时间: 2019/08/30 GMT+08:00

接口功能

RTC业务平台通过此接口向客户推送语音通话业务用户呼叫时的状态信息,如呼入、呼出、振铃、应答、挂机等状态的信息。

请求方向

RTC业务平台(客户端) → 客户服务器(服务端)

使用说明

  • 前提条件
    • SP在开发应用时,若需订阅呼叫状态通知,必须要提供呼叫状态接收URL(statusUrl),并且确保URL能够正常处理RTC业务平台发送的通知信息。
    • 提供呼叫状态接收URL有以下两种方式:
      • 提前通过应用管理向RTC平台提交呼叫状态接收URL。
      • SP应用调用场景API时,填写statusUrl。
  • 使用限制

    RTC业务平台推送呼叫状态给开发者应用,仅支持POST方式。

接口类型

表1 接口类型说明

请求方法

POST

访问URI

开发者应用接收呼叫状态URL

通信协议

HTTPS/HTTP

请求参数

SP调用语音验证码API,RTC业务平台发起呼叫,给用户播放语音验证码。

注:以下流程以RTC业务平台呼叫A,给A播放语音验证码为例。流程和接口示例仅供参考,请以实际消息为准。

表2 请求Body参数说明

参数名称

是否必选

参数类型

说明

eventType

String(枚举)

该参数标识API事件通知的类型。取值范围如下:

statusInfo

CallStatusInfo

呼叫状态事件的信息。

当eventType参数为callout、alerting、answer、disconnect时携带。

CallStatusInfo

表3 callout:呼出事件

参数名称

是否必选

参数类型

说明

timestamp

String(1-128)

该呼叫事件发生时RTC业务平台的UNIX时间戳。

该参数取值为UTC时间(+8小时为北京时间)格式,即为“yyyy-MM-dd HH:mm:ss”。

userData

String(1-256)

用户附属信息,此参数的值与“语音验证码场景API”中的"userData"参数值一致。

sessionId

String(1-256)

唯一指定一条通话链路的标识ID。

caller

String(1-32)

主叫号码。

号码仅支持全局号码格式(包含国家码),比如+8613866887021。

注:呼出事件的主叫号码为SP设置的来电显示号码(displayNbr)。

called

String(1-32)

被叫号码。

号码仅支持全局号码格式(包含国家码),比如+8613866887021。

注:呼出事件的被叫号码为A号码。

接口示例

POST /status HTTP/1.1

Content-Length: xx 

{"eventType":"callout","statusInfo":{"sessionId":"1202_14260_4294967295_20190124024846@callenabler245.huaweicaas.com","timestamp":"2019-01-24 02:48:46","caller":"+8613800000022","called":"+8613800000021"}}
表4 alerting:振铃事件

参数名称

是否必选

参数类型

说明

timestamp

String(1-128)

该呼叫事件发生时RTC业务平台的UNIX时间戳。

该参数取值为UTC时间(+8小时为北京时间)格式,即为“yyyy-MM-dd HH:mm:ss”。

userData

String(1-256)

用户附属信息,此参数的值与“语音验证码场景API”中的"userData"参数值一致。

sessionId

String(1-256)

唯一指定一条通话链路的标识ID。

caller

String(1-32)

主叫号码。

号码仅支持全局号码格式(包含国家码),比如+8613866887021。

注:振铃事件的主叫号码为SP设置的来电显示号码(displayNbr)。

called

String(1-32)

被叫号码。

号码仅支持全局号码格式(包含国家码),比如+8613866887021。

注:振铃事件的被叫号码为A号码。

接口示例

POST /status HTTP/1.1

Content-Length: xx 

{"eventType":"alerting","statusInfo":{"sessionId":"1202_14260_4294967295_20190124024846@callenabler245.huaweicaas.com","timestamp":"2019-01-24 02:48:47","caller":"+8613800000022","called":"+8613800000021"}}
表5 answer:应答事件

参数名称

是否必选

参数类型

说明

timestamp

String(1-128)

该呼叫事件发生时RTC业务平台的UNIX时间戳。

该参数取值为UTC时间(+8小时为北京时间)格式,即为“yyyy-MM-dd HH:mm:ss”。

userData

String(1-256)

用户附属信息,此参数的值与“语音验证码场景API”中的"userData"参数值一致。

sessionId

String(1-256)

唯一指定一条通话链路的标识ID。

caller

String(1-32)

主叫号码。

号码仅支持全局号码格式(包含国家码),比如+8613866887021。

注:应答事件的主叫号码为SP设置的来电显示号码(displayNbr)。

called

String(1-32)

被叫号码。

号码仅支持全局号码格式(包含国家码),比如+8613866887021。

注:应答事件的被叫号码为A号码。

接口示例

POST /status HTTP/1.1

Content-Length: xx 

{"eventType":"answer","statusInfo":{"sessionId":"1202_14260_4294967295_20190124024846@callenabler245.huaweicaas.com","timestamp":"2019-01-24 02:49:12","caller":"+8613800000022","called":"+8613800000021"}}
表6 disconnect:挂机事件

参数名称

是否必选

参数类型

说明

timestamp

String(1-128)

该呼叫事件发生时RTC业务平台的UNIX时间戳。

该参数取值为UTC时间(+8小时为北京时间)格式,即为“yyyy-MM-dd HH:mm:ss”。

userData

String(1-256)

用户附属信息,此参数的值与“语音验证码场景API”中的"userData"参数值一致。

sessionId

String(1-256)

唯一指定一条通话链路的标识ID。

caller

String(1-32)

主叫号码。

号码仅支持全局号码格式(包含国家码),比如+8613866887021。

注:挂机事件的主叫号码为SP设置的来电显示号码(displayNbr)。

called

String(1-32)

被叫号码。

号码仅支持全局号码格式(包含国家码),比如+8613866887021。

注:挂机事件的被叫号码为A号码。

stateCode

Integer

通话挂机的原因值,仅当eventType为disconnect时携带。

取值范围及表示的含义请参考通话挂机原因值说明

stateDesc

String(1-128)

通话挂机的原因值的描述,仅当eventType为disconnect时携带。

接口示例

POST /status HTTP/1.1

Content-Length: xx 

{"eventType":"disconnect","statusInfo":{"sessionId":"1202_14260_4294967295_20190124024846@callenabler245.huaweicaas.com","timestamp":"2019-01-24 02:49:23","caller":"+8613800000022","called":"+8613800000021","stateCode":0,"stateDesc":"The user releases the call."}}

响应参数

接收到事件通知时,第三方服务器响应返回200则为成功,否则RTC业务平台会认为推送失败。

响应示例
HTTP/1.1 200 OK 
Content-Type: application/json;charset=UTF-8

代码样例

前往代码样例查看。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区