注意事项
4 X 模式
4.3 X 模式话单通知接口
接口功能
用户通话结束后，隐私保护通话平台通过此接口向客户推送通话的话单信息。短时间 内有多个通话结束时隐私保护通话平台会将话单合并推送，每条消息最多携带50个话 单。
请求方向
隐私保护通话平台（服务端） → 客户服务器（客户端）
使用说明
● 前提条件
客户添加应用时需设置呼叫话单接收地址，并确保提供的地址能够正常处理隐私 保护通话平台发送的通知消息。
● 注意事项
若平台给客户推送话单后未收到成功响应，视为推送失败，平台会重新推送话 单，直至客户返回成功响应。平台最多重推6次，分别于1分钟、4分钟、9分钟、
106分钟、203分钟和300分钟后重推。
● 使用限制
业务平台推送话单信息给开发者应用，仅支持POST方式。
接口类型
表4-13 接口类型说明 请求方法 POST
访问URI 客户添加应用时填写的呼叫话单接收地址 通信协议 HTTPS/HTTP
请求参数
表4-14 请求 Headers 参数说明 参数名称 是否
必选
参数类型 说明
Content-Type 是 String 固定填写为application/json;charset=UTF-8。
Authoriza
tion 是 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时间戳转换为普通时间时使用的 格式不同，部分语言可参考表4-15。
表4-15 不同编程语言的时间格式
编程语言 时间格式
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-16 请求 Body 参数说明 参数名称 是否
必选
参数类型 说明
eventType 是 String(枚
举) 该参数标识通知的事件类型。
取值范围如下：
fee：话单事件
参数名称 是否 必选
参数类型 说明
feeLst 否 FeeInfo[1
-50] 呼叫话单事件的信息，参数取值为列表，最大50 条。
当eventType参数为fee时携带。
表4-17 FeeInfo 定义 参数名称 是否
必须
参数类型 描述
direction 是 Integer
(0-1) 通话的呼叫方向。
固定取值为1。
spId 是 String(1-3
2) 客户的云服务账号。
appKey 是 String(1-1
28) 隐私保护通话应用的app_key。
icid 否 String(1-6
4) 呼叫记录的唯一标识。
bindNum 是 String(1-3
2) 隐私保护号码，号码为全局号码格式（包含国家
码），比如+86138****0021。
sessionId 是 String(1-2
56) 通话链路的唯一标识。
callerNu
m 是 String(1-3
2) 主叫号码，号码为全局号码格式（包含国家
码），比如+86138****0021。
当呼叫场景经过转接时，此参数对应第一路呼叫 的主叫号码。
说明第一路呼叫为A拨打X号码，callerNum为A号码。
calleeNu
m 是 String(1-1
28) 被叫号码，号码为全局号码格式（包含国家 码），比如+86138****0021。
当呼叫场景经过转接时，此参数对应第一路呼叫 的被叫号码。
说明第一路呼叫为A拨打X号码，calleeNum为X号码。
fwdDispla
yNum 否 String(1-3
2) 转接呼叫时的显示号，号码为全局号码格式（包
含国家码），比如+86138****0021。
当呼叫场景经过转接时，此参数对应第二路呼叫 的主显号码。
说明第二路呼叫为X拨打B号码，fwdDisplayNum为X号码。
参数名称 是否 必须
参数类型 描述
fwdDstNu
m 否 String(1-3
2) 转接呼叫时的转接号码。号码仅支持全局号码格
式（包含国家码），比如+86138****0021。
当呼叫场景经过转接时，此参数对应第二路呼叫 的被叫号码。
说明第二路呼叫为X拨打B号码，fwdDstNum为B号码。
callInTim
e 是 String(1-1
28) 呼入的开始时间。
该参数为UTC时间（+8小时为北京时间），时间 格式为“yyyy-MM-dd HH:mm:ss”。
fwdStartT
ime 否 String(1-1
28) 转接呼叫操作的开始时间。
该参数为UTC时间（+8小时为北京时间），时间 格式为“yyyy-MM-dd HH:mm:ss”。
fwdAlerti
ngTime 否 String(1-1
28) 转接呼叫操作后的振铃时间。
该参数为UTC时间（+8小时为北京时间），时间 格式为“yyyy-MM-dd HH:mm:ss”。
fwdAnsw
erTime 否 String(1-1
28) 转接呼叫操作后的应答时间。
该参数为UTC时间（+8小时为北京时间），时间 格式为“yyyy-MM-dd HH:mm:ss”。
callEndTi
me 是 String(1-1
28) 呼叫结束时间。
该参数为UTC时间（+8小时为北京时间），时间 格式为“yyyy-MM-dd HH:mm:ss”。
fwdUnas
wRsn 否 Integer 转接呼叫操作失败的Q850原因值。详细说明参见 Q850原因值说明。
failTime 否 String(1-1
28) 呼入、呼出的失败时间。
该参数为UTC时间（+8小时为北京时间），时间 格式为“yyyy-MM-dd HH:mm:ss”。
ulFailReas
on 否 Integer 通话失败的拆线点。详细说明参见呼叫拆线点说
明。
sipStatus
Code 否 Integer 呼入、呼出的失败SIP状态码。
recordFla
g 否 Integer
(0-1) 该字段用于录音标识，参数值范围如：
● 0：表示未录音
● 1：表示有录音 recordSta
rtTime 否 String(1-1
28) 录音开始时间。
该参数为UTC时间（+8小时为北京时间），时间 格式为“yyyy-MM-dd HH:mm:ss”。
参数名称 是否 必须
参数类型 描述
recordObj
ectName 否 String(1-1
28) 录音文件名。
说明参数值为空时，请访问“recordFileDownloadUrl”参
数携带的录音文件下载地址下载录音文件。
recordBuc
ketName 否 String(1-1
28) 录音文件名所在的目录名。
说明参数值为空时，请访问“recordFileDownloadUrl”参
数携带的录音文件下载地址下载录音文件。
recordDo
main 否 String(1-2
56) 存放录音文件的域名。
说明参数值为空时，请访问“recordFileDownloadUrl”参
数携带的录音文件下载地址下载录音文件。
serviceTyp
e 否 String(1-3
2) 携带呼叫的业务类型信息，取值范围：
004：AXB模式或X模式 hostNam
e 否 String(1-1
28) 该参数用于标识话单生成的服务器设备对应的主 机名。
subscripti
onId 否 String(1-6
4) 绑定ID。
notifyMo
de 否 String(1-3
2) 该参数仅在X模式场景携带，固定取值为Block，
用于标识该话单为X模式话单。
callOutUn
aswRsn 否 Integer Initcall的呼出失败的Q850原因值。
详细说明参见Q850原因值说明。
说明
预留参数，无需关注。
ttsPlayTi
mes 否 integer 应用TTS功能时，使用TTS的总次数。
说明
预留参数，无需关注。
ttsTransD
uration 否 integer 应用TTS功能时，TTS Server进行TTS转换的总时 长。单位为秒。
说明
预留参数，无需关注。
mptyId 否 String(1-1
28) 该参数作为预留字段，用于标识Enabler服务器上 一条多方通话的链路。
该参数仅在多方通话场景生效。
说明
预留参数，无需关注。
参数名称 是否 必须
参数类型 描述
voiceChec
kType 否 Integer
（枚举）
录音质检类型，取值如下：
● Null：无质检
● 0：无录音质检，表示API指示不录音（即 recordFlag取值为false）时进行的质检
● 1：有录音质检，表示API指示要录音（即 recordFlag取值为true）时进行的质检 recordFile
Downloa dUrl
否 String(1-2
56) 录音文件下载地址，可通过该URL在浏览器中下 载录音文件。
说明
使用该参数的场景请联系华为云客服获取。
areaCode 否 String(0-3
2) 隐私保护号码（X号码）的城市码。
说明
使用该参数的场景请联系华为云客服获取。
callRelDir
ection 否 Integer 主被叫通话结束后的挂机方向。
● 1：主叫主动挂机
● 2：被叫主动挂机 说明
使用该参数的场景请联系华为云客服获取。
callDurati
on 否 Integer 呼叫的通话时长，单位为秒。
说明
使用该参数的场景请联系华为云客服获取。
userData 否 String(0-2
56) 用户附属信息。
当客户在该接口Block模式响应参数中携带了
“userData”时，对应呼叫后续的通知消息中都 会携带此参数。
接口示例
POST /fee HTTP/1.1 content-length:xx
{"eventType":"fee","feeLst":[{"direction":
1,"spId":"********","appKey":"********","icid":"e01ed0af24040eab7ba27a1c441f91641.3663053204.1117803.14","
bindNum":"+86138****0022","sessionId":"[email protected]","subscripti onId":"********","callerNum":"+86138****0021","calleeNum":"+86138****0022","fwdDisplayNum":"+86138****00 22","fwdDstNum":"+86138****7021","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":"****.com","recordBucketName":"****","recordObjectName":"****.wav","ttsPlayTimes
":0,"ttsTransDuration":
0,"mptyId":"********","serviceType":"004","hostName":"callenabler246.huaweicaas.com","userData":"d77b5e3c bd234159af401d63f559f896","notifyMode":"Block"}]}
响应参数
客户服务器接收到隐私保护通话平台的呼叫话单通知后，返回的响应消息。
接口示例
HTTP/1.1 200 OK
4.4 X 号码状态通知接口
接口功能
X号码状态变化时，隐私保护通话平台会向客户推送通知。号码状态变化包括：
● 因号码删除、欠费、停机，号码状态从可用变为不可用；
● 号码状态从不可用恢复为可用；
● 不可用原因变化，例如从欠费变为停机。
请求方向
隐私保护通话平台（服务端） → 客户服务器（客户端）
使用说明
● 前提条件
客户添加应用时需设置呼叫状态接收地址并启用推送X号码状态功能，并确保提供 的地址能够正常处理隐私保护通话平台发送的通知消息。
注：若需单独接收X号码状态通知，需填写X号码状态接收地址。若呼叫状态接收 地址和X号码状态接收地址都填写了，隐私保护通话平台会向呼叫状态接收地址推 送呼叫事件通知，向X号码状态接收地址推送X号码状态通知。
● 使用限制
业务平台推送呼叫状态给开发者应用，仅支持POST方式。
接口类型
表4-18 接口类型说明 请求方法 POST
访问URI 客户添加应用时填写的呼叫状态接收地址/X号码状态接收地址 通信协议 HTTPS/HTTP
请求参数
表4-19 请求 Headers 参数说明 参数名称 是否
必选
参数类型 说明
Content-Type 是 String 固定填写为application/json;charset=UTF-8。
Authoriza
tion 是 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时间戳转换为普通时间时使用的 格式不同，部分语言可参考表4-20。
表4-20 不同编程语言的时间格式
编程语言 时间格式
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-21 请求 Body 参数说明 参数名称 是否
必选
参数类型 说明
eventType 是 String(枚
举) 该参数标识通知的事件类型。
取值范围如下：
● numStatus：X号码状态变化 numInfo 否 numInfo
[1-100] X号码状态变化事件的信息，参数取值为列表，最 大100条。
当eventType参数为numStatus时携带。
表4-22 numInfo 定义 参数名称 是否
必须
参数类型 说明
number 是 String 状态变化的X号码。
status 是 String 号码状态。
● 5：正常
● 9：暂停
● 10：不可用
● 11：冻结绑定 说明
各号码状态对业务的影响如下：
● 正常：无影响。
● 暂停&不可用：绑定、呼叫和短信都不可用。
● 冻结绑定：号码不可新增绑定关系，但已存在的绑 定关系的呼叫和短信业务不受影响。
● 冻结绑定：号码不可新增绑定关系，但已存在的绑 定关系的呼叫和短信业务不受影响。