语音通话 VoiceCall-语音回呼话单通知API:语音回呼场景请求参数
下载语音通话 VoiceCall用户手册完整版
语音回呼场景请求参数
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
Content-Type |
是 |
String |
固定填写为application/json;charset=UTF-8。 |
Authorization |
是 |
String |
固定填写为AKSK realm="SDP",profile="UsernameToken",type="Appkey"。 |
X-AKSK |
是 |
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(枚举) |
该参数标识API事件通知的类型。取值范围如下： |
feeLst |
否 |
FeeInfo[1-50] |
呼叫话单事件的信息，参数取值为列表，最大50条。 当eventType参数为fee时携带。 |
FeeInfo
参数名称 |
是否必须 |
参数类型 |
描述 |
|---|---|---|---|
direction |
是 |
Integer (0-1) |
通话的呼叫方向，以语音通话平台为基准。 0表示呼出（外呼） |
spId |
是 |
String(1-32) |
客户的云服务账号。 |
appKey |
是 |
String(1-32) |
应用的app_key。 |
icid |
否 |
String(1-64) |
呼叫记录的唯一标识。 |
bindNum |
是 |
String(1-32) |
发起此次呼叫的固话号码。 号码仅支持全局号码格式（包含国家码），比如+8675528****02。 |
sessionId |
是 |
String(1-256) |
通话链路的唯一标识。 |
callerNum |
是 |
String(1-32) |
主叫号码，号码为全局号码格式（包含国家码），比如+86138****0021。 当呼叫场景经过转接时，此参数对应第一路呼叫的号显号码。 注：
第一路呼叫是语音通话平台呼叫A，callerNum为SP设置的主叫端来电显示号码（displayNbr）。 |
calleeNum |
是 |
String(1-32) |
被叫号码，号码为全局号码格式（包含国家码），比如+86138****0021。 当呼叫场景经过转接时，此参数对应第一路呼叫的被叫号码。 注：语音回呼场景，第一路呼叫是语音通话平台呼叫A，calleeNum为A号码。 |
fwdDisplayNum |
否 |
String(1-32) |
转接呼叫时的显示号码，号码为全局号码格式（包含国家码），比如+86138****0021。 当呼叫场景经过转接时，此参数对应第二路呼叫的固话号码。 注：
第二路呼叫是语音通话平台呼叫B，fwdDisplayNum为SP设置的被叫端来电显示号码（displayCalleeNbr）。 |
fwdDstNum |
否 |
String(1-32) |
转接呼叫时的转接号码。号码仅支持全局号码格式（包含国家码），比如+86138****0021。 当呼叫场景经过转接时，此参数对应第二路呼叫的被叫号码。 注：语音回呼场景，第二路呼叫是语音通话平台呼叫B，fwdDstNum为B号码。 |
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原因值。详细说明参见附录1-Q850原因值说明。 |
failTime |
否 |
String(1-128) |
呼入、呼出的失败时间。 该参数为UTC时间（+8小时为北京时间），时间格式为“yyyy-MM-dd HH:mm:ss”。 |
ulFailReason |
否 |
Integer |
通话失败的拆线点。详细说明参见附录2-呼叫拆线点说明。 |
sipStatusCode |
否 |
Integer |
呼入、呼出的失败SIP状态码。 |
callOutStartTime |
否 |
String(1-128) |
Initcall的呼出开始时间 该参数为UTC时间（+8小时为北京时间），时间格式为“yyyy-MM-dd HH:mm:ss”。 |
callOutAlertingTime |
否 |
String(1-128) |
Initcall的呼出振铃时间 该参数为UTC时间（+8小时为北京时间），时间格式为“yyyy-MM-dd HH:mm:ss”。 |
callOutAnswerTime |
否 |
String(1-128) |
Initcall的呼出应答时间 该参数为UTC时间（+8小时为北京时间），时间格式为“yyyy-MM-dd HH:mm:ss”。 |
callOutUnaswRsn |
否 |
Integer |
Initcall的呼出失败的Q850原因值。 详细说明参见附录1-Q850原因值说明。 |
recordFlag |
否 |
Integer (0-1) |
该字段用于录音标识，参数值范围如：
|
recordStartTime |
否 |
String(1-128) |
录音开始时间，时间格式为“yyyy-MM-dd HH:mm:ss”。 |
recordObjectName |
否 |
String(1-128) |
录音文件名。
说明：
参数值为空时，请访问“recordFileDownloadUrl”参数携带的录音文件下载地址下载录音文件。 |
recordBucketName |
否 |
String(1-128) |
录音文件名所在的目录名。
说明：
参数值为空时，请访问“recordFileDownloadUrl”参数携带的录音文件下载地址下载录音文件。 |
recordDomain |
否 |
String(1-256) |
存放录音文件的 域名 。
说明：
参数值为空时，请访问“recordFileDownloadUrl”参数携带的录音文件下载地址下载录音文件。 |
recordFileDownloadUrl |
否 |
String(1-1024) |
录音文件下载地址，可通过该URL在浏览器中下载录音文件。
说明：
使用该参数的场景请联系华为云客服获取。 |
ttsPlayTimes |
否 |
integer |
应用 TTS 功能时，使用TTS的总次数。 预留参数，无需关注。 |
ttsTransDuration |
否 |
integer |
应用TTS功能时，TTS Server进行TTS转换的总时长。单位为秒。 预留参数，无需关注。 |
serviceType |
否 |
String(1-32) |
携带呼叫的业务类型信息，取值范围： 002：语音回呼 |
hostName |
否 |
String(1-128) |
该参数用于标识话单生成的服务器设备对应的主机名。 |
userData |
否 |
String(1-256) |
用户附属信息，此参数的值与“语音回呼场景API”中的"userData"参数值一致。 |
接口样例
POST /status HTTP/1.1Content-Length: xx {"eventType":"fee","feeLst":[{"direction":0,"spId":"CaaS_Test_01","appKey":"ka4kESI5s3YyurL1wpx63s9YnEm2","icid":"CAE-20190124110424-12019775","bindNum":"+86755****5678","sessionId":"1201_612_4294967295_20190124030424@callenabler245.huaweicaas.com","callerNum":"+86138****0022","calleeNum":"+86138****0021","fwdDisplayNum":"+86138****0022","fwdDstNum":"+86138****7021","fwdStartTime":"2019-01-24 03:04:31","fwdAlertingTime":"2019-01-24 03:04:36","fwdAnswerTime":"2019-01-24 03:04:38","callEndTime":"2019-01-24 03:04:49","fwdUnaswRsn":0,"ulFailReason":0,"sipStatusCode":0,"callOutStartTime":"2019-01-24 03:04:24","callOutAlertingTime":"2019-01-24 03:04:27","callOutAnswerTime":"2019-01-24 03:04:31","callOutUnaswRsn":0,"recordFlag":0,"ttsPlayTimes":0,"ttsTransDuration":0,"serviceType":"002","hostName":"callenabler245.huaweicaas.com"}]}
