隐私保护通话 PrivateNumber隐私保护通话 PrivateNumber

文档首页> 隐私保护通话 PrivateNumber> API参考> AXE模式> AXE模式呼叫事件通知接口
更新时间:2021/09/14 GMT+08:00
分享

AXE模式呼叫事件通知接口

接口功能

隐私保护通话平台通过此接口向客户推送隐私保护通话用户呼叫时的状态信息,如呼入、呼出、振铃、应答、挂机等状态的信息。

请求方向

隐私保护通话平台(服务端) → 客户服务器(客户端)

使用说明

  • 前提条件

    客户添加应用时需设置呼叫状态接收地址,并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。

    如果需要单独接收呼入事件(callin),需联系客服,提供呼入事件状态接收地址。

  • 注意事项

    若平台给客户推送呼叫事件通知后未收到成功响应,视为推送失败,平台会重新推送呼叫事件通知,直至客户返回成功响应。平台最多重推6次,分别于1分钟、4分钟、9分钟、106分钟、203分钟和300分钟后重推。

  • 使用限制

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

接口类型

表1 接口类型说明

请求方法

POST

访问URI

客户添加应用时填写的呼叫状态接收地址

通信协议

HTTPS/HTTP

A被叫场景请求参数

A被叫场景是指和隐私号码X绑定的号码A作为通话方中的被叫的场景,即A以外的用户呼叫X后根据语音提示输入E,呼叫转接至A的场景。

注:以下流程和接口示例以A用户接听为例(B为A以外的其他用户),流程和接口示例仅供参考,请以实际消息为准。

图1 A被叫场景业务流程
表2 请求Body参数说明

参数名称

是否必选

参数类型

说明

eventType

String(枚举)

该参数标识通知的事件类型。

取值范围如下:

  • callin:呼入事件
  • collectInfo:放音收号结果事件
  • callout:呼出事件
  • alerting:振铃事件
  • answer:应答事件
  • disconnect:挂机事件

statusInfo

CallStatusInfo

呼叫状态事件的信息。

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

CallStatusInfo定义
表3 callin:呼入事件

参数名称

是否必选

参数类型

说明

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被叫场景,呼入事件的主叫号码为B号码。

called

String(1-32)

被叫号码。

注:A被叫场景,呼入事件的被叫号码为X号码。

接口示例

POST /status HTTP/1.1

content-length:xx
 

{"eventType":"callin","statusInfo":{"sessionId":"1201_11275_4294967295_20190124033310@callenabler246.huaweicaas.com","timestamp":"2019-01-24 03:33:10","caller":"+86138****7021","called":"+86138****0022"}}
表4 collectInfo:放音收号结果事件

参数名称

是否必选

参数类型

说明

timestamp

String(1-128)

该呼叫事件发生时隐私保护通话平台的UNIX时间戳。

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

sessionId

String(1-256)

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

digitInfo

String(1-64)

AXE场景中携带收号结果(即用户输入的数字)。

userData

String(1-256)

用户附属信息。

当客户在AXE模式绑定接口中携带了“userData”时,对应此呼叫事件的通知消息中都会携带此参数。

接口示例

POST /status HTTP/1.1

content-length:xx

{"eventType":"collectInfo","statusInfo":{"sessionId":"1201_11275_4294967295_20190124033310@callenabler246.huaweicaas.com","timestamp":"2019-01-24 03:33:16","digitInfo":"02"}}
表5 callout:呼出事件

参数名称

是否必选

参数类型

说明

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被叫场景,呼出事件的被叫号码为A号码。

subscriptionId

String(1-64)

绑定ID。

userData

String(1-256)

用户附属信息。

当客户在AXE模式绑定接口中携带了“userData”时,对应此呼叫事件的通知消息中都会携带此参数。

接口示例

POST /status HTTP/1.1

content-length:xx
 

{"eventType":"callout","statusInfo":{"sessionId":"1201_11275_4294967295_20190124033310@callenabler246.huaweicaas.com","timestamp":"2019-01-24 03:33:16","caller":"+86138****0022","called":"+86138****0021","subscriptionId":"********"}}
表6 alerting:振铃事件

参数名称

是否必选

参数类型

说明

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被叫场景,振铃事件的被叫号码为A号码。

subscriptionId

String(1-64)

绑定ID。

userData

String(1-256)

用户附属信息。

当客户在AXE模式绑定接口中携带了“userData”时,对应此呼叫事件的通知消息中都会携带此参数。

接口示例

POST /status HTTP/1.1

content-length:xx
 

{"eventType":"alerting","statusInfo":{"sessionId":"1201_11275_4294967295_20190124033310@callenabler246.huaweicaas.com","timestamp":"2019-01-24 03:33:16","caller":"+86138****0022","called":"+86138****0021","subscriptionId":"********"}}

表7 answer:应答事件

参数名称

是否必选

参数类型

说明

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被叫场景,应答事件的被叫号码为A号码。

subscriptionId

String(1-64)

绑定ID。

userData

String(1-256)

用户附属信息。

当客户在AXE模式绑定接口中携带了“userData”时,对应此呼叫事件的通知消息中都会携带此参数。

接口示例

POST /status HTTP/1.1

content-length:xx
 

{"eventType":"answer","statusInfo":{"sessionId":"1201_11275_4294967295_20190124033310@callenabler246.huaweicaas.com","timestamp":"2019-01-24 03:33:28","caller":"+86138****0022","called":"+86138****0021","subscriptionId":"********"}}
表8 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。

注:此处返回号码非真实主被叫号码,真实主被叫号码请以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-length:xx

{"eventType":"disconnect","statusInfo":{"sessionId":"1201_11275_4294967295_20190124033310@callenabler246.huaweicaas.com","timestamp":"2019-01-24 03:33:57","caller":"+86138****0022","called":"+86138****0021","stateCode":0,"stateDesc":"The user releases the call.","subscriptionId":"********"}

A回呼场景请求参数

A回呼场景是指和隐私号码X绑定的号码A作为通话方中的主叫的场景,即A用户呼叫X,呼叫转接至最近一次通过X呼叫A的用户(如B)。若找不到对应回呼记录,则隐私保护通话平台根据绑定时的设置给A放指定音(callbackTone)后结束呼叫,或将呼叫转接至指定号码(callbackNum)。

注:以下流程以B用户接听为例,流程和接口示例仅供参考,请以实际消息为准。B号码是通过X号码呼叫过A的号码(存在回呼记录)或企业设置的指定转接号码(不存在回呼记录)。

图2 A回呼场景业务流程
表9 请求Body参数说明

参数名称

是否必选

参数类型

说明

eventType

String(枚举)

该参数标识通知的事件类型。

取值范围如下:

  • callin:呼入事件
  • callout:呼出事件
  • alerting:振铃事件
  • answer:应答事件
  • disconnect:挂机事件

statusInfo

CallStatusInfo

呼叫状态事件的信息。

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

CallStatusInfo定义
表10 callin:呼入事件

参数名称

是否必选

参数类型

说明

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号码。

接口示例

POST /status HTTP/1.1

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"}}
表11 callout:呼出事件

参数名称

是否必选

参数类型

说明

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-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":"********"}}
表12 alerting:振铃事件

参数名称

是否必选

参数类型

说明

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-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":"********"}}
表13 answer:应答事件

参数名称

是否必选

参数类型

说明

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-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":"********"}}
表14 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。

注:此处返回号码非真实主被叫号码,真实主被叫号码请以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-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":"********"}}

响应参数

客户服务器接收到隐私保护通话平台的呼叫事件通知后,返回的响应消息。

接口示例

HTTP/1.1 200 OK 
分享:

    相关文档

    相关产品