隐私保护通话 PRIVATENUMBER-AXE模式呼叫事件通知接口:A回呼场景请求参数
下载隐私保护通话 PRIVATENUMBER用户手册完整版
A回呼场景请求参数
A回呼场景是指和隐私号码X绑定的号码A作为通话方中的主叫的场景，即A用户呼叫X，呼叫转接至最近一次通过X呼叫A的用户（如B）。若找不到对应回呼记录，则 隐私保护通话 平台根据绑定时的设置给A放指定音（callbackTone）后结束呼叫，或将呼叫转接至指定号码（callbackNum）。
注：以下流程以B用户接听为例，流程和接口示例仅供参考，请以实际消息为准。B号码是通过X号码呼叫过A的号码（存在回呼记录）或企业设置的指定转接号码（不存在回呼记录）。
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
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回呼场景，呼入事件的主叫号码为A号码。 |
|
called |
否 |
String(1-32) |
被叫号码。
说明：
A回呼场景，呼入事件的被叫号码为X号码。 |
|
userData |
否 |
String(1-256) |
用户附属信息。
说明：
使用该参数的场景请联系华为云客服获取。 |
接口示例
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":"1202_1051_4294967295_20190124070250@callenabler246.huaweicaas.com","timestamp":"2019-01-24 07:02:50","caller":"+86138****0021","called":"+86138****0022"}}
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
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回呼场景，呼出事件的主叫号码为X号码。 |
|
called |
否 |
String(1-32) |
被叫号码。
说明：
A回呼场景，呼出事件的被叫号码为B号码。 |
|
subscriptionId |
否 |
String(1-64) |
绑定ID。 |
|
userData |
否 |
String(1-256) |
用户附属信息。 当客户在AXE模式绑定接口中携带了“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":"1202_1051_4294967295_20190124070250@callenabler246.huaweicaas.com","timestamp":"2019-01-24 07:02:50","caller":"+86138****0022","called":"+86138****7021","subscriptionId":"********"}}
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
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回呼场景，振铃事件的主叫号码为X号码。 |
|
called |
否 |
String(1-32) |
被叫号码。
说明：
A回呼场景，振铃事件的被叫号码为B号码。 |
|
subscriptionId |
否 |
String(1-64) |
绑定ID。 |
|
userData |
否 |
String(1-256) |
用户附属信息。 当客户在AXE模式绑定接口中携带了“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":"alerting","statusInfo":{"sessionId":"1202_1051_4294967295_20190124070250@callenabler246.huaweicaas.com","timestamp":"2019-01-24 07:02:53","caller":"+86138****0022","called":"+86138****7021","subscriptionId":"********"}}
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
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回呼场景，应答事件的主叫号码为X号码。 |
|
called |
否 |
String(1-32) |
被叫号码。
说明：
A回呼场景，应答事件的被叫号码为B号码。 |
|
subscriptionId |
否 |
String(1-64) |
绑定ID。 |
|
userData |
否 |
String(1-256) |
用户附属信息。 当客户在AXE模式绑定接口中携带了“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":"answer","statusInfo":{"sessionId":"1202_1051_4294967295_20190124070250@callenabler246.huaweicaas.com","timestamp":"2019-01-24 07:03:03","caller":"+86138****0022","called":"+86138****7021","subscriptionId":"********"}}
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
timestamp |
是 |
String(1-128) |
该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。 |
|
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。 |
|
userData |
否 |
String(1-256) |
用户附属信息。 当客户在AXE模式绑定接口中携带了“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":"disconnect","statusInfo":{"sessionId":"1202_1051_4294967295_20190124070250@callenabler246.huaweicaas.com","timestamp":"2019-01-24 07:03:28","caller":"+86138****0022","called":"+86138****7021","stateCode":0,"stateDesc":"The user releases the call.","subscriptionId":"********"}}
