语音通话 VoiceCall-语音验证码呼叫状态通知API:请求参数
下载语音通话 VoiceCall用户手册完整版
请求参数
SP调用语音验证码API，语音通话平台发起呼叫，给用户播放语音验证码。
注：以下流程以语音通话平台呼叫A，给A播放语音验证码为例。流程和接口示例仅供参考，请以实际消息为准。
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
Content-Type |
是 |
String |
固定填写为application/json;charset=UTF-8。 |
Authorization |
是 |
String |
固定填写为AKSK realm="SDP",profile="UsernameToken",type="Appkey"。 |
X-AKSK |
是 |
String |
取值为UsernameToken Username="APP_Key的值", PasswordDigest="PasswordDigest的值", Nonce="随机数", Created="随机数生成时间"。
|
编程语言 |
时间格式 |
|---|---|
Java |
yyyy-MM-dd'T'HH:mm:ss'Z' |
PHP |
Y-m-d\TH:i:s\Z |
Python |
%Y-%m-%dT%H:%M:%SZ |
C# |
yyyy-MM-ddTHH:mm:ssZ |
Node.js |
toISOString().replace(/.[0-9]+\Z/, 'Z') 注：Node.js中，使用toISOString()转换后的时间格式去除毫秒后即为本接口要求的时间格式。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
eventType |
是 |
String(枚举) |
该参数标识API事件通知的类型。取值范围如下： |
statusInfo |
否 |
CallStatusInfo |
呼叫状态事件的信息。 当eventType参数为callout、alerting、answer、disconnect时携带。 |
CallStatusInfo
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
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。 注：呼出事件的主叫号码为SP设置的来电显示号码（displayNbr）。 |
called |
否 |
String(1-32) |
被叫号码。 号码仅支持全局号码格式（包含国家码），比如+86138****7021。 注：呼出事件的被叫号码为A号码。 |
接口示例
POST /status HTTP/1.1Content-Length: xx {"eventType":"callout","statusInfo":{"sessionId":"1202_14260_4294967295_20190124024846@callenabler245.huaweicaas.com","timestamp":"2019-01-24 02:48:46","caller":"+86138****0022","called":"+86138****0021"}}
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
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。 注：振铃事件的主叫号码为SP设置的来电显示号码（displayNbr）。 |
called |
否 |
String(1-32) |
被叫号码。 号码仅支持全局号码格式（包含国家码），比如+86138****7021。 注：振铃事件的被叫号码为A号码。 |
接口示例
POST /status HTTP/1.1Content-Length: xx {"eventType":"alerting","statusInfo":{"sessionId":"1202_14260_4294967295_20190124024846@callenabler245.huaweicaas.com","timestamp":"2019-01-24 02:48:47","caller":"+86138****0022","called":"+86138****0021"}}
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
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。 注：应答事件的主叫号码为SP设置的来电显示号码（displayNbr）。 |
called |
否 |
String(1-32) |
被叫号码。 号码仅支持全局号码格式（包含国家码），比如+86138****7021。 注：应答事件的被叫号码为A号码。 |
接口示例
POST /status HTTP/1.1Content-Length: xx {"eventType":"answer","statusInfo":{"sessionId":"1202_14260_4294967295_20190124024846@callenabler245.huaweicaas.com","timestamp":"2019-01-24 02:49:12","caller":"+86138****0022","called":"+86138****0021"}}
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
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。 注：挂机事件的主叫号码为SP设置的来电显示号码（displayNbr）。 |
called |
否 |
String(1-32) |
被叫号码。 号码仅支持全局号码格式（包含国家码），比如+86138****7021。 注：挂机事件的被叫号码为A号码。 |
stateCode |
否 |
Integer |
通话挂机的原因值，仅当eventType为disconnect时携带。 取值范围及表示的含义请参考通话挂机原因值说明。 |
stateDesc |
否 |
String(1-128) |
通话挂机的原因值的描述，仅当eventType为disconnect时携带。 |
接口示例
POST /status HTTP/1.1Content-Length: xx {"eventType":"disconnect","statusInfo":{"sessionId":"1202_14260_4294967295_20190124024846@callenabler245.huaweicaas.com","timestamp":"2019-01-24 02:49:23","caller":"+86138****0022","called":"+86138****0021","stateCode":0,"stateDesc":"The user releases the call."}}
