文档首页 > > API参考> X模式>

X模式话单通知接口

X模式话单通知接口

分享
更新时间:2021/01/21 GMT+08:00

接口功能

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

请求方向

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

使用说明

  • 前提条件

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

  • 注意事项

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

  • 使用限制

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

接口类型

表1 接口类型说明

请求方法

POST

访问URI

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

通信协议

HTTPS/HTTP

请求参数

表2 请求Headers参数说明

参数名称

是否必选

参数类型

说明

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="随机数生成时间"。
  • PasswordDigest:根据PasswordDigest = Base64 (SHA256 (Nonce + Created + Password))生成。其中,Password为APP_Secret的值。Nonce、Created、Password直接进行字符串拼接即可,无需包含+号和空格。
  • Nonce:客户发送请求时生成的一个随机数,长度为1~128位,可包含数字和大小写字母。例如:66C92B11FF8A425FB8D4CCFE0ED9ED1F。
  • Created:随机数生成时间。采用标准UTC格式,例如:2018-02-12T15:30:20Z。不同编程语言中将UTC时间戳转换为普通时间时使用的格式不同,部分语言可参考表3
表3 不同编程语言的时间格式

编程语言

时间格式

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()转换后的时间格式去除毫秒后即为本接口要求的时间格式。

表4 请求Body参数说明

参数名称

是否必选

参数类型

说明

eventType

String(枚举)

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

取值范围如下:

fee:话单事件

feeLst

FeeInfo[1-50]

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

当eventType参数为fee时携带。

表5 FeeInfo定义

参数名称

是否必须

参数类型

描述

direction

Integer (0-1)

通话的呼叫方向。

固定取值为1。

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拨打X号码,callerNum为A号码。

calleeNum

String(1-128)

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

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

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

fwdDisplayNum

String(1-32)

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

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

注:第二路呼叫为X拨打B号码,fwdDisplayNum为X号码。

fwdDstNum

String(1-32)

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

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

注:第二路呼叫为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(1-128)

录音文件名。

recordBucketName

String(1-128)

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

recordDomain

String(1-256)

存放录音文件的域名。

serviceType

String(1-32)

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

004:AXB模式或X模式

hostName

String(1-128)

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

userData

String(0-256)

用户附属信息。

当客户在该接口Block模式响应参数中携带了"userData"时,话单通知消息中会携带此参数。

subscriptionId

String(1-64)

绑定ID。

notifyMode

String(1-32)

该参数仅在X模式场景携带,固定取值为Block,用于标识该话单为X模式话单。

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)时进行的质检

接口示例

POST /fee HTTP/1.1




content-length:xx

{"eventType":"fee","feeLst":[{"direction":1,"spId":"dial111516195242","appKey":"i73zYG7Ruz9fUd038bPcILE8ffYe","icid":"e01ed0af24040eab7ba27a1c441f91641.3663053204.1117803.14","bindNum":"+8613800000022","sessionId":"1200_366_0_20161228102743@callenabler.home1.com","subscriptionId":"1542269981150eca0bd38d3f745789e754e25dc919925","callerNum":"+8613800000021","calleeNum":"+8613800000022","fwdDisplayNum":"+8613800000022","fwdDstNum":"+8613866887021","callInTime":"2019-01-03 03:11:18","fwdStartTime":"2019-01-03 03:11:20","fwdAlertingTime":"2019-01-03 03:11:21","fwdAnswerTime":"2019-01-03 03:11:22","callEndTime":"2019-01-03 03:11:42","fwdUnaswRsn":0,"ulFailReason":0,"sipStatusCode":0,"callOutUnaswRsn":0,"recordFlag":1,"recordStartTime":"2019-01-03 03:11:22","recordDomain":"ostor.huawei.com","recordBucketName":"sp-4jynna8mi6trquij21t67h3sv9br","recordObjectName":"19012407030312039967859.wav","ttsPlayTimes":0,"ttsTransDuration":0,"mptyId":"8e6a3881-ee87-4b0a-a07e-d491135025f8","serviceType":"004","hostName":"callenabler246.huaweicaas.com","userData":"d77b5e3cbd234159af401d63f559f896","notifyMode":"Block"}]}

响应参数

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

接口示例

HTTP/1.1 200 OK 
分享:

    相关文档

    相关产品

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

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

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

字符长度不能超过200

提交反馈 取消

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

智能客服提问云社区提问