本文主要是介绍php语音回呼话单通知,语音回呼呼叫状态通知API,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
语音回呼场景请求参数
语音回呼,也叫双向回呼,用户使用语音回呼软件呼叫另一方,语音通话平台依次呼叫主被叫号码,建立通话,实现主被叫号码间的点对点通信。
注:以下流程以用户A请求呼叫用户B,语音通话平台依次呼叫主叫号码A和被叫号码B,B用户接听为例。流程和接口示例仅供参考,请以实际消息为准。
表2请求Body参数说明参数名称
是否必选
参数类型
说明
statusInfo
否
CallStatusInfo
呼叫状态事件的信息。
当eventType参数为callout、alerting、answer、disconnect时携带。
CallStatusInfo
表3callout:呼出事件参数名称
是否必选
参数类型
说明
timestamp
是
String(1-128)
该呼叫事件发生时语音通话平台的UNIX时间戳。
该参数取值为UTC时间(+8小时为北京时间)格式,即为“yyyy-MM-dd HH:mm:ss”。
userData
否
String(1-256)
用户附属信息,此参数的值与“语音回呼场景API”中的"userData"参数值一致。
sessionId
是
String(1-256)
唯一指定一条通话链路的标识ID。
caller
否
String(1-32)
主叫号码。
号码仅支持全局号码格式(包含国家码),比如+86138****7021。
注:
语音回呼业务:
语音通话平台呼叫A时的呼出事件主叫号码为SP设置的主叫端来电显示号码(displayNbr)。
语音通话平台呼叫B时的呼出事件主叫号码为SP设置的被叫端来电显示号码(displayCalleeNbr)。
号显回呼业务:
语音通话平台呼叫A时的呼出事件主叫号码为平台号码(bindNbr)。
语音通话平台呼叫B时的呼出事件主叫号码为用户A号码。
called
否
String(1-32)
被叫号码。
号码仅支持全局号码格式(包含国家码),比如+86138****7021。
注:语音回呼场景
语音通话平台呼叫A时的呼出事件被叫号码为A。
语音通话平台呼叫B时的呼出事件被叫号码为B。
接口示例
POST /status HTTP/1.1
Content-Length: xx
{"eventType":"callout","statusInfo":{"sessionId":"1201_612_4294967295_20190124030424@callenabler245.huaweicaas.com","timestamp":"2019-01-24 03:04:24","caller":"+86138****0022","called":"+86138****0021"}}
表4alerting:振铃事件参数名称
是否必选
参数类型
说明
timestamp
是
String(1-128)
该呼叫事件发生时语音通话平台的UNIX时间戳。
该参数取值为UTC时间(+8小时为北京时间)格式,即为“yyyy-MM-dd HH:mm:ss”。
userData
否
String(1-256)
用户附属信息,此参数的值与“语音回呼场景API”中的"userData"参数值一致。
sessionId
是
String(1-256)
唯一指定一条通话链路的标识ID。
caller
否
String(1-32)
主叫号码。
号码仅支持全局号码格式(包含国家码),比如+86138****7021。
注:
语音回呼业务:
语音通话平台呼叫A时的振铃事件主叫号码为SP设置的主叫端来电显示号码(displayNbr)。
语音通话平台呼叫B时的振铃事件主叫号码为SP设置的被叫端来电显示号码(displayCalleeNbr)。
号显回呼业务:
语音通话平台呼叫A时的振铃事件主叫号码为平台号码(bindNbr)。
语音通话平台呼叫B时的振铃事件主叫号码为用户A号码。
called
否
String(1-32)
被叫号码。
号码仅支持全局号码格式(包含国家码),比如+86138****7021。
注:语音回呼场景
语音通话平台呼叫A时的振铃事件被叫号码为A。
语音通话平台呼叫B时的振铃事件被叫号码为B。
接口示例
POST /status HTTP/1.1
Content-Length: xx
{"eventType":"alerting","statusInfo":{"sessionId":"1201_612_4294967295_20190124030424@callenabler245.huaweicaas.com","timestamp":"2019-01-24 03:04:26","caller":"+86138****0022","called":"+86138****0021"}}
表5answer:应答事件参数名称
是否必选
参数类型
说明
timestamp
是
String(1-128)
该呼叫事件发生时语音通话平台的UNIX时间戳。
该参数取值为UTC时间(+8小时为北京时间)格式,即为“yyyy-MM-dd HH:mm:ss”。
userData
否
String(1-256)
用户附属信息,此参数的值与“语音回呼场景API”中的"userData"参数值一致。
sessionId
是
String(1-256)
唯一指定一条通话链路的标识ID。
caller
否
String(1-32)
主叫号码。
号码仅支持全局号码格式(包含国家码),比如+86138****7021。
注:
语音回呼业务:
语音通话平台呼叫A时的应答事件主叫号码为SP设置的主叫端来电显示号码(displayNbr)。
语音通话平台呼叫B时的应答事件主叫号码为SP设置的被叫端来电显示号码(displayCalleeNbr)。
号显回呼业务:
语音通话平台呼叫A时的应答事件主叫号码为平台号码(bindNbr)。
语音通话平台呼叫B时的应答事件主叫号码为用户A号码。
called
否
String(1-32)
被叫号码。
号码仅支持全局号码格式(包含国家码),比如+86138****7021。
注:语音回呼场景
语音通话平台呼叫A时的应答事件被叫号码为A。
语音通话平台呼叫B时的应答事件被叫号码为B。
接口示例
POST /status HTTP/1.1
Content-Length: xx
{"eventType":"answer","statusInfo":{"sessionId":"1201_612_4294967295_20190124030424@callenabler245.huaweicaas.com","timestamp":"2019-01-24 03:04:31","caller":"+86138****0022","called":"+86138****0021"}}
表6disconnect:挂机事件参数名称
是否必选
参数类型
说明
timestamp
是
String(1-128)
该呼叫事件发生时语音通话业务平台的UNIX时间戳。
该参数取值为UTC时间(+8小时为北京时间)格式,即为“yyyy-MM-dd HH:mm:ss”。
userData
否
String(1-256)
用户附属信息,此参数的值与“语音回呼场景API”中的"userData"参数值一致。
sessionId
是
String(1-256)
唯一指定一条通话链路的标识ID。
caller
否
String(1-32)
主叫号码。
号码仅支持全局号码格式(包含国家码),比如+86138****7021。
注:
语音回呼业务:
若A先挂机,则挂机事件主叫号码为SP设置的主叫端来电显示号码(displayNbr);若B先挂机,则挂机事件主叫号码为SP设置的被叫端来电显示号码(displayCalleeNbr)。
号显回呼业务:
若A先挂机,则挂机事件主叫号码为平台号码(bindNbr);若B先挂机,则挂机事件主叫号码为用户A号码。
called
否
String(1-32)
被叫号码。
号码仅支持全局号码格式(包含国家码),比如+86138****7021。
注:
语音回呼场景,若A先挂机,则挂机事件被叫号码为A号码;若B先挂机,则挂机事件被叫号码为B号码。
partyType
否
String(枚举)
当通知类型“eventType”为“disconnect”且客户调用“语音回呼场景API”时将“partyTypeRequiredInDisconnect”参数设置为“true”时才会携带。
取值范围如下:
caller:主叫
callee:被叫
platform:平台
stateCode
否
Integer
通话挂机的原因值,仅当eventType为disconnect时携带。
取值范围及表示的含义请参考通话挂机原因值说明。
stateDesc
否
String(1-128)
通话挂机的原因值的描述,仅当eventType为disconnect时携带。
接口示例
POST /status HTTP/1.1
Content-Length: xx
{"eventType":"disconnect","statusInfo":{"sessionId":"1201_612_4294967295_20190124030424@callenabler245.huaweicaas.com","timestamp":"2019-01-24 03:04:49","caller":"+86138****0022","called":"+86138****0021","stateCode":0,"stateDesc":"The user releases the call."}}
这篇关于php语音回呼话单通知,语音回呼呼叫状态通知API的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!