华为云用户手册

请求参数 表2 请求Headers参数说明 参数名称 是否必选 参数类型 说明 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="随机数生成时间"。 PasswordDigest：根据PasswordDigest = Base64 (HMAC-SHA256 (Password，Nonce + Created))生成。其中，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) 通话的呼叫方向。 0：其他用户呼叫A。 1：A呼叫其他用户。 2：异常场景（如无绑定数据等）。 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。 当呼叫场景经过转接时，此参数对应第一路呼叫的主叫号码。 说明： A主叫场景，第一路呼叫为A拨打X号码，callerNum为A号码。 A被叫场景，第一路呼叫为B拨打X号码，callerNum为B号码（B为任意其他用户）。 calleeNum 是 String(1-32) 被叫号码，号码为全局号码格式（包含国家码），比如+86138****0021。 当呼叫场景经过转接时，此参数对应第一路呼叫的被叫号码。 说明： A主叫场景，第一路呼叫为A拨打X号码，calleeNum为X号码。 A被叫场景，第一路呼叫为B拨打X号码，calleeNum为X号码。 fwdDisplayNum 否 String(1-32) 转接呼叫时的显示号，号码为全局号码格式（包含国家码），比如+86138****0021。 当呼叫场景经过转接时，此参数对应第二路呼叫的主显号码。 说明： A主叫场景，第二路呼叫为X拨打B号码，fwdDisplayNum为X号码。 A被叫场景，第二路呼叫为X拨打A号码，fwdDisplayNum为X号码。 fwdDstNum 否 String(1-32) 转接呼叫时的转接号码。号码仅支持全局号码格式（包含国家码），比如+86138****0021。 当呼叫场景经过转接时，此参数对应第二路呼叫的被叫号码。 说明： A主叫场景，第二路呼叫为X拨打B号码，fwdDstNum为B号码。 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) 录音开始时间。 该参数为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) 携带呼叫的业务类型信息，取值范围： 003：AX模式 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（枚举） 录音质检类型，取值如下： Null：无质检 0：无录音质检，表示API指示不录音（即recordFlag取值为false）时进行的质检 1：有录音质检，表示API指示要录音（即recordFlag取值为true）时进行的质检 recordFileDownloadUrl 否 String(1-1024) 录音文件下载地址，可通过该URL在浏览器中下载录音文件。 说明： 使用该参数的场景请联系华为云客服获取。 areaCode 否 String(0-32) 隐私保护号码（X号码）的城市码。 说明： 使用该参数的场景请联系华为云客服获取。 callDuration 否 Integer 呼叫的通话时长，单位为秒。 说明： 使用该参数的场景请联系华为云客服获取。 userData 否 String(1-256) 用户附属信息。 当客户在AX模式绑定接口、AX模式绑定信息修改接口或AX模式设置临时被叫接口中携带了“userData”时，对应此呼叫事件的通知消息中都会携带此参数。 接口示例 POST /fee HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx{"eventType":"fee","feeLst":[{"direction":1,"spId":"****","appKey":"****","icid":"ba171f34e6953fcd751edc77127748f4.3757285803.338666679.5","bindNum":"+86138****0022","sessionId":"1200_1827_4294967295_20190124023003@callenabler246.huaweicaas.com","subscriptionId":"****","callerNum":"+86138****0021","calleeNum":"+86138****0022","fwdDisplayNum":"+86138****0022","fwdDstNum":"+86138****7021","callInTime":"2019-01-24 02:30:03","fwdStartTime":"2019-01-24 02:30:03","fwdAlertingTime":"2019-01-24 02:30:04","fwdAnswerTime":"2019-01-24 02:30:06","callEndTime":"2019-01-24 02:30:22","fwdUnaswRsn":0,"ulFailReason":0,"sipStatusCode":0,"callOutUnaswRsn":0,"recordFlag":1,"recordStartTime":"2019-01-24 02:30:06","recordDomain":"****.com","recordBucketName":"****","recordObjectName":"****.wav","ttsPlayTimes":0,"ttsTransDuration":0,"mptyId":"****","serviceType":"003","hostName":"callenabler246.huaweicaas.com"}]}

使用说明 前提条件 客户添加应用时需设置呼叫话单接收地址，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。 注意事项 若平台给客户推送话单后未收到成功响应，视为推送失败，平台会重新推送话单，直至客户返回成功响应。平台最多重推6次，分别于1分钟、4分钟、9分钟、106分钟、203分钟和300分钟后重推。 若没有收到平台推送请参考收不到呼叫事件和话单通知如何处理？ 使用限制 业务平台推送话单信息给开发者应用，仅支持POST方式。

请求参数 表2 请求Headers参数说明 参数名称 是否必选 参数类型 说明 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="随机数生成时间"。 PasswordDigest：根据PasswordDigest = Base64 (HMAC-SHA256 (Password，Nonce + Created))生成。其中，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) 隐私保护号码，号码为全局号码格式（包含国家码），比如+86138****0021。 sessionId 是 String(1-256) 通话链路的唯一标识。 callerNum 是 String(1-32) 主叫号码，号码为全局号码格式（包含国家码），比如+86138****0021。 当呼叫场景经过转接时，此参数对应第一路呼叫的主叫号码。 说明： 第一路呼叫为A拨打X号码，callerNum为A号码。 calleeNum 是 String(1-128) 被叫号码，号码为全局号码格式（包含国家码），比如+86138****0021。 当呼叫场景经过转接时，此参数对应第一路呼叫的被叫号码。 说明： 第一路呼叫为A拨打X号码，calleeNum为X号码。 fwdDisplayNum 否 String(1-32) 转接呼叫时的显示号，号码为全局号码格式（包含国家码），比如+86138****0021。 当呼叫场景经过转接时，此参数对应第二路呼叫的主显号码。 说明： 第二路呼叫为X拨打B号码，fwdDisplayNum为X号码。 fwdDstNum 否 String(1-32) 转接呼叫时的转接号码。号码仅支持全局号码格式（包含国家码），比如+86138****0021。 当呼叫场景经过转接时，此参数对应第二路呼叫的被叫号码。 说明： 第二路呼叫为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) 录音开始时间。 该参数为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) 携带呼叫的业务类型信息，取值范围： 004：AXB模式或X模式 hostName 否 String(1-128) 该参数用于标识话单生成的服务器设备对应的主机名。 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）时进行的质检 recordFileDownloadUrl 否 String(1-1024) 录音文件下载地址，可通过该URL在浏览器中下载录音文件。 说明： 使用该参数的场景请联系华为云客服获取。 areaCode 否 String(0-32) 隐私保护号码（X号码）的城市码。 说明： 使用该参数的场景请联系华为云客服获取。 callRelDirection 否 Integer 主被叫通话结束后的挂机方向。 1：主叫主动挂机 2：被叫主动挂机 说明： 使用该参数的场景请联系华为云客服获取。 callDuration 否 Integer 呼叫的通话时长，单位为秒。 说明： 使用该参数的场景请联系华为云客服获取。 userData 否 String(0-256) 用户附属信息。 当客户在该接口Block模式响应参数中携带了“userData”时，对应呼叫后续的通知消息中都会携带此参数。 接口示例 POST /fee HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx{"eventType":"fee","feeLst":[{"direction":1,"spId":"********","appKey":"********","icid":"e01ed0af24040eab7ba27a1c441f91641.3663053204.1117803.14","bindNum":"+86138****0022","sessionId":"1200_366_0_20161228102743@callenabler.home1.com","subscriptionId":"********","callerNum":"+86138****0021","calleeNum":"+86138****0022","fwdDisplayNum":"+86138****0022","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":"d77b5e3cbd234159af401d63f559f896","notifyMode":"Block"}]}

使用说明 前提条件 客户添加应用时需设置呼叫话单接收地址，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。 注意事项 若平台给客户推送话单后未收到成功响应，视为推送失败，平台会重新推送话单，直至客户返回成功响应。平台最多重推6次，分别于1分钟、4分钟、9分钟、106分钟、203分钟和300分钟后重推。 若没有收到平台推送请参考收不到呼叫事件和话单通知如何处理？ 使用限制 业务平台推送话单信息给开发者应用，仅支持POST方式。

请求参数 AX模式中，A和X号码形成绑定关系，所有与A用户建立的通讯都是通过X号码建立：A呼叫X，呼叫转接给指定的呼叫对象（A主叫场景）；其他用户呼叫X，呼叫转接给A（A被叫场景）。 注：以下流程和接口示例以A主叫场景为例，即A呼叫X，呼叫转接给指定的呼叫对象B，B用户接听为例。流程和接口示例仅供参考，请以实际消息为准。 图1 A主叫场景业务流程 表2 请求Headers参数说明 参数名称 是否必选 参数类型 说明 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="随机数生成时间"。 PasswordDigest：根据PasswordDigest = Base64 (HMAC-SHA256 (Password，Nonce + Created))生成。其中，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(枚举) 该参数标识通知的事件类型。 取值范围如下： callin：呼入事件 callout：呼出事件 alerting：振铃事件 answer：应答事件 disconnect：挂机事件 statusInfo 否 CallStatusInfo 呼叫状态事件的信息。 当eventType参数为callin、callout、alerting、answer、disconnect时携带。 callin：呼入事件 callout：呼出事件 alerting：振铃事件 answer：应答事件 disconnect：挂机事件 CallStatusInfo定义 表5 callin：呼入事件 参数名称 是否必选 参数类型 说明 timestamp 是 String(1-128) 该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。 sessionId 是 String(1-256) 唯一指定一条通话链路的标识ID。 caller 否 String(1-32) 主叫号码。 号码为全局号码格式（包含国家码），如+86138****0021。 说明： A主叫场景，呼入事件的主叫号码为A号码。 A被叫场景，呼入事件的主叫号码为B号码（B为任意其他用户）。 called 否 String(1-32) 被叫号码。 说明： A主叫/被叫场景，呼入事件的被叫号码为X号码。 subscriptionId 否 String(1-64) 绑定ID。 userData 否 String(1-256) 用户附属信息。 说明： 使用该参数的场景请联系华为云客服获取。 接口示例 POST /status HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"Content-Length: xx {"eventType":"callin","statusInfo":{"sessionId":"1200_1827_4294967295_20190124023003@callenabler246.huaweicaas.com","timestamp":"2019-01-24 02:30:03","caller":"+86138****0021","called":"+86138****0022","subscriptionId":"****"}} 表6 callout：呼出事件 参数名称 是否必选 参数类型 说明 timestamp 是 String(1-128) 该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。 sessionId 是 String(1-256) 唯一指定一条通话链路的标识ID。 caller 否 String(1-32) 主叫号码。 号码为全局号码格式（包含国家码），如+86138****0021。 说明： A主叫/被叫场景，呼出事件的主叫号码为X号码。 called 否 String(1-32) 被叫号码。 说明： A主叫场景，呼出事件的被叫号码为B号码。 A被叫场景，呼出事件的被叫号码为A号码。 subscriptionId 否 String(1-64) 绑定ID。 userData 否 String(1-256) 用户附属信息。 当客户在AX模式绑定接口、AX模式绑定信息修改接口或AX模式设置临时被叫接口中携带了“userData”时，对应此呼叫事件的通知消息中都会携带此参数。 接口示例 POST /status HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx {"eventType":"callout","statusInfo":{"sessionId":"1200_1827_4294967295_20190124023003@callenabler246.huaweicaas.com","timestamp":"2019-01-24 02:30:03","caller":"+86138****0022","called":"+86138****7021","subscriptionId":"****"}} 表7 alerting：振铃事件 参数名称 是否必选 参数类型 说明 timestamp 是 String(1-128) 该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。 sessionId 是 String(1-256) 唯一指定一条通话链路的标识ID。 caller 否 String(1-32) 主叫号码。 号码为全局号码格式（包含国家码），如+86138****0021。 说明： A主叫/被叫场景，振铃事件的主叫号码为X号码。 called 否 String(1-32) 被叫号码。 说明： A主叫场景，振铃事件的被叫号码为B号码。 A被叫场景，振铃事件的被叫号码为A号码。 subscriptionId 否 String(1-64) 绑定ID。 userData 否 String(1-256) 用户附属信息。 当客户在AX模式绑定接口、AX模式绑定信息修改接口或AX模式设置临时被叫接口中携带了“userData”时，对应此呼叫事件的通知消息中都会携带此参数。 接口示例 POST /status HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx{"eventType":"alerting","statusInfo":{"sessionId":"1200_1827_4294967295_20190124023003@callenabler246.huaweicaas.com","timestamp":"2019-01-24 02:30:04","caller":"+86138****0022","called":"+86138****7021","subscriptionId":"****"}} 表8 answer：应答事件 参数名称 是否必选 参数类型 说明 timestamp 是 String(1-128) 该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。 sessionId 是 String(1-256) 唯一指定一条通话链路的标识ID。 caller 否 String(1-32) 主叫号码。 号码为全局号码格式（包含国家码），如+86138****0021。 说明： A主叫/被叫场景，应答事件的主叫号码为X号码。 called 否 String(1-32) 被叫号码。 说明： A主叫场景，应答事件的被叫号码为B号码。 A被叫场景，应答事件的被叫号码为A号码。 subscriptionId 否 String(1-64) 绑定ID。 userData 否 String(1-256) 用户附属信息。 当客户在AX模式绑定接口、AX模式绑定信息修改接口或AX模式设置临时被叫接口中携带了“userData”时，对应此呼叫事件的通知消息中都会携带此参数。 接口示例 POST /status HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx {"eventType":"answer","statusInfo":{"sessionId":"1200_1827_4294967295_20190124023003@callenabler246.huaweicaas.com","timestamp":"2019-01-24 02:30:06","caller":"+86138****0022","called":"+86138****7021","subscriptionId":"****"}} 表9 disconnect：挂机事件 参数名称 是否必选 参数类型 说明 timestamp 是 String(1-128) 该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。 sessionId 是 String(1-256) 唯一指定一条通话链路的标识ID。 caller 否 String(1-32) 主叫号码。 号码为全局号码格式（包含国家码），如+86138****0021。 说明： 此处返回号码非真实主被叫号码，真实主被叫号码请以fee事件中的返回值为准。 called 否 String(1-32) 被叫号码。 说明： 此处返回号码非真实主被叫号码，真实主被叫号码请以fee事件中的返回值为准。 stateCode 否 Integer 通话挂机的原因值，仅当eventType为disconnect时携带。 取值范围及表示的含义请参考通话挂机原因值说明。 stateDesc 否 String(1-128) 通话挂机的原因值的描述，仅当eventType为disconnect时携带。 subscriptionId 否 String(1-64) 绑定ID。 userData 否 String(1-256) 用户附属信息。 当客户在AX模式绑定接口、AX模式绑定信息修改接口或AX模式设置临时被叫接口中携带了“userData”时，对应此呼叫事件的通知消息中都会携带此参数。 接口示例 POST /status HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx{"eventType":"disconnect","statusInfo":{"sessionId":"1200_1827_4294967295_20190124023003@callenabler246.huaweicaas.com","timestamp":"2019-01-24 02:30:22","caller":"+86138****0022","called":"+86138****7021","stateCode":0,"stateDesc":"The user releases the call.","subscriptionId":"****"}}

使用说明 前提条件 客户添加应用时需设置呼叫状态接收地址，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。 如果需要单独接收呼入事件（callin），需联系客服，提供呼入事件状态接收地址。 注意事项 若平台给客户推送呼叫事件通知后未收到成功响应，视为推送失败，平台会重新推送呼叫事件通知，直至客户返回成功响应。平台最多重推6次，分别于1分钟、4分钟、9分钟、106分钟、203分钟和300分钟后重推。 若没有收到平台推送请参考收不到呼叫事件和话单通知如何处理？ 使用限制 业务平台推送呼叫状态给开发者应用，仅支持POST方式。

接口示例 接口示例仅供参考，请以实际消息为准。 请求示例 PUT /rest/caas/relationnumber/partners/v1.0 HTTP1.1 content-type: application/json;charset=UTF-8 authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx { "subscriptionId":"****","calleeNum":"+86138****0021"} 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Content-Length: xx { "resultcode":"0", "resultdesc":"Success"}

结果码说明 表7 响应结果码 响应码 结果码 英文描述 中文描述 处理方法 200 0 Success. 成功。 - 400 1023006 Authorization not contained in the HTTP header. HTTP消息头未找到Authorization字段。 请检查HTTP消息头中是否携带了Authorization字段。 1023007 realm not contained in Authorization. Authorization字段中未找到realm属性。 请检查Authorization字段中的是否携带了realm属性。 1023008 profile not contained in Authorization. Authorization字段中未找到profile属性。 请检查Authorization字段中的是否携带了profile属性。 1023009 The value of realm in Authorization must be SDP. Authorization中realm属性值应该为“SDP”。 请检查Authorization字段中的realm属性值是否为“SDP”。 1023010 The value of profile in Authorization must be UsernameToken. Authorization中profile属性值应该为“UsernameToken”。 请检查Authorization字段中的profile属性值是否为“UsernameToken”。 1023011 The value of type in Authorization must be app_key. Authorization中type属性值应该为“Appkey”。 请检查Authorization字段中的type属性值是否为“Appkey”。 1023012 type not contained in Authorization. Authorization字段中未找到type属性。 请检查Authorization字段中是否携带了type属性。 1023033 HTTP header not found X-AKSK field. HTTP头未找到X-AKSK字段。 请检查HTTP消息头中是否携带了X-AKSK字段。 1023034 UserName not contained in X-AKSK. X-AKSK字段中未找到UserName属性。 请检查X-AKSK字段中的是否携带了Username属性。 1023035 Nonce not contained in X-AKSK. X-AKSK字段中未找到Nonce属性。 请检查X-AKSK字段中的是否携带了Nonce属性。 1023036 Created not contained in X-AKSK. X-AKSK字段中未找到Created属性。 请检查X-AKSK字段中的是否携带了Created属性。 1023037 PasswordDigest not contained in X-AKSK. X-AKSK字段中未找到PasswordDigest属性。 请检查X-AKSK字段中的是否携带了PasswordDigest属性。 1023038 UsernameToken not contained in X-AKSK. X-AKSK中没有携带UsernameToken。 请检查X-AKSK字段中的是否携带了UsernameToken属性。 401 1010010 Invalid digest. PasswordDigest校验失败。 请检查PasswordDigest字段填写是否正确。 1010013 Time out limit. 时间超出限制。 请确认X-AKSK鉴权时，生成随机数的时间与发送请求时的本地时间不能相差太大（具体差值请与管理员确认）。 403 1010002 Invalid request. 无效请求。 参考各接口参数说明，检查请求携带的参数格式是否正确，如以下参数格式问题： 绑定接口填写的号码参数需为全局号码格式，如+86138****0001或+8675528****01； 放音文件需上传通过审核才可通过接口调用，点击查看如何上传审核。 参考接口参数说明，检查是否携带了不能同时携带的参数； 参数长度或格式是否错误。 1010003 Invalid app_key. 无效的app_key。 请检查请求携带的app_key填写是否正确。 1010004 The status of the app_key is unavailable. app_key状态异常。 请检查请求携带的app_key所属应用状态是否正常。 1010010 The flow control upper limit is reached on the platform. 平台达到系统流控上限。 请稍等一分钟后再试。 1010029 The subscriber status is frozen. 用户账号已冻结。 查看账户是否欠费。如欠费需充值后才能继续使用。 若未欠费，请联系华为云客服处理。 1010040 The app_key is not allowed to invoke the API. app_key没有调用本API的权限。 调用的接口和app_key所属的应用模式不一致。如添加应用时选择的AXB模式的应用，调用接口时只能调用AXB模式的接口，不能调用其他模式的接口。 1012007 The record does not exist. 记录不存在。 未查询到绑定关系，请检查携带的subscriptionId参数是否填写正确，或是否属于该应用。 1012102 The number status is abnormal. 号码状态异常。 出现该错误码表示调用接口时指定的X号码因投诉或号码状态异常被隐私保护通话平台加入了黑名单，请查看订购号码时填写的邮箱是否有业务下线通知邮件，如果没有，请拨打400电话联系华为云客服处理。 1012010 The number $ has been bound. 绑定关系已存在。 请检查callerNum或calleeNum是否已和subscriptionId指定的X号码存在绑定关系，且绑定关系未过期，然后修改callerNum/calleeNum的值。 1020166 The app client ip is not in ip white list. 对端app IP不在白名单列表中。 联系管理员检查IP白名单是否配置正确。 1020176 Authentication failed, try again later 鉴权失败，稍后重试 IP因鉴权失败次数过多导致被拉黑，请30分钟后重试，或联系管理员放通该IP。 1020179 Application does not enable sms function. 应用未开启短信功能。 请确认app_key所属的应用是否开启了短信功能，点击查看如何开启短信功能。 500 1010001 Internal system error. 系统错误。 请联系客服处理。 1023001 Internal error. 内部错误。 1023002 Response timeout. 响应超时。 重新发送一次请求，若依然返回响应超时，请联系管理员处理。

请求参数 表2 请求Headers参数说明 参数名称 是否必选 参数类型 说明 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="随机数生成时间"。 PasswordDigest：根据PasswordDigest = Base64 (HMAC-SHA256 (Password，Nonce + Created))生成。其中，Password为APP_Secret的值。Nonce、Created、Password直接进行字符串拼接即可，无需包含+号和空格。 Nonce：客户发送请求时生成的一个随机数，长度为1~128位，可包含数字和大小写字母。例如：66C92B11FF8A425FB8D4CCFE0ED9ED1F。 Created：随机数生成时间。采用标准UTC格式，例如：2018-02-12T15:30:20Z。不同编程语言中的时间格式转换方式不同，部分语言可参考表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参数说明 参数名称 是否必选 参数类型 说明 subscriptionId 是 String(1-64) 指定“AXB模式绑定接口”返回的绑定ID进行修改。 callerNum 否 String(4-31) 将A号码修改为新的值。 填写为全局号码格式。 手机号码格式为国家码（如+86）+手机号码（11位数字的手机号码，如138****0001），填写为"+86138****0001"。 固话号码为国家码（如+86）+不带前置0的区号（如755）+本地固话号码（7或8位数字的固话号码，以实际号码为准，如28****01），填写为"+8675528****01"。 说明： 因运营商管控，固话号码只能接收来自X号码的呼叫，不能作为主叫呼叫X号码。即当A号码为固话号码时，B（手机号码）可以拨打X号码联系A，但A无法通过拨打X号码联系B。 若需双向呼叫，A和B号码都必须是手机号码。 calleeNum 否 String(4-31) 将B号码修改为新的值。 填写为全局号码格式。 手机号码格式为国家码（如+86）+手机号码（11位数字的手机号码，如138****0001），填写为"+86138****0001"。 固话号码为国家码（如+86）+不带前置0的区号（如755）+本地固话号码（7或8位数字的固话号码，以实际号码为准，如28****01），填写为"+8675528****01"。 说明： 因运营商管控，固话号码只能接收来自X号码的呼叫，不能作为主叫呼叫X号码。即当B号码为固话号码时，A（手机号码）可以拨打X号码联系B，但B无法通过拨打X号码联系A。 若需双向呼叫，A和B号码都必须是手机号码。 callDirection 否 Integer 表示修改后的绑定关系允许的呼叫方向，取值范围： 0：bidirectional，表示callerNum和calleeNum都可以通过X号码呼叫对方。 1：caller to callee，表示只允许callerNum通过X号码呼叫calleeNum。 2：callee to caller，表示只允许calleeNum通过X号码呼叫callerNum。 不携带该参数表示不修改呼叫方向。 duration 否 Integer 更新绑定关系保持时间，单位为秒，从修改绑定关系成功开始计算。 取值范围：0~7776000（90天） 不携带该参数表示不修改绑定关系保持时间。 preVoice 否 ApiPlayInfo 修改个性化通话前等待音。 不携带该参数表示不修改通话前等待音。 说明： 仅部分号码支持，如需使用该功能请咨询华为云客服。 maxDuration 否 Integer 修改允许单次通话进行的最长时间，单位为分钟。 取值范围：0~1440 0：系统不主动结束通话，由主被叫双方结束通话。 1~1440：当通话时长达到此配置值，系统主动结束通话。 不携带时，表示不修改该参数值。 lastMinVoice 否 String(0-128) 该绑定关系的maxDuration不为0时该参数有效。 修改通话剩余最后一分钟时的提示音，填写为放音文件名，可在放音文件管理页面查看。 不携带时，表示不修改该参数值。 说明： 仅部分号码支持，如需使用该功能请咨询华为云客服。 privateSms 否 String(枚举) 修改该绑定关系是否支持短信功能。 若客户添加应用时未开通短信功能，请勿携带此参数。 取值范围： false：不支持短信 true：支持短信 不携带时，表示不修改该参数值。 recordFlag 否 String(枚举) 是否需要针对该绑定关系产生的所有通话录音。 false：表示不录音 true：表示录音。 该参数仅当客户添加应用时申请开通了录音功能才有效。 不携带时，表示不修改该参数值。 userData 否 String(1-256) 用户自定义数据。 不允许携带以下字符：“^”，“{”，“}”。 不允许包含中文字符，如果包含中文字符请采用Base64编码。 说明： 若在设置绑定关系时携带该参数，绑定关系对应的呼叫、话单和短信通知消息中也会携带该参数。 表5 ApiPlayInfo定义 参数名称 是否必选 参数类型 说明 callerHintTone 否 String(0-128) 修改callerNum的通话前等待音，填写为放音文件名，可在放音文件管理页面查看。 不携带时，表示不修改该参数值。 calleeHintTone 否 String(0-128) 修改calleeNum的通话前等待音，填写为放音文件名，可在放音文件管理页面查看。 不携带时，表示不修改该参数值。

接口示例 接口示例仅供参考，请以实际消息为准。 请求示例 GET /rest/provision/voice/record/v1.0?fileName=****.wav&recordDomain=huawei HTTP1.1 content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx 响应示例 HTTP/1.1 301 Moved Permanently Location: http://**** Connection: close Content-Length: 0

使用说明 前提条件 已通过“话单通知API”获取了录音文件名（fileName）和录音文件存储的服务器域名（recordDomain）（不同的录音文件的fileName和recordDmain不同，这两个参数用来区分隐私保护通话平台保存的录音文件）。 注意事项 录音文件在平台只保存七天（隐私保护通话平台给客户服务器推送话单后开始计时），超过七天平台会自动删除该录音文件。请在七天期限内调用该接口获取下载地址并下载录音。 隐私保护通话平台给客户服务器推送话单七天之后再调用此接口获取下载地址，会返回“The record does not exist.”错误。 建议调用该接口时把connection设置为不支持重定向，再从Location头域中获取到录音文件的下载地址，具体操作可参考开发指南中编程语言的代码样例。

请求参数 表2 请求URL参数说明 参数名称 是否必选 参数类型 说明 fileName 是 String(1-128) 录音文件名。通过“话单通知接口”的recordObjectName参数获取。 recordDomain 是 String(1-128) 录音文件存储的服务器域名，通过“话单通知API”的recordDomain参数获取。 表3 请求Headers参数说明 参数名称 是否必选 参数类型 说明 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="随机数生成时间"。 PasswordDigest：根据PasswordDigest = Base64 (HMAC-SHA256 (Password，Nonce + Created))生成。其中，Password为APP_Secret的值。Nonce、Created、Password直接进行字符串拼接即可，无需包含+号和空格。 Nonce：客户发送请求时生成的一个随机数，长度为1~128位，可包含数字和大小写字母。例如：66C92B11FF8A425FB8D4CCFE0ED9ED1F。 Created：随机数生成时间。采用标准UTC格式，例如：2018-02-12T15:30:20Z。不同编程语言中的时间格式转换方式不同，部分语言可参考表4。 表4 不同编程语言的时间格式 编程语言 时间格式 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()转换后的时间格式去除毫秒后即为本接口要求的时间格式。

结果码说明 表7 响应结果码 响应码 结果码 英文描述 中文描述 处理方法 301 - - - 成功响应，请从Location头域中获取录音文件下载地址。 400 1023006 Authorization not contained in the HTTP header. HTTP消息头未找到Authorization字段。 请检查HTTP消息头中是否携带了Authorization字段。 1023007 realm not contained in Authorization. Authorization字段中未找到realm属性。 请检查Authorization字段中的是否携带了realm属性。 1023008 profile not contained in Authorization. Authorization字段中未找到profile属性。 请检查Authorization字段中的是否携带了profile属性。 1023009 The value of realm in Authorization must be SDP. Authorization中realm属性值应该为“SDP”。 请检查Authorization字段中的realm属性值是否为“SDP”。 1023010 The value of profile in Authorization must be UsernameToken. Authorization中profile属性值应该为“UsernameToken”。 请检查Authorization字段中的profile属性值是否为“UsernameToken”。 1023011 The value of type in Authorization must be app_key. Authorization中type属性值应该为“Appkey”。 请检查Authorization字段中的type属性值是否为“Appkey”。 1023012 type not contained in Authorization. Authorization字段中未找到type属性。 请检查Authorization字段中是否携带了type属性。 1023033 HTTP header not found X-AKSK field. HTTP头未找到X-AKSK字段。 请检查HTTP消息头中是否携带了X-AKSK字段。 1023034 UserName not contained in X-AKSK. X-AKSK字段中未找到UserName属性。 请检查X-AKSK字段中的是否携带了Username属性。 1023035 Nonce not contained in X-AKSK. X-AKSK字段中未找到Nonce属性。 请检查X-AKSK字段中的是否携带了Nonce属性。 1023036 Created not contained in X-AKSK. X-AKSK字段中未找到Created属性。 请检查X-AKSK字段中的是否携带了Created属性。 1023037 PasswordDigest not contained in X-AKSK. X-AKSK字段中未找到PasswordDigest属性。 请检查X-AKSK字段中的是否携带了PasswordDigest属性。 1023038 UsernameToken not contained in X-AKSK. X-AKSK中没有携带UsernameToken。 请检查X-AKSK字段中的是否携带了UsernameToken属性。 401 1010010 Invalid digest. PasswordDigest校验失败。 请检查PasswordDigest字段填写是否正确。 1010013 Time out limit. 时间超出限制。 请确认X-AKSK鉴权时，生成随机数的时间与发送请求时的本地时间不能相差太大（具体差值请与管理员确认）。 403 1010002 Invalid request. 无效请求。 参考各接口参数说明，检查请求携带的参数格式是否正确，如以下参数格式问题： 绑定接口填写的号码参数需为全局号码格式，如+86138****0001或+8675528****01； 放音文件需上传通过审核才可通过接口调用，点击查看如何上传审核。 参考接口参数说明，检查是否携带了不能同时携带的参数，如AXE模式绑定接口不能同时携带callbackTone和callbackNum，若是，请保留一个； 参数长度或格式是否错误，如AXE模式分机号长度或timeUnit的格式是否正确。 1010003 Invalid app_key. 无效的app_key。 请检查请求携带的app_key填写是否正确。 1010008 The status of the app_key is unavailable. app_key状态异常。 请检查请求携带的app_key所属应用状态是否正常。 1011006 Under traffic control status 请求者（IP、手机号码）处于流控状态下。 请稍等一分钟再试。 1012012 Application does not open recording function. 应用未开启录音功能。 请确认app_key所属的应用是否开启了录音功能。 1012007 The record does not exist. 记录不存在。 请确认fileName参数的填写是否正确。 1020166 The app client ip is not in ip white list. 对端app IP不在白名单列表中。 联系管理员检查IP白名单是否配置正确。 1020176 Authentication failed, try again later 鉴权失败，稍后重试 IP因鉴权失败次数过多导致被拉黑，请30分钟后重试，或联系管理员放通该IP。 500 1010001 Internal system error. 系统错误。 请联系客服处理。 1023001 Internal error. 内部错误。 1023002 Response timeout. 响应超时。 重新发送一次请求，若依然返回响应超时，请联系管理员处理。

接口示例 接口示例仅供参考，请以实际消息为准。 请求示例 PUT /rest/provision/caas/privatenumber/v1.0 HTTP1.1 content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx { "subscriptionId":"****","privateSms":"true"} 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Content-Length: xx { "resultcode":"0", "resultdesc":"Success" }

结果码说明 表6 响应结果码 响应码 结果码 英文描述 中文描述 处理方法 200 0 Success. 成功。 - 400 1023006 Authorization not contained in the HTTP header. HTTP消息头未找到Authorization字段。 请检查HTTP消息头中是否携带了Authorization字段。 1023007 realm not contained in Authorization. Authorization字段中未找到realm属性。 请检查Authorization字段中的是否携带了realm属性。 1023008 profile not contained in Authorization. Authorization字段中未找到profile属性。 请检查Authorization字段中的是否携带了profile属性。 1023009 The value of realm in Authorization must be SDP. Authorization中realm属性值应该为“SDP”。 请检查Authorization字段中的realm属性值是否为“SDP”。 1023010 The value of profile in Authorization must be UsernameToken. Authorization中profile属性值应该为“UsernameToken”。 请检查Authorization字段中的profile属性值是否为“UsernameToken”。 1023011 The value of type in Authorization must be app_key. Authorization中type属性值应该为“Appkey”。 请检查Authorization字段中的type属性值是否为“Appkey”。 1023012 type not contained in Authorization. Authorization字段中未找到type属性。 请检查Authorization字段中是否携带了type属性。 1023033 HTTP header not found X-AKSK field. HTTP头未找到X-AKSK字段。 请检查HTTP消息头中是否携带了X-AKSK字段。 1023034 UserName not contained in X-AKSK. X-AKSK字段中未找到UserName属性。 请检查X-AKSK字段中的是否携带了Username属性。 1023035 Nonce not contained in X-AKSK. X-AKSK字段中未找到Nonce属性。 请检查X-AKSK字段中的是否携带了Nonce属性。 1023036 Created not contained in X-AKSK. X-AKSK字段中未找到Created属性。 请检查X-AKSK字段中的是否携带了Created属性。 1023037 PasswordDigest not contained in X-AKSK. X-AKSK字段中未找到PasswordDigest属性。 请检查X-AKSK字段中的是否携带了PasswordDigest属性。 1023038 UsernameToken not contained in X-AKSK. X-AKSK中没有携带UsernameToken。 请检查X-AKSK字段中的是否携带了UsernameToken属性。 401 1010010 Invalid digest. PasswordDigest校验失败。 请检查PasswordDigest字段填写是否正确。 1010013 Time out limit. 时间超出限制。 请确认X-AKSK鉴权时，生成随机数的时间与发送请求时的本地时间不能相差太大（具体差值请与管理员确认）。 403 1010002 Invalid request. 无效请求。 参考各接口参数说明，检查请求携带的参数格式是否正确，如以下参数格式问题： 绑定接口填写的号码参数需为全局号码格式，如+86138****0001或+8675528****01； 放音文件需上传通过审核才可通过接口调用，点击查看如何上传审核。 参考接口参数说明，检查是否携带了不能同时携带的参数； 参数长度或格式是否错误。 检查userData是否包含中文字符，若包含，请剔除中文后重试，或将内容Base64编码后重试。 1010003 Invalid app_key. 无效的app_key。 请检查请求携带的app_key填写是否正确。 1010008 The status of the app_key is unavailable. app_key状态异常。 请检查请求携带的app_key所属应用状态是否正常。 1010010 The flow control upper limit is reached on the platform. 平台达到系统流控上限。 请稍等一分钟后再试。 1010029 The subscriber status is frozen. 用户账号已冻结。 查看账户是否欠费。如欠费需充值后才能继续使用。 若未欠费，请联系华为云客服处理。 1010040 The app_key is not allowed to invoke the API. app_key没有调用本API的权限。 调用的接口和app_key所属的应用模式不一致。如添加应用时选择的AXB模式的应用，调用接口时只能调用AXB模式的接口，不能调用其他模式的接口。 1011001 The account does not exist. 账号不存在。 出现该错误码可能有以下两个原因： 调用接口时指定的X号码（privateNum）可能不是该应用已申请的隐私号码，请确认privateNum参数的填写是否正确； 调用接口时填写的X号码（privateNum）格式不正确，请根据接口文档修改号码格式后再次尝试。 1011004 The number is not applied for binding application. X号码和app_key没有绑定关系。 携带的app_key和X号码没有绑定关系，请检查携带的X号码是否属于该应用。 1012102 The number status is abnormal. 号码状态异常。 出现该错误码表示调用接口时指定的X号码因投诉或号码状态异常被隐私保护通话平台加入了黑名单，请查看订购号码时填写的邮箱是否有业务下线通知邮件，如果没有，请拨打400电话联系华为云客服处理。 1016001 The record does not exist. 记录不存在。 找不到绑定记录。请检查origNum或者subscriptionId参数的填写是否正确。 1020166 The app client ip is not in ip white list. 对端app IP不在白名单列表中。 联系管理员检查IP白名单是否配置正确。 1020176 Authentication failed, try again later 鉴权失败，稍后重试 IP因鉴权失败次数过多导致被拉黑，请30分钟后重试，或联系管理员放通该IP。 1020178 The transparent mode is not allowed. 不允许显示真实主叫号码。 您的应用不支持显示真实主叫号码，请修改calleeNumDisplay参数的取值为“0”（显示X号码）后再次绑定。 500 1010001 Internal system error. 系统错误。 请联系客服处理。 1023001 Internal error. 内部错误。 1023002 Response timeout. 响应超时。 重新发送一次请求，若依然返回响应超时，请联系管理员处理。

请求参数 表2 请求Headers参数说明 参数名称 是否必选 参数类型 说明 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="随机数生成时间"。 PasswordDigest：根据PasswordDigest = Base64 (HMAC-SHA256 (Password，Nonce + Created))生成。其中，Password为APP_Secret的值。Nonce、Created、Password直接进行字符串拼接即可，无需包含+号和空格。 Nonce：客户发送请求时生成的一个随机数，长度为1~128位，可包含数字和大小写字母。例如：66C92B11FF8A425FB8D4CCFE0ED9ED1F。 Created：随机数生成时间。采用标准UTC格式，例如：2018-02-12T15:30:20Z。不同编程语言中的时间格式转换方式不同，部分语言可参考表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参数说明 参数名称 是否必选 参数类型 说明 origNum 否 String(1-32) AX中的A号码。如果需要修改绑定关系中的用户号码，请指定新的用户号码。不携带时表示不修改该参数值。 填写为全局号码格式： 手机号码格式为国家码（如+86）+手机号码（11位数字的手机号码，如138****0001），填写为"+86138****0001"。 固话号码为国家码（如+86）+不带前置0的区号（如755）+本地固话号码（7或8位数字的固话号码，以实际号码为准，如28****01），填写为"+8675528****01"。 说明： 因运营商管控，固话号码只能接收来自X号码的呼叫，不能作为主叫呼叫X号码。即当A号码为固话号码时，其他用户（手机号码）可以拨打X号码联系A，但A无法通过拨打X号码联系其他用户。 privateNum 否 String(1-32) AX中的X号码。 填写为全局号码格式（包含国家码），例如：+86138****0021。 系统可通过subscriptionId或privateNum确定唯一一个绑定关系，即不携带subscriptionId时，必须携带privateNum。 subscriptionId 否 String(0-64) 指定“AX模式绑定接口”返回的绑定ID修改绑定信息。 请求携带了subscriptionId时，系统会以subscriptionId的值为准，不关注privateNum参数。 privateSms 否 String(枚举) 修改该绑定关系是否支持短信功能。 若客户添加应用时未开通短信功能，请勿携带此参数。 取值范围： false：不支持短信 true：支持短信 不携带时，表示不修改该参数值。 recordFlag 否 String(枚举) 是否需要针对该绑定关系产生的所有通话录音。 false：表示不录音 true：表示录音。 该参数仅当客户添加应用时申请开通了录音功能才有效。 不携带时，表示不修改该参数值。 maxDuration 否 Integer 修改允许单次通话进行的最长时间，单位为分钟。 取值范围：0~1440 0：系统不主动结束通话，由主被叫双方结束通话。 1~1440：当通话时长达到此配置值，系统主动结束通话。 不携带时，表示不修改该参数值。 lastMinVoice 否 String(0-128) 该绑定关系的maxDuration不为0时该参数有效。 修改通话剩余最后一分钟时的提示音，填写为放音文件名，可在放音文件管理页面查看。 不携带时，表示不修改该参数值。 说明： 仅部分号码支持，如需使用该功能请咨询华为云客服。 userData 否 String(1-256) 用户自定义数据。 不允许携带以下字符：“{”，“}”（即大括号）。 不允许包含中文字符，如果包含中文字符请采用Base64编码。 说明： 若在设置绑定关系时携带该参数，绑定关系对应的呼叫、话单和短信通知消息中也会携带该参数。 turnFlag 否 String(枚举) 修改隐私号开关机状态。 取值范围： on：开机状态 off：关机状态 不携带时，表示不修改该参数值。 callDirection 否 Integer 呼叫方向控制。表示该绑定关系允许的呼叫方向。 取值范围如下： 0：允许双向呼叫。 1：只允许A呼叫X号码。 2：只允许其他号码呼叫X号码。 不携带时，表示不修改该参数值。 calleeNumDisplay 否 String(枚举) 设置非A用户呼叫X时，A接到呼叫时的主显号码。 取值： 0：显示X号码； 1：显示真实主叫号码。 不携带时，表示不修改该参数值。 说明： 由于运营商管控，当前平台要求该参数必须设置为0，否则呼叫会被运营商拦截。

请求参数 表2 请求Headers参数说明 参数名称 是否必选 参数类型 说明 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="随机数生成时间"。 PasswordDigest：根据PasswordDigest = Base64 (HMAC-SHA256 (Password，Nonce + Created))生成。其中，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) 通话的呼叫方向。 0：B呼叫A。 1：A呼叫B。 2：异常场景（如无绑定数据等）。 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) 该字段用于录音标识，参数值范围如： 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（枚举） 录音质检类型，取值如下： Null：无质检 0：无录音质检，表示API指示不录音（即recordFlag取值为false）时进行的质检 1：有录音质检，表示API指示要录音（即recordFlag取值为true）时进行的质检 recordFileDownloadUrl 否 String(1-1024) 录音文件下载地址，可通过该URL在浏览器中下载录音文件。 说明： 使用该参数的场景请联系华为云客服获取。 areaCode 否 String(0-32) 隐私保护号码（X号码）的城市码。 说明： 使用该参数的场景请联系华为云客服获取。 callDuration 否 Integer 呼叫的通话时长，单位为秒。 说明： 使用该参数的场景请联系华为云客服获取。 userData 否 String(1-256) 用户自定义数据。 若客户在调用AXYB模式绑定接口时携带了“userData”，对应此呼叫事件的通知消息中都会携带此参数。 接口示例 POST /fee HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: 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"}]}

使用说明 前提条件 客户添加应用时需设置呼叫话单接收地址，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。 注意事项 若平台给客户推送话单后未收到成功响应，视为推送失败，平台会重新推送话单，直至客户返回成功响应。平台最多重推6次，分别于1分钟、4分钟、9分钟、106分钟、203分钟和300分钟后重推。 若没有收到平台推送请参考收不到呼叫事件和话单通知如何处理？ 使用限制 业务平台推送话单信息给开发者应用，仅支持POST方式。

使用说明 前提条件 客户添加应用时需设置呼叫状态接收地址，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。 如果需要单独接收呼入事件（callin），需联系客服，提供呼入事件状态接收地址。 注意事项 若平台给客户推送呼叫事件通知后未收到成功响应，视为推送失败，平台会重新推送呼叫事件通知，直至客户返回成功响应。平台最多重推6次，分别于1分钟、4分钟、9分钟、106分钟、203分钟和300分钟后重推。 若没有收到平台推送请参考收不到呼叫事件和话单通知如何处理？ 使用限制 业务平台推送呼叫状态给开发者应用，仅支持POST方式。

请求参数 AXYB模式中，A和B通过X和Y号码形成绑定关系，使用隐私号码X和Y互相通讯（A拨打Y，接通B；B拨打X，接通A）。 以下流程和接口示例以B拨打X，呼叫通过Y转接至A，A用户接听为例，流程和接口示例仅供参考，请以实际消息为准。 图1 AXYB业务流程 表2 请求Headers参数说明 参数名称 是否必选 参数类型 说明 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="随机数生成时间"。 PasswordDigest：根据PasswordDigest = Base64 (HMAC-SHA256 (Password，Nonce + Created))生成。其中，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(枚举) 该参数标识通知的事件类型。 取值范围如下： callin：呼入事件 callout：呼出事件 alerting：振铃事件 answer：应答事件 disconnect：挂机事件 statusInfo 否 CallStatusInfo 呼叫状态事件的信息。 当eventType参数为callin、callout、alerting、answer、disconnect时携带。 callin：呼入事件 callout：呼出事件 alerting：振铃事件 answer：应答事件 disconnect：挂机事件 CallStatusInfo定义 表5 callin：呼入事件 参数名称 是否必选 参数类型 说明 timestamp 是 String(1-128) 该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。 sessionId 是 String(1-256) 唯一指定一条通话链路的标识ID。 caller 否 String(1-32) 主叫号码。 号码为全局号码格式（包含国家码），如+86138****0021。 说明： 呼入事件的主叫号码为B号码。 called 否 String(1-32) 被叫号码。 说明： 呼入事件的被叫号码为X号码。 subscriptionId 否 String(1-64) 绑定ID。 userData 否 String(1-256) 用户自定义数据。 说明： 使用该参数的场景请联系华为云客服获取。 接口示例 POST /status HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx {"eventType":"callin","statusInfo":{"sessionId":"1200_1029_4294967295_20190123091514@callenabler246.huaweicaas.com","timestamp":"2019-01-23 09:15:14","caller":"+86138****0021","called":"+86138****0022","subscriptionId":"****"}} 表6 callout：呼出事件 参数名称 是否必选 参数类型 说明 timestamp 是 String(1-128) 该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。 sessionId 是 String(1-256) 唯一指定一条通话链路的标识ID。 caller 否 String(1-32) 主叫号码。 号码为全局号码格式（包含国家码），如+86138****0021。 说明： 呼出事件的主叫号码为Y号码。 called 否 String(1-32) 被叫号码。 说明： 呼出事件的被叫号码为A号码。 subscriptionId 否 String(1-64) 绑定ID。 userData 否 String(1-256) 用户自定义数据。 若客户在调用AXYB模式绑定接口时携带了“userData”，对应此呼叫事件的通知消息中都会携带此参数。 接口示例 POST /status HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx{"eventType":"callout","statusInfo":{"sessionId":"1200_1029_4294967295_20190123091514@callenabler246.huaweicaas.com","timestamp":"2019-01-23 09:15:15","caller":"+86138****0021","called":"+86138****7021","subscriptionId":"****"}} 表7 alerting：振铃事件 参数名称 是否必选 参数类型 说明 timestamp 是 String(1-128) 该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。 sessionId 是 String(1-256) 唯一指定一条通话链路的标识ID。 caller 否 String(1-32) 主叫号码。 号码为全局号码格式（包含国家码），如+86138****0021。 说明： 振铃事件的主叫号码为Y号码。 called 否 String(1-32) 被叫号码。 说明： 振铃事件的被叫号码为A号码。 subscriptionId 否 String(1-64) 绑定ID。 userData 否 String(1-256) 用户自定义数据。 若客户在调用AXYB模式绑定接口时携带了“userData”，对应此呼叫事件的通知消息中都会携带此参数。 接口示例 POST /status HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx {"eventType":"alerting","statusInfo":{"sessionId":"1200_1029_4294967295_20190123091514@callenabler246.huaweicaas.com","timestamp":"2019-01-23 09:15:16","caller":"+86138****0021","called":"+86138****7021","subscriptionId":"****"}} 表8 answer：应答事件 参数名称 是否必选 参数类型 说明 timestamp 是 String(1-128) 该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。 sessionId 是 String(1-256) 唯一指定一条通话链路的标识ID。 caller 否 String(1-32) 主叫号码。 号码为全局号码格式（包含国家码），如+86138****0021。 说明： 应答事件的主叫号码为Y号码。 called 否 String(1-32) 被叫号码。 说明： 应答事件的被叫号码为A号码。 subscriptionId 否 String(1-64) 绑定ID。 userData 否 String(1-256) 用户自定义数据。 若客户在调用AXYB模式绑定接口时携带了“userData”，对应此呼叫事件的通知消息中都会携带此参数。 接口示例 POST /status HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx {"eventType":"answer","statusInfo":{"sessionId":"1200_1029_4294967295_20190123091514@callenabler246.huaweicaas.com","timestamp":"2019-01-23 09:15:36","caller":"+86138****0021","called":"+86138****7021","subscriptionId":"****"}} 表9 disconnect：挂机事件 参数名称 是否必选 参数类型 说明 timestamp 是 String(1-128) 该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。 sessionId 是 String(1-256) 唯一指定一条通话链路的标识ID。 caller 否 String(1-32) 主叫号码。 号码为全局号码格式（包含国家码），如+86138****0021。 说明： 此处返回号码非真实主被叫号码，真实主被叫号码请以fee事件中的返回值为准。 called 否 String(1-32) 被叫号码。 说明： 此处返回号码非真实主被叫号码，真实主被叫号码请以fee事件中的返回值为准。 stateCode 否 Integer 通话挂机的原因值，仅当eventType为disconnect时携带。 取值范围及表示的含义请参考通话挂机原因值说明。 stateDesc 否 String(1-128) 通话挂机的原因值的描述，仅当eventType为disconnect时携带。 subscriptionId 否 String(1-64) 绑定ID。 userData 否 String(1-256) 用户自定义数据。 若客户在调用AXYB模式绑定接口时携带了“userData”，对应此呼叫事件的通知消息中都会携带此参数。 接口示例 POST /status HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx{"eventType":"disconnect","statusInfo":{"sessionId":"1200_1029_4294967295_20190123091514@callenabler246.huaweicaas.com","timestamp":"2019-01-23 09:16:41","caller":"+86138****0021","called":"+86138****7021","stateCode":0,"stateDesc":"The user releases the call.","subscriptionId":"****"}}

请求参数 AXB模式中，A和B通过X号码形成绑定关系，使用隐私号码X互相通讯。 以下流程和接口示例以A拨打X，呼叫转接至B，B用户接听为例，流程和接口示例仅供参考，请以实际消息为准。 图1 AXB业务流程 表2 请求Headers参数说明 参数名称 是否必选 参数类型 说明 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="随机数生成时间"。 PasswordDigest：根据PasswordDigest = Base64 (HMAC-SHA256 (Password，Nonce + Created))生成。其中，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(枚举) 该参数标识通知的事件类型。 取值范围如下： callin：呼入事件 callout：呼出事件 alerting：振铃事件 answer：应答事件 disconnect：挂机事件 statusInfo 否 CallStatusInfo 呼叫状态事件的信息。 当eventType参数为callin、callout、alerting、answer、disconnect时携带。 callin：呼入事件 callout：呼出事件 alerting：振铃事件 answer：应答事件 disconnect：挂机事件 CallStatusInfo定义 表5 callin：呼入事件 参数名称 是否必选 参数类型 说明 timestamp 是 String(1-128) 该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。 sessionId 是 String(1-256) 唯一指定一条通话链路的标识ID。 caller 否 String(1-32) 主叫号码。 号码为全局号码格式（包含国家码），如+86138****0021。 说明： 呼入事件的主叫号码为A号码。 called 否 String(1-32) 被叫号码。 说明： 呼入事件的被叫号码为X号码。 subscriptionId 否 String(1-64) 绑定ID。 userData 否 String(1-256) 用户附属信息。 说明： 使用该参数的场景请联系华为云客服获取。 接口示例 POST /status HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"Content-Length: xx {"eventType":"callin","statusInfo":{"sessionId":"1200_1029_4294967295_20190123091514@callenabler246.huaweicaas.com","timestamp":"2019-01-23 09:15:14","caller":"+86138****0021","called":"+86138****0022","subscriptionId":"****"}} 表6 callout：呼出事件 参数名称 是否必选 参数类型 说明 timestamp 是 String(1-128) 该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。 sessionId 是 String(1-256) 唯一指定一条通话链路的标识ID。 caller 否 String(1-32) 主叫号码。 号码为全局号码格式（包含国家码），如+86138****0021。 说明： 呼出事件的主叫号码为X号码。 called 否 String(1-32) 被叫号码。 说明： 呼出事件的被叫号码为B号码。 subscriptionId 否 String(1-64) 绑定ID。 userData 否 String(1-256) 用户附属信息。 当客户在AXB模式绑定接口、AXB模式绑定信息修改接口中携带了“userData”时，对应此呼叫事件的通知消息中都会携带此参数。 接口示例 POST /status HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx{"eventType":"callout","statusInfo":{"sessionId":"1200_1029_4294967295_20190123091514@callenabler246.huaweicaas.com","timestamp":"2019-01-23 09:15:15","caller":"+86138****0021","called":"+86138****7021","subscriptionId":"****"}} 表7 alerting：振铃事件 参数名称 是否必选 参数类型 说明 timestamp 是 String(1-128) 该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。 sessionId 是 String(1-256) 唯一指定一条通话链路的标识ID。 caller 否 String(1-32) 主叫号码。 号码为全局号码格式（包含国家码），如+86138****0021。 说明： 振铃事件的主叫号码为X号码。 called 否 String(1-32) 被叫号码。 说明： 振铃事件的被叫号码为B号码。 subscriptionId 否 String(1-64) 绑定ID。 userData 否 String(1-256) 用户附属信息。 当客户在AXB模式绑定接口、AXB模式绑定信息修改接口中携带了“userData”时，对应此呼叫事件的通知消息中都会携带此参数。 接口示例 POST /status HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx{"eventType":"alerting","statusInfo":{"sessionId":"1200_1029_4294967295_20190123091514@callenabler246.huaweicaas.com","timestamp":"2019-01-23 09:15:16","caller":"+86138****0021","called":"+86138****7021","subscriptionId":"****"}} 表8 answer：应答事件 参数名称 是否必选 参数类型 说明 timestamp 是 String(1-128) 该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。 sessionId 是 String(1-256) 唯一指定一条通话链路的标识ID。 caller 否 String(1-32) 主叫号码。 号码为全局号码格式（包含国家码），如+86138****0021。 说明： 应答事件的主叫号码为X号码。 called 否 String(1-32) 被叫号码。 说明： 应答事件的被叫号码为B号码。 subscriptionId 否 String(1-64) 绑定ID。 userData 否 String(1-256) 用户附属信息。 当客户在AXB模式绑定接口、AXB模式绑定信息修改接口中携带了“userData”时，对应此呼叫事件的通知消息中都会携带此参数。 接口示例 POST /status HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx{"eventType":"answer","statusInfo":{"sessionId":"1200_1029_4294967295_20190123091514@callenabler246.huaweicaas.com","timestamp":"2019-01-23 09:15:36","caller":"+86138****0021","called":"+86138****7021","subscriptionId":"****"}} 表9 disconnect：挂机事件 参数名称 是否必选 参数类型 说明 timestamp 是 String(1-128) 该呼叫事件发生时隐私保护通话平台的UNIX时间戳。 该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。 sessionId 是 String(1-256) 唯一指定一条通话链路的标识ID。 caller 否 String(1-32) 主叫号码。 号码为全局号码格式（包含国家码），如+86138****0021。 说明： 此处返回号码非真实主被叫号码，真实主被叫号码请以fee事件中的返回值为准。 called 否 String(1-32) 被叫号码。 说明： 此处返回号码非真实主被叫号码，真实主被叫号码请以fee事件中的返回值为准。 stateCode 否 Integer 通话挂机的原因值，仅当eventType为disconnect时携带。 取值范围及表示的含义请参考通话挂机原因值说明。 stateDesc 否 String(1-128) 通话挂机的原因值的描述，仅当eventType为disconnect时携带。 subscriptionId 否 String(1-64) 绑定ID。 userData 否 String(1-256) 用户附属信息。 当客户在AXB模式绑定接口、AXB模式绑定信息修改接口中携带了“userData”时，对应此呼叫事件的通知消息中都会携带此参数。 接口示例 POST /status HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx {"eventType":"disconnect","statusInfo":{"sessionId":"1200_1029_4294967295_20190123091514@callenabler246.huaweicaas.com","timestamp":"2019-01-23 09:16:41","caller":"+86138****0021","called":"+86138****7021","stateCode":0,"stateDesc":"The user releases the call.","subscriptionId":"****"}}

使用说明 前提条件 客户添加应用时需设置呼叫状态接收地址，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。 如果需要单独接收呼入事件（callin），需联系客服，提供呼入事件状态接收地址。 注意事项 若平台给客户推送呼叫事件通知后未收到成功响应，视为推送失败，平台会重新推送呼叫事件通知，直至客户返回成功响应。平台最多重推6次，分别于1分钟、4分钟、9分钟、106分钟、203分钟和300分钟后重推。 若没有收到平台推送请参考收不到呼叫事件和话单通知如何处理？ 使用限制 业务平台推送呼叫状态给开发者应用，仅支持POST方式。

接口示例 接口示例仅供参考，请以实际消息为准。 请求示例 GET /rest/provision/voice/record/v1.0?fileName=****.wav&recordDomain=huawei HTTP1.1 content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx 响应示例 HTTP/1.1 301 Moved Permanently Location: http://**** Connection: close Content-Length: 0

使用说明 前提条件 已通过“话单通知API”获取了录音文件名（fileName）和录音文件存储的服务器域名（recordDomain）（不同的录音文件的fileName和recordDmain不同，这两个参数用来区分隐私保护通话平台保存的录音文件）。 注意事项 录音文件在平台只保存七天（隐私保护通话平台给客户服务器推送话单后开始计时），超过七天平台会自动删除该录音文件。请在七天期限内调用该接口获取下载地址并下载录音。 隐私保护通话平台给客户服务器推送话单七天之后再调用此接口获取下载地址，会返回“The record does not exist.”错误。 建议调用该接口时把connection设置为不支持重定向，再从Location头域中获取到录音文件的下载地址，具体操作可参考开发指南中编程语言的代码样例。

请求参数 表2 请求URL参数说明 参数名称 是否必选 参数类型 说明 fileName 是 String(1-128) 录音文件名。通过“话单通知接口”的recordObjectName参数获取。 recordDomain 是 String(1-128) 录音文件存储的服务器域名，通过“话单通知API”的recordDomain参数获取。 表3 请求Headers参数说明 参数名称 是否必选 参数类型 说明 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="随机数生成时间"。 PasswordDigest：根据PasswordDigest = Base64 (HMAC-SHA256 (Password，Nonce + Created))生成。其中，Password为APP_Secret的值。Nonce、Created、Password直接进行字符串拼接即可，无需包含+号和空格。 Nonce：客户发送请求时生成的一个随机数，长度为1~128位，可包含数字和大小写字母。例如：66C92B11FF8A425FB8D4CCFE0ED9ED1F。 Created：随机数生成时间。采用标准UTC格式，例如：2018-02-12T15:30:20Z。不同编程语言中的时间格式转换方式不同，部分语言可参考表4。 表4 不同编程语言的时间格式 编程语言 时间格式 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()转换后的时间格式去除毫秒后即为本接口要求的时间格式。

结果码说明 表7 响应结果码 响应码 结果码 英文描述 中文描述 处理方法 301 - - - 成功响应，请从Location头域中获取录音文件下载地址。 400 1023006 Authorization not contained in the HTTP header. HTTP消息头未找到Authorization字段。 请检查HTTP消息头中是否携带了Authorization字段。 1023007 realm not contained in Authorization. Authorization字段中未找到realm属性。 请检查Authorization字段中的是否携带了realm属性。 1023008 profile not contained in Authorization. Authorization字段中未找到profile属性。 请检查Authorization字段中的是否携带了profile属性。 1023009 The value of realm in Authorization must be SDP. Authorization中realm属性值应该为“SDP”。 请检查Authorization字段中的realm属性值是否为“SDP”。 1023010 The value of profile in Authorization must be UsernameToken. Authorization中profile属性值应该为“UsernameToken”。 请检查Authorization字段中的profile属性值是否为“UsernameToken”。 1023011 The value of type in Authorization must be app_key. Authorization中type属性值应该为“Appkey”。 请检查Authorization字段中的type属性值是否为“Appkey”。 1023012 type not contained in Authorization. Authorization字段中未找到type属性。 请检查Authorization字段中是否携带了type属性。 1023033 HTTP header not found X-AKSK field. HTTP头未找到X-AKSK字段。 请检查HTTP消息头中是否携带了X-AKSK字段。 1023034 UserName not contained in X-AKSK. X-AKSK字段中未找到UserName属性。 请检查X-AKSK字段中的是否携带了Username属性。 1023035 Nonce not contained in X-AKSK. X-AKSK字段中未找到Nonce属性。 请检查X-AKSK字段中的是否携带了Nonce属性。 1023036 Created not contained in X-AKSK. X-AKSK字段中未找到Created属性。 请检查X-AKSK字段中的是否携带了Created属性。 1023037 PasswordDigest not contained in X-AKSK. X-AKSK字段中未找到PasswordDigest属性。 请检查X-AKSK字段中的是否携带了PasswordDigest属性。 1023038 UsernameToken not contained in X-AKSK. X-AKSK中没有携带UsernameToken。 请检查X-AKSK字段中的是否携带了UsernameToken属性。 401 1010010 Invalid digest. PasswordDigest校验失败。 请检查PasswordDigest字段填写是否正确。 1010013 Time out limit. 时间超出限制。 请确认X-AKSK鉴权时，生成随机数的时间与发送请求时的本地时间不能相差太大（具体差值请与管理员确认）。 403 1010002 Invalid request. 无效请求。 参考各接口参数说明，检查请求携带的参数格式是否正确，如以下参数格式问题： 绑定接口填写的号码参数需为全局号码格式，如+86138****0001或+8675528****01； 放音文件需上传通过审核才可通过接口调用，点击查看如何上传审核。 参考接口参数说明，检查是否携带了不能同时携带的参数，如AXE模式绑定接口不能同时携带callbackTone和callbackNum，若是，请保留一个； 参数长度或格式是否错误，如AXE模式分机号长度或timeUnit的格式是否正确。 1010003 Invalid app_key. 无效的app_key。 请检查请求携带的app_key填写是否正确。 1010008 The status of the app_key is unavailable. app_key状态异常。 请检查请求携带的app_key所属应用状态是否正常。 1011006 Under traffic control status 请求者（IP、手机号码）处于流控状态下。 请稍等一分钟再试。 1012012 Application does not open recording function. 应用未开启录音功能。 请确认app_key所属的应用是否开启了录音功能。 1012007 The record does not exist. 记录不存在。 请确认fileName参数的填写是否正确。 1020166 The app client ip is not in ip white list. 对端app IP不在白名单列表中。 联系管理员检查IP白名单是否配置正确。 1020176 Authentication failed, try again later 鉴权失败，稍后重试 IP因鉴权失败次数过多导致被拉黑，请30分钟后重试，或联系管理员放通该IP。 500 1010001 Internal system error. 系统错误。 请联系管理员处理。 1023001 Internal error. 内部错误。 1023002 Response timeout. 响应超时。 重新发送一次请求，若依然返回响应超时，请联系管理员处理。

使用说明 前提条件 客户添加应用时需设置呼叫状态接收地址并启用推送X号码状态功能，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。 注：若需单独接收X号码状态通知，需填写X号码状态接收地址。若呼叫状态接收地址和X号码状态接收地址都填写了，隐私保护通话平台会向呼叫状态接收地址推送呼叫事件通知，向X号码状态接收地址推送X号码状态通知。 使用限制 业务平台推送呼叫状态给开发者应用，仅支持POST方式。

请求参数 表2 请求Headers参数说明 参数名称 是否必选 参数类型 说明 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="随机数生成时间"。 PasswordDigest：根据PasswordDigest = Base64 (HMAC-SHA256 (Password，Nonce + Created))生成。其中，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(枚举) 该参数标识通知的事件类型。 取值范围如下： numStatus：X号码状态变化 numInfo 否 numInfo [1-100] X号码状态变化事件的信息，参数取值为列表，最大100条。 当eventType参数为numStatus时携带。 表5 numInfo定义 参数名称 是否必须 参数类型 说明 number 是 String 状态变化的X号码。 status 是 String 号码状态。 5：正常 9：暂停 10：不可用 11：冻结绑定 说明： 各号码状态对业务的影响如下： 正常：无影响。 暂停&不可用：绑定、呼叫和短信都不可用。 冻结绑定：号码不可新增绑定关系，但已存在的绑定关系的呼叫和短信业务不受影响。 cause 否 String 号码不可用原因。仅status为不可用时携带。 1：号码已删除 2：欠费 3：停机 5：X号码被运营商限呼 6：X号码限呼恢复 7：X号码开通了无条件前转业务 8：X号码开通了无应答前转业务 9：X号码开通了被叫忙前转业务 接口示例 POST /Xnumber/status HTTP/1.1Content-Length: 94content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"{"eventType":"numStatus","numInfo":[{"number":"+86156****0000","status":"9"}]}

接口示例 请求示例 PUT /rest/caas/extendnumber/v1.0 HTTP1.1 content-type: application/json;charset=UTF-8 authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx { "subscriptionId":"******","callbackNum":"+86170****0021"} 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Content-Length: xx { "resultcode":"0", "resultdesc":"Success"}

结果码说明 表6 响应结果码 响应码 结果码 英文描述 中文描述 处理方法 200 0 Success. 成功。 - 400 1023006 Authorization not contained in the HTTP header. HTTP消息头未找到Authorization字段。 请检查HTTP消息头中是否携带了Authorization字段。 1023007 realm not contained in Authorization. Authorization字段中未找到realm属性。 请检查Authorization字段中的是否携带了realm属性。 1023008 profile not contained in Authorization. Authorization字段中未找到profile属性。 请检查Authorization字段中的是否携带了profile属性。 1023009 The value of realm in Authorization must be SDP. Authorization中realm属性值应该为“SDP”。 请检查Authorization字段中的realm属性值是否为“SDP”。 1023010 The value of profile in Authorization must be UsernameToken. Authorization中profile属性值应该为“UsernameToken”。 请检查Authorization字段中的profile属性值是否为“UsernameToken”。 1023011 The value of type in Authorization must be app_key. Authorization中type属性值应该为“Appkey”。 请检查Authorization字段中的type属性值是否为“Appkey”。 1023012 type not contained in Authorization. Authorization字段中未找到type属性。 请检查Authorization字段中是否携带了type属性。 1023033 HTTP header not found X-AKSK field. HTTP头未找到X-AKSK字段。 请检查HTTP消息头中是否携带了X-AKSK字段。 1023034 UserName not contained in X-AKSK. X-AKSK字段中未找到UserName属性。 请检查X-AKSK字段中的是否携带了Username属性。 1023035 Nonce not contained in X-AKSK. X-AKSK字段中未找到Nonce属性。 请检查X-AKSK字段中的是否携带了Nonce属性。 1023036 Created not contained in X-AKSK. X-AKSK字段中未找到Created属性。 请检查X-AKSK字段中的是否携带了Created属性。 1023037 PasswordDigest not contained in X-AKSK. X-AKSK字段中未找到PasswordDigest属性。 请检查X-AKSK字段中的是否携带了PasswordDigest属性。 1023038 UsernameToken not contained in X-AKSK. X-AKSK中没有携带UsernameToken。 请检查X-AKSK字段中的是否携带了UsernameToken属性。 401 1010010 Invalid digest. PasswordDigest校验失败。 请检查PasswordDigest字段填写是否正确。 1010013 Time out limit. 时间超出限制。 请确认X-AKSK鉴权时，生成随机数的时间与发送请求时的本地时间不能相差太大（具体差值请与管理员确认）。 403 1010002 Invalid request. 无效请求。 请检查请求携带的参数格式是否都合法。 例如： 检查是否同时携带callbackTone和callbackNum，若是，请保留一个。 检查timeUnit是否格式错误，若是，请填写正确格式。 1010003 Invalid app_key. 无效的app_key。 请检查请求携带的app_key填写是否正确。 1010008 The status of the app_key is unavailable. app_key状态异常。 请联系管理员确认该app_key状态是否正常。 1010010 The flow control upper limit is reached on the platform. 平台达到系统流控上限。 请稍等一分钟后再试。 1010029 The subscriber status is frozen. 用户账号已冻结。 查看账户是否欠费。如欠费需充值后才能继续使用。 若未欠费，请联系华为云客服处理。 1010040 The app_key is not allowed to invoke the API. app_key没有调用本API的权限。 调用的接口和app_key所属的应用模式不一致。如添加应用时选择的AXB模式的应用，调用接口时只能调用AXB模式的接口，不能调用其他模式的接口。 1016001 The record does not exist. 记录不存在 绑定关系不存在，请检查virtualNum，extendNum或subscriptionId的填写是否正确。 1012001 Resource of number is not to be applied. 资源未申请 携带的app_key和X号码没有绑定关系，请检查携带的X号码是否属于该应用。 1020166 The app client ip is not in ip white list. 对端app IP不在白名单列表中。 联系管理员检查IP白名单是否配置正确。 1020167 No idle extend Number. 没有空闲的分机号。 出现该错误码表示调用AXE模式绑定接口时指定的分机号（extendNum）已被占用，请重新指定分机号。 1020176 Authentication failed, try again later 鉴权失败，稍后重试 IP因鉴权失败次数过多导致被拉黑，请30分钟后重试，或联系管理员放通该IP。 1020178 The transparent mode is not allowed. 不允许显示真实主叫号码。 您的应用不支持显示真实主叫号码，请修改displayNumMode参数的取值为“0”（显示X号码）后再次绑定。 500 1010001 Internal system error. 系统错误。 请联系客服处理。 1023001 Internal error. 内部错误。 1023002 Response timeout. 响应超时。 重新发送一次请求，若依然返回响应超时，请联系管理员处理。