隐私保护通话 PRIVATENUMBER-AXYB模式话单通知接口:请求参数
下载隐私保护通话 PRIVATENUMBER用户手册完整版
请求参数
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
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(枚举) |
该参数标识通知的事件类型。 取值范围如下： fee：话单事件 |
|
feeLst |
否 |
FeeInfo[1-50] |
呼叫话单事件的信息，参数取值为列表，最大50条。 当eventType参数为fee时携带。 |
|
参数名称 |
是否必须 |
参数类型 |
描述 |
|---|---|---|---|
|
direction |
是 |
Integer (0-1) |
通话的呼叫方向。
|
|
spId |
是 |
String(1-32) |
客户的云服务账号。 |
|
appKey |
是 |
String(1-128) |
隐私保护通话 应用的app_key。 |
|
icid |
否 |
String(1-64) |
呼叫记录的唯一标识。 |
|
bindNum |
是 |
String(1-32) |
隐私保护号码，号码为全局号码格式（包含国家码），比如+86138****0021。 |
|
sessionId |
是 |
String(1-256) |
通话链路的唯一标识。 |
|
callerNum |
是 |
String(1-32) |
主叫号码，号码为全局号码格式（包含国家码），比如+86138****0021。 当呼叫场景经过转接时，此参数对应第一路呼叫的主叫号码。
说明：
第一路呼叫为B拨打X号码，callerNum为B号码。 |
|
calleeNum |
是 |
String(1-128) |
被叫号码，号码为全局号码格式（包含国家码），比如+86138****0021。 当呼叫场景经过转接时，此参数对应第一路呼叫的被叫号码。
说明：
第一路呼叫为B拨打X号码，calleeNum为X号码。 |
|
fwdDisplayNum |
否 |
String(1-32) |
转接呼叫时的显示号，号码为全局号码格式（包含国家码），比如+86138****0021。 当呼叫场景经过转接时，此参数对应第二路呼叫的主显号码。
说明：
第二路呼叫为Y拨打A号码，fwdDisplayNum为Y号码。 |
|
fwdDstNum |
否 |
String(1-32) |
转接呼叫时的转接号码。号码仅支持全局号码格式（包含国家码），比如+86138****0021。 当呼叫场景经过转接时，此参数对应第二路呼叫的被叫号码。
说明：
第二路呼叫为Y拨打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) |
该字段用于录音标识，参数值范围如：
|
|
recordStartTime |
否 |
String(1-128) |
录音开始时间。 该参数为UTC时间（+8小时为北京时间），时间格式为“yyyy-MM-dd HH:mm:ss”。 |
|
recordObjectName |
否 |
String(1-128) |
录音文件名。
说明：
参数值为空时，请访问“recordFileDownloadUrl”参数携带的录音文件下载地址下载录音文件。 |
|
recordBucketName |
否 |
String(1-128) |
录音文件名所在的目录名。
说明：
参数值为空时，请访问“recordFileDownloadUrl”参数携带的录音文件下载地址下载录音文件。 |
|
recordDomain |
否 |
String(1-256) |
存放录音文件的 域名 。
说明：
参数值为空时，请访问“recordFileDownloadUrl”参数携带的录音文件下载地址下载录音文件。 |
|
serviceType |
否 |
String(1-32) |
携带呼叫的业务类型信息，取值范围： 007：AXYB模式 |
|
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服务器上一条多方通话的链路。 该参数仅在多方通话场景生效。
说明：
预留参数，无需关注。 |
|
voiceCheckType |
否 |
Integer（枚举） |
录音质检类型，取值如下：
|
|
recordFileDownloadUrl |
否 |
String(1-1024) |
录音文件下载地址，可通过该URL在浏览器中下载录音文件。
说明：
使用该参数的场景请联系华为云客服获取。 |
|
areaCode |
否 |
String(0-32) |
隐私保护号码（X号码）的城市码。
说明：
使用该参数的场景请联系华为云客服获取。 |
|
callDuration |
否 |
Integer |
呼叫的通话时长，单位为秒。
说明：
使用该参数的场景请联系华为云客服获取。 |
|
userData |
否 |
String(1-256) |
用户自定义数据。 若客户在调用AXYB模式绑定接口时携带了“userData”，对应此呼叫事件的通知消息中都会携带此参数。 |
接口示例
POST /fee 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":"fee","feeLst":[{"direction":1,"spId":"****","appKey":"********","icid":"ba171f34e6953fcd751edc77127748f4.3757223714.337238282.9","bindNum":"+86138****0022","sessionId":"1200_1029_4294967295_20190123091514@callenabler246.huaweicaas.com","subscriptionId":"****","callerNum":"+86138****0021","calleeNum":"+86138****0022","fwdDisplayNum":"+86138****0023","fwdDstNum":"+86138****7021","callInTime":"2019-01-23 09:15:14","fwdStartTime":"2019-01-23 09:15:15","fwdAlertingTime":"2019-01-23 09:15:21","fwdAnswerTime":"2019-01-23 09:15:36","callEndTime":"2019-01-23 09:16:41","fwdUnaswRsn":0,"ulFailReason":0,"sipStatusCode":0,"callOutUnaswRsn":0,"recordFlag":1,"recordStartTime":"2019-01-23 09:15:37","recordDomain":"****.com","recordBucketName":"sp-********","recordObjectName":"********.wav","ttsPlayTimes":0,"ttsTransDuration":0,"mptyId":"****","serviceType":"007","hostName":"callenabler246.huaweicaas.com"}]}
