隐私保护通话 PRIVATENUMBER-X模式呼叫事件通知接口:请求参数
请求参数
X模式中,任意用户呼叫隐私号码X, 隐私保护通话 平台接收到呼叫后,根据客户服务器返回的绑定关系转接或挂断呼叫。
注:以下流程和接口示例以A用户呼叫X,企业服务器返回被叫号码B,B用户接听为例,流程和接口示例仅供参考,请以实际消息为准。
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
Content-Type |
是 |
String |
固定填写为application/json;charset=UTF-8。 |
Authorization |
是 |
String |
固定填写为WSSE realm="SDP",profile="UsernameToken",type="Appkey"。 |
X-WSSE |
是 |
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(枚举) |
该参数标识通知的事件类型。 取值范围如下:
|
statusInfo |
否 |
CallStatusInfo |
呼叫状态事件的信息。 当eventType参数为callin、callout、alerting、answer、disconnect时携带。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
timestamp |
是 |
String(1-128) |
该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间(+8小时为北京时间)格式,即为“yyyy-MM-dd HH:mm:ss”。 |
sessionId |
是 |
String(1-256) |
唯一指定一条通话链路的标识ID。 |
caller |
否 |
String(1-32) |
主叫号码。 号码为全局号码格式(包含国家码),如+86138****0021。
说明:
呼入事件的主叫号码为A号码。 |
called |
否 |
String(1-32) |
被叫号码。
说明:
呼入事件的被叫号码为X号码。 |
notifyMode |
否 |
String(1-32) |
通知模式,仅X模式场景携带。 取值范围如下:
不携带该参数时,通知模式为Notify。 |
接口示例
POST /status HTTP/1.1 content-type: application/json;charset=UTF-8 authorization: WSSE realm="SDP",profile="UsernameToken",type="Appkey" x-wsse: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z" content-length:xx {"eventType":"callin","statusInfo":{"sessionId":"1201_7767_4294967295_20190103031118@callenabler246.huaweicaas.com","timestamp":"2019-01-03 03:11:18","caller":"+86138****0021","called":"+86138****0022","notifyMode":"Block"}}
注:客户若收到Block模式的事件通知,需按照接口说明返回响应参数,指示对呼叫事件的处理操作(接口说明见Block模式)。此处以客户服务器回复接续被叫号码B为例。
HTTP/1.1 200 Content-Length: xx {"connectInfo":{"lastMinVoice":"lastMinVoice001.wav","userData":"d77b5e3cbd234159af401d63f559f896","displayCalleeNum":"+86138****0022","recordFlag":true,"calleeNum":"+86138****7021","maxDuration":0,"recordHintTone":"recordHintTone001.wav","waitVoice":"waitVoice001.wav"},"operation":"connect","userData":"d77b5e3cbd234159af401d63f559f896"}
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
timestamp |
是 |
String(1-128) |
该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间(+8小时为北京时间)格式,即为“yyyy-MM-dd HH:mm:ss”。 |
sessionId |
是 |
String(1-256) |
唯一指定一条通话链路的标识ID。 |
caller |
否 |
String(1-32) |
主叫号码。 号码为全局号码格式(包含国家码),如+86138****0021。
说明:
呼出事件的主叫号码为X号码。 |
called |
否 |
String(1-32) |
被叫号码。
说明:
呼出事件的被叫号码为B号码。 |
subscriptionId |
否 |
String(1-64) |
绑定ID。 |
userData |
否 |
String(1-256) |
用户附属信息。 当客户在该接口Block模式响应参数中携带了“userData”时,对应呼叫后续的通知消息中都会携带此参数。 |
接口示例
POST /status HTTP/1.1 content-type: application/json;charset=UTF-8 authorization: WSSE realm="SDP",profile="UsernameToken",type="Appkey" x-wsse: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z" content-length:xx {"eventType":"callout","statusInfo":{"sessionId":"1201_7767_4294967295_20190103031118@callenabler246.huaweicaas.com","timestamp":"2019-01-03 03:11:20","caller":"+86138****0022","called":"+86138****7021","userData":"d77b5e3cbd234159af401d63f559f896","subscriptionId":"********"}}
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
timestamp |
是 |
String(1-128) |
该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间(+8小时为北京时间)格式,即为“yyyy-MM-dd HH:mm:ss”。 |
userData |
否 |
String(1-256) |
用户附属信息。 当客户在该接口Block模式响应参数中携带了“userData”时,对应呼叫后续的通知消息中都会携带此参数。 |
sessionId |
是 |
String(1-256) |
唯一指定一条通话链路的标识ID。 |
caller |
否 |
String(1-32) |
主叫号码。 号码为全局号码格式(包含国家码),如+86138****0021。
说明:
振铃事件的主叫号码为X号码。 |
called |
否 |
String(1-32) |
被叫号码。
说明:
振铃事件的被叫号码为B号码。 |
subscriptionId |
否 |
String(1-64) |
绑定ID。 |
接口示例
POST /status HTTP/1.1 content-type: application/json;charset=UTF-8 authorization: WSSE realm="SDP",profile="UsernameToken",type="Appkey" x-wsse: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z" content-length:xx {"eventType":"alerting","statusInfo":{"sessionId":"1201_7767_4294967295_20190103031118@callenabler246.huaweicaas.com","timestamp":"2019-01-03 03:11:21","caller":"+86138****0022","called":"+86138****7021","userData":"d77b5e3cbd234159af401d63f559f896","subscriptionId":"********"}}
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
timestamp |
是 |
String(1-128) |
该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间(+8小时为北京时间)格式,即为“yyyy-MM-dd HH:mm:ss”。 |
userData |
否 |
String(1-256) |
用户附属信息。 当客户在该接口Block模式响应参数中携带了“userData”时,对应呼叫后续的通知消息中都会携带此参数。 |
sessionId |
是 |
String(1-256) |
唯一指定一条通话链路的标识ID。 |
caller |
否 |
String(1-32) |
主叫号码。 号码为全局号码格式(包含国家码),如+86138****0021。
说明:
应答事件的主叫号码为X号码。 |
called |
否 |
String(1-32) |
被叫号码。
说明:
应答事件的被叫号码为B号码。 |
subscriptionId |
否 |
String(1-64) |
绑定ID。 |
接口示例
POST /status HTTP/1.1 content-type: application/json;charset=UTF-8 authorization: WSSE realm="SDP",profile="UsernameToken",type="Appkey" x-wsse: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z" content-length:xx {"eventType":"answer","statusInfo":{"sessionId":"1201_7767_4294967295_20190103031118@callenabler246.huaweicaas.com","timestamp":"2019-01-03 03:11:22","caller":"+86138****0022","called":"+86138****7021","userData":"d77b5e3cbd234159af401d63f559f896","subscriptionId":"********"}}
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
timestamp |
是 |
String(1-128) |
该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间(+8小时为北京时间)格式,即为“yyyy-MM-dd HH:mm:ss”。 |
userData |
否 |
String(1-256) |
用户附属信息。 当客户在该接口Block模式响应参数中携带了“userData”时,对应呼叫后续的通知消息中都会携带此参数。 |
sessionId |
是 |
String(1-256) |
唯一指定一条通话链路的标识ID。 |
caller |
否 |
String(1-32) |
主叫号码。 号码为全局号码格式(包含国家码),如+86138****0021。
说明:
此处返回号码非真实主被叫号码,真实主被叫号码请以fee事件中的返回值为准。 |
called |
否 |
String(1-32) |
被叫号码。
说明:
此处返回号码非真实主被叫号码,真实主被叫号码请以fee事件中的返回值为准。 |
stateCode |
否 |
Integer |
通话挂机的原因值,仅当eventType为disconnect时携带。 取值范围及表示的含义请参考通话挂机原因值说明。 |
stateDesc |
否 |
String(1-128) |
通话挂机的原因值的描述,仅当eventType为disconnect时携带。 |
subscriptionId |
否 |
String(1-64) |
绑定ID。 |
callRelDirection |
否 |
Integer |
主被叫通话结束后的挂机方向。
说明:
使用该参数的场景请联系华为云客服获取。 |
接口示例
POST /status HTTP/1.1 content-type: application/json;charset=UTF-8 authorization: WSSE realm="SDP",profile="UsernameToken",type="Appkey" x-wsse: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z" content-length:xx {"eventType":"disconnect","statusInfo":{"sessionId":"1201_7767_4294967295_20190103031118@callenabler246.huaweicaas.com","timestamp":"2019-01-03 03:11:42","caller":"+86138****0022","called":"+86138****7021","userData":"d77b5e3cbd234159af401d63f559f896","stateCode":0,"stateDesc":"The user releases the call.","subscriptionId":"********"}}