文档首页 > > API参考> AXE模式> AXE模式话单通知接口

AXE模式话单通知接口

分享
更新时间: 2019/12/06 GMT+08:00

接口功能

用户通话结束后,隐私保护通话平台通过此接口向客户推送通话的话单信息。短时间内有多个通话结束时隐私保护通话平台会将话单合并推送,每条消息最多携带50个话单。

请求方向

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

使用说明

  • 前提条件

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

  • 注意事项

    若平台给客户推送话单后未收到成功响应,视为推送失败,平台会重新推送话单,直至客户返回成功响应。平台最多重推6次,每次时间间隔1小时。若6次重推后仍然推送失败,后台会生成话单文件,请联系管理员手动给您推送。

  • 使用限制

    业务平台推送话单信息给开发者应用,仅支持POST方式。

接口类型

表1 接口类型说明

请求方法

POST

访问URI

客户应用设置的呼叫话单接收地址

通信协议

HTTPS/HTTP

A被叫场景请求参数

表2 请求Body参数说明

参数名称

是否必选

参数类型

说明

eventType

String(枚举)

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

取值范围如下:

fee:话单事件

feeLst

FeeInfo[1-50]

呼叫话单事件的信息,参数取值为列表,最大50条。

当eventType参数为fee时携带。

FeeInfo定义
表3 fee:话单事件

参数名称

是否必须

参数类型

描述

direction

Integer (0-1)

通话的呼叫方向。

  • 0:其他用户呼叫A。
  • 2:异常场景(如无绑定数据等)。

spId

String(1-32)

客户的云服务账号。

appKey

String(1-128)

隐私保护通话应用的app_key。

icid

String(1-64)

呼叫记录的唯一标识。

bindNum

String(1-32)

隐私保护号码,号码为全局号码格式(包含国家码),比如+8613800000021。

sessionId

String(1-256)

通话链路的唯一标识。

callerNum

String(1-32)

主叫号码,号码为全局号码格式(包含国家码),比如+8613800000021。

当呼叫场景经过转接时,此参数对应第一路呼叫的主显号码。

注:A被叫场景,第一路呼叫为B拨打X号码,callerNum为B号码。

calleeNum

String(1-32)

被叫号码,号码为全局号码格式(包含国家码),比如+8613800000021。

当呼叫场景经过转接时,此参数对应第一路呼叫的被叫号码。

注:A被叫场景,第一路呼叫为B拨打X号码,calleeNum为X号码。

fwdDisplayNum

String(1-32)

转接呼叫时的显示号,号码为全局号码格式(包含国家码),比如+8613800000021。

当呼叫场景经过转接时,此参数对应第二路呼叫的主显号码。

注:A被叫场景,第二路呼叫为X拨打A号码,fwdDisplayNum为X号码。

fwdDstNum

String(1-32)

转接呼叫时的转接号码。号码仅支持全局号码格式(包含国家码),比如+8613800000021。

当呼叫场景经过转接时,此参数对应第二路呼叫的被叫号码。

注:A被叫场景,第二路呼叫为X拨打A号码,fwdDstNum为A号码。

callInTime

String(1-128)

呼入的开始时间。

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

fwdStartTime

String(1-128)

转接呼叫操作的开始时间。

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

fwdAlertingTime

String(1-128)

转接呼叫操作后的振铃时间。

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

fwdAnswerTime

String(1-128)

转接呼叫操作后的应答时间。

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

callEndTime

String(1-128)

呼叫结束时间。

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

fwdUnaswRsn

Integer

转接呼叫操作失败的Q850原因值。详细说明参见Q850原因值说明

failTime

String(1-128)

呼入、呼出的失败时间。

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

ulFailReason

Integer

通话失败的拆线点。详细说明参见呼叫拆线点说明

sipStatusCode

Integer

呼入、呼出的失败SIP状态码。

recordFlag

Integer (0-1)

该字段用于录音标识,参数值范围如:

  • 0:表示未录音
  • 1:表示有录音

recordStartTime

String(1-128)

录音开始时间,时间格式为“yyyy-MM-dd HH:mm:ss”。

recordObjectName

String(0-128)

录音文件名。

recordBucketName

String(0-128)

录音文件名所在的目录名。

recordDomain

String(0-256)

存放录音文件的域名。

serviceType

String(1-32)

携带呼叫的业务类型信息,取值范围:

005:AXE模式

hostName

String(1-128)

该参数用于标识话单生成的服务器设备对应的主机名。

subscriptionId

String(1-64)

绑定ID。

extendNumber

String(1-4)

分机号E,该参数仅在AXE模式场景携带。

callOutUnaswRsn

Integer

Initcall的呼出失败的Q850原因值。

详细说明参见Q850原因值说明

注:预留参数,无需关注。

ttsPlayTimes

integer

应用TTS功能时,使用TTS的总次数。

注:预留参数,无需关注。

ttsTransDuration

integer

应用TTS功能时,TTS Server进行TTS转换的总时长。单位为秒。

注:预留参数,无需关注。

mptyId

String(1-128)

该参数作为预留字段,用于标识Enabler服务器上一条多方通话的链路。

该参数仅在多方通话场景生效。

注:预留参数,无需关注。

voiceCheckType

Integer(枚举)

录音质检类型,取值如下:

  • Null:无质检
  • 0:无录音质检,表示API指示不录音(即recordFlag取值为false)时进行的质检
  • 1:有录音质检,表示API指示要录音(即recordFlag取值为true)时进行的质检

userData

String(1-256)

用户附属信息。

当客户在AXE模式绑定接口中携带了"userData"时,对应的话单通知消息中会携带此参数。

接口示例

POST /fee HTTP/1.1

Content-Length: xx 

{"eventType":"fee","feeLst":[{"direction":0,"spId":"linlingoo_omp","appKey":"4jynnA8Mi6trQuij21t67H3sv9Br","icid":"ba171f34e6953fcd751edc77127748f4.3757289590.338833305.5","bindNum":"+8613800000022","sessionId":"1201_11275_4294967295_20190124033310@callenabler246.huaweicaas.com","subscriptionId":"8e6a3881-ee87-4b0a-a07e-d491135025f8","callerNum":"+8613866887021","calleeNum":"+8613800000022","fwdDisplayNum":"+8613800000022","fwdDstNum":"+8613800000021","callInTime":"2019-01-24 03:33:10","fwdStartTime":"2019-01-24 03:33:16","fwdAlertingTime":"2019-01-24 03:33:19","fwdAnswerTime":"2019-01-24 03:33:28","callEndTime":"2019-01-24 03:33:57","fwdUnaswRsn":0,"ulFailReason":0,"sipStatusCode":0,"callOutUnaswRsn":0,"recordFlag":1,"recordStartTime":"2019-01-24 03:33:28","recordDomain":"ostor.huawei.com","recordBucketName":"sp-4jynna8mi6trquij21t67h3sv9br","recordObjectName":"19012403332812039369251.wav","ttsPlayTimes":0,"ttsTransDuration":0,"mptyId":"8e6a3881-ee87-4b0a-a07e-d491135025f8","serviceType":"005","hostName":"callenabler246.huaweicaas.com","extendNumber":"02"}]}

A回呼场景请求参数

表4 请求Body参数说明

参数名称

是否必选

参数类型

说明

eventType

String(枚举)

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

取值范围如下:

fee:话单事件

feeLst

FeeInfo[1-50]

呼叫话单事件的信息,参数取值为列表,最大50条。

当eventType参数为fee时携带。

FeeInfo定义
表5 fee:话单事件

参数名称

是否必须

参数类型

描述

direction

Integer (0-1)

通话的呼叫方向。

  • 1:A呼叫其他用户。
  • 2:异常场景(如无绑定数据等)。

spId

String(1-32)

客户的云服务账号。

appKey

String(1-128)

隐私保护通话应用的app_key。

icid

String(1-64)

呼叫记录的唯一标识。

bindNum

String(1-32)

隐私保护号码,号码为全局号码格式(包含国家码),比如+8613800000021。

sessionId

String(1-256)

通话链路的唯一标识。

callerNum

String(1-32)

主叫号码,号码为全局号码格式(包含国家码),比如+8613800000021。

当呼叫场景经过转接时,此参数对应第一路呼叫的主显号码。

注:A回呼场景,第一路呼叫为A呼叫X号码,callerNum为A号码。

calleeNum

String(1-32)

被叫号码,号码为全局号码格式(包含国家码),比如+8613800000021。

当呼叫场景经过转接时,此参数对应第一路呼叫的被叫号码。

注:A回呼场景,第一路呼叫为A呼叫X号码,calleeNum为X号码。

fwdDisplayNum

String(1-32)

转接呼叫时的显示号,号码为全局号码格式(包含国家码),比如+8613800000021。

当呼叫场景经过转接时,此参数对应第二路呼叫的主显号码。

注:A回呼场景,第二路呼叫为X呼叫B号码,fwdDisplayNum为X号码。

fwdDstNum

String(1-32)

转接呼叫时的转接号码。号码仅支持全局号码格式(包含国家码),比如+8613800000021。

当呼叫场景经过转接时,此参数对应第二路呼叫的被叫号码。

注:A回呼场景,第二路呼叫为X呼叫B号码,fwdDstNum为B号码。

callInTime

String(1-128)

呼入的开始时间。

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

fwdStartTime

String(1-128)

转接呼叫操作的开始时间。

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

fwdAlertingTime

String(1-128)

转接呼叫操作后的振铃时间。

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

fwdAnswerTime

String(1-128)

转接呼叫操作后的应答时间。

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

callEndTime

String(1-128)

呼叫结束时间。

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

fwdUnaswRsn

Integer

转接呼叫操作失败的Q850原因值。详细说明参见Q850原因值说明

failTime

String(1-128)

呼入、呼出的失败时间。

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

ulFailReason

Integer

通话失败的拆线点。详细说明参见呼叫拆线点说明

sipStatusCode

Integer

呼入、呼出的失败SIP状态码。

recordFlag

Integer (0-1)

该字段用于录音标识,参数值范围如:

  • 0:表示未录音
  • 1:表示有录音

recordStartTime

String(1-128)

录音开始时间,时间格式为“yyyy-MM-dd HH:mm:ss”。

recordObjectName

String(0-128)

录音文件名。

recordBucketName

String(0-128)

录音文件名所在的目录名。

recordDomain

String(0-256)

存放录音文件的域名。

serviceType

String(1-32)

携带呼叫的业务类型信息,取值范围:

005:AXE模式

hostName

String(1-128)

该参数用于标识话单生成的服务器设备对应的主机名。

subscriptionId

String(1-64)

绑定ID。

callOutUnaswRsn

Integer

Initcall的呼出失败的Q850原因值。

详细说明参见Q850原因值说明

注:预留参数,无需关注。

ttsPlayTimes

integer

应用TTS功能时,使用TTS的总次数。

注:预留参数,无需关注。

ttsTransDuration

integer

应用TTS功能时,TTS Server进行TTS转换的总时长。单位为秒。

注:预留参数,无需关注。

mptyId

String(1-128)

该参数作为预留字段,用于标识Enabler服务器上一条多方通话的链路。

该参数仅在多方通话场景生效。

注:预留参数,无需关注。

接口示例

POST /fee HTTP/1.1

Content-Length: xx 

{"eventType":"fee","feeLst":[{"direction":1,"spId":"linlingoo_omp","appKey":"4jynnA8Mi6trQuij21t67H3sv9Br","icid":"ba171f34e6953fcd751edc77127748f4.3757302170.339445906.1","bindNum":"+8613800000022","sessionId":"1202_1051_4294967295_20190124070250@callenabler246.huaweicaas.com","subscriptionId":"8e6a3881-ee87-4b0a-a07e-d491135025f8","callerNum":"+8613800000021","calleeNum":"+8613800000022","fwdDisplayNum":"+8613800000022","fwdDstNum":"+8613866887021","callInTime":"2019-01-24 07:02:50","fwdStartTime":"2019-01-24 07:02:50","fwdAlertingTime":"2019-01-24 07:02:53","fwdAnswerTime":"2019-01-24 07:03:03","callEndTime":"2019-01-24 07:03:28","fwdUnaswRsn":0,"ulFailReason":0,"sipStatusCode":0,"callOutUnaswRsn":0,"recordFlag":1,"recordStartTime":"2019-01-24 07:03:03","recordDomain":"ostor.huawei.com","recordBucketName":"sp-4jynna8mi6trquij21t67h3sv9br","recordObjectName":"19012407030312039967859.wav","ttsPlayTimes":0,"ttsTransDuration":0,"mptyId":"8e6a3881-ee87-4b0a-a07e-d491135025f8","serviceType":"005","hostName":"callenabler246.huaweicaas.com"}]}

响应参数

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

接口示例

HTTP/1.1 200 OK 
分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区