接口示例 接口示例仅供参考，请以实际消息为准。 请求示例 POST /notify 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 { "appKey":"****", "smsEvent":{"smsIdentifier":"********", "notificationMode":"Notify", "calling":"+86138****0001", "virtualNumber":"+86138****0000", "event":"Text SMS ", "timeStamp":"2020-12-23T09:06:16.450Z", "extInfo":{"extParas":[{"key":"splitNum","value":"0"},{"key":"direction","value":"2"}]}, "sendResult":2 } } 响应示例 请求为Notify模式时 HTTP/1.1 200 OK

请求参数 表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参数说明 参数名称 是否必选 参数类型 说明 appKey 是 String(1-32) 隐私保护通话 应用的APP_Key。 smsEvent 是 SMSEventInfoType 短信状态事件。 表5 SMSEventInfoType定义 参数名称 是否必选 参数类型 说明 smsIdentifier 是 String(1-64) 短信唯一标识。 若用户发送的是长短信，隐私保护通话平台会将长短信的多个分片合并为一个通知上报。 notificationMode 是 String(1-8) 通知模式： Notify：通知模式。 calling 否 String(1-32) 真实发送方号码。 号码为全局号码格式（包含国家码），比如+86138****7021。 called 否 String(1-32) 真实接收方号码。 仅在隐私保护通话平台转发短信成功后携带。 号码为全局号码格式（包含国家码），比如+86138****7022。 virtualNumber 否 String(1-32) X号码。 号码为全局号码格式（包含国家码），比如+86138****0001。 event 是 String(1-16) 短信状态事件。 TextSMS：文本短信 timeStamp 是 String(1-32) 短信事件发生的系统时间戳，UTC时间。 格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' 其中SSS是毫秒，“T”和“Z”为固定字符。 extInfo 是 ExtensionInfoType 拓展信息。 subscriptionId 否 String(1-64) 绑定ID。 smsContent 否 String(1-2000) 用户发送的短信内容。 请参考如何设置才能收到短信内容？开通该功能。 sendResult 是 Integer 发送结果。 0：成功 1：因用户账户冻结，发送失败。 2：因绑定关系不存在，发送失败。 3：因X号码被暂停，发送失败。 4：非商用APP，发送失败。 5：因系统内部错误，发送失败。 8：黑名单管控，发送失败。 9：部分发送成功。 10：全部发送失败。 11：X号码不支持短信能力。 12：短信内容不包含特征关键词。 13：短信内容包含禁止词汇。 areaCode 否 String(0-32) 隐私保护号码（X号码）的城市码。 说明： 使用该参数的场景请联系华为云客服获取。 userData 否 String(1-256) 用户附属信息。 说明： 使用该参数的场景请联系华为云客服获取。 表6 ExtensionInfoType定义 参数名称 是否必选 参数类型 说明 extParas 是 JsonArray 扩展信息(Key-Value)列表。 格式如下： "extParas": [{"key": "splitNum","value": "value1"},{"key": "direction","value": "value2"}] Key、Value取值分别不能超过32个字节。 “key”取值为“splitNum”时表示实际短信发送成功数量，即长短信拆分后的短信数量。value1表示“splitNum”的取值。 “key”取值为“direction”时表示短信发送方向。value2表示“direction”取值，含义如下： 0：B发送短信给A。 1：A发送短信给B。 2：异常场景无法获取发送方向。

接口示例 接口示例仅供参考，请以实际消息为准。 请求示例 POST /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 { "callerNum":"+86138****0021", "relationNum":"+86138****6666", "calleeNum":"+86138****0023", "callDirection":0, "duration":0, "preVoice": { "callerHintTone": "callerHintTone.wav", "calleeHintTone": "calleeHintTone.wav" }, "maxDuration":0 } 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Content-Length: xx { "resultcode":"0", "resultdesc":"Success" , "subscriptionId":"****", "relationNum":"+86138****6666", "callDirection":0, "duration":0, "maxDuration":0 }

结果码说明 表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填写是否正确。 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模式的接口，不能调用其他模式的接口。 1012001 Resource of number is not to be applied. 资源未申请。 携带的app_key和X号码没有绑定关系，请检查携带的X号码是否属于该应用。 1012007 The record does not exist. 记录不存在。 指定的X号码不存在，请检查relationNum参数的填写是否正确。 1012008 Insufficient number of resources 资源不足。 没有可分配的X号码，请申请新的号码资源或修改areaCode的值。点击查看处理方法 1012009 Maximum number of resources has been exceeded 指定的X号码的绑定数量已达到上限。 一个X号码只能同时绑定5000对关系。请修改relationNum的值，或者解除指定的X号码上的部分绑定关系。 1012010 The number $ has been bound. 绑定关系已存在。 出现该错误码表示调用AXB模式绑定接口时携带的X号码（relationNum）和A号码（callerNum）或B号码（calleeNum）已存在绑定关系，可确认后更换其他X号码进行绑定。 1012012 Application does not open recording function. 应用未开启录音功能。 请确认app_key所属的应用是否开启了录音功能，点击查看如何开启录音功能。 1012102 The number status is abnormal. 号码状态异常。 出现该错误码表示调用接口时指定的X号码因投诉或号码状态异常被隐私保护通话平台加入了黑名单，请查看订购号码时填写的邮箱是否有业务下线通知邮件，如果没有，请拨打400电话联系华为云客服处理。 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. 响应超时。 重新发送一次请求，若依然返回响应超时，请联系管理员处理。

响应参数 表6 响应结果参数 参数名称 是否必选 参数类型 说明 resultcode 是 String(1-32) 请求返回的结果码。 resultdesc 是 String(1-256) 操作结果描述。 subscriptionId 否 String(1-64) 绑定ID，唯一标识一组绑定关系。成功响应时必定返回。请记录该ID用于后续接口调用。 relationNum 否 String(1-32) 绑定的X号码。 成功响应时必定返回。 callDirection 否 Integer 绑定关系允许的呼叫方向，取值含义参见请求参数。 成功响应时必定返回。 duration 否 Integer 绑定关系保持时间，单位为秒，0表示永不过期。 成功响应时必定返回。 maxDuration 否 Integer 允许单次通话进行的最长时间，通话时间从被叫接通的时刻开始计算，0表示系统不主动结束通话。 成功响应时必定返回。 userData 否 String(1-256) 用户自定义数据。 当请求中携带且成功响应时必定返回。

请求参数 表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参数说明 参数名称 是否必选 参数类型 说明 callerNum 是 String(4-31) AXB中的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号码都必须是手机号码。 relationNum 否 String(4-31) 指定已申请到的X号码进行绑定。 可在隐私保护通话控制台的“号码管理”页面或订购号码成功后返回的号码表中查看已申请到的X号码。 填写为全局号码格式（国家码+11位数字的手机号码），如：+86138****0021。 当callerNum（A号码）是手机号码时： 同时携带relationNum和areaCode时系统以relationNum为准。 当relationNum和areaCode都未携带时，隐私保护通话平台会从客户应用下已申请到的X号码中，优先选择与A号码同城市的X号码进行绑定。 当callerNum（A号码）是固话号码时： 该参数与areaCode是二选一关系。 同时携带relationNum和areaCode时系统以relationNum为准。 areaCode 否 String(0-32) 指定城市码，由隐私保护通话平台从客户已申请到的X号码中选择可用号码进行绑定。 填写为标准格式的城市码，如：0755、010等。 X号码对应城市码可在订购号码成功后返回的号码表中查看，点击查看如何下载号码表。 当callerNum（A号码）是手机号码时： 同时携带relationNum和areaCode时系统以relationNum为准。 当relationNum和areaCode都未携带时，隐私保护通话平台会从客户应用下已申请到的X号码中，优先选择与A号码同城市的X号码进行绑定。 当callerNum（A号码）是固话号码时： 该参数与relationNum是二选一关系。 同时携带relationNum和areaCode时系统以relationNum为准。 areaMatchMode 否 String(枚举) 号码筛选方式。当指定areaCode或根据callerNum（A号码）区号选择X号码（relationNum和areaCode都不携带）时，此参数生效。 当指定areaCode时： 0：严格匹配，应用下无对应areaCode的X号码时，号码分配失败。 1：非严格匹配，应用下无对应areaCode的X号码时，会优先选择该应用下与areaCode对应区域同省份的号码，若也没有同省份的号码，则从该应用下全部X号码中随机选择。 根据A号码区号选择X号码时： 0：严格匹配，应用下没有和A号码同区域的X号码时，号码分配失败。 1：非严格匹配，应用下没有和A号码同区域的X号码时，会优先选择该应用下与A号码所属区域同省份的号码，若也没有同省份的号码，则从该应用下全部X号码中随机选择。 不携带该参数时，系统默认为严格匹配模式。 calleeNum 是 String(4-31) AXB中的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天）。 绑定关系过期后会被系统自动解除。 如果不携带该参数或携带为0，系统默认永不过期。 recordFlag 否 String(枚举) 是否需要针对该绑定关系产生的所有通话录音。 false：表示不录音 true：表示录音。 该参数仅当客户添加应用时申请开通了录音功能才有效。 如果不携带该参数，系统默认不录音。 recordHintTone 否 String(1-128) 该参数仅在recordFlag为true时有效。 该参数用于设置录音提示音，填写为放音文件名，可在放音文件管理页面查看。 不携带该参数表示录音前不播放提示音。 说明： 因隐私协议及运营商管控，录音的呼叫必须携带该参数，否则呼叫会被运营商拦截。 preVoice 否 ApiPlayInfo 设置个性化通话前等待音，即主叫听到的回铃音。 maxDuration 否 Integer 设置允许单次通话进行的最长时间，单位为分钟。通话时间从接通被叫的时刻开始计算。 取值范围：0~1440 0：系统不主动结束通话，由主被叫双方结束通话。 1~1440：当通话时长达到此配置值，系统主动结束通话。 不携带时，参数值默认为0。 lastMinVoice 否 String(0-128) 设置通话剩余最后一分钟时的提示音，填写为放音文件名，可在放音文件管理页面查看。 当maxDuration字段设置为非0时此参数有效。 不携带该参数表示通话剩余最后一分钟时不放音。 privateSms 否 String(枚举) 设置该绑定关系是否支持短信功能。 若客户添加应用时未开通短信功能，请勿携带此参数。 取值范围： false：不支持短信 true：支持短信 如果客户添加应用时开通了短信功能，不携带该参数时系统默认支持短信。 userData 否 String(1-256) 用户自定义数据。 不允许携带以下字符：“^”，“{”，“}”。 不允许包含中文字符，如果包含中文字符请采用Base64编码。 说明： 若在设置绑定关系时携带该参数，绑定关系对应的呼叫、话单和短信通知消息中也会携带该参数。 表5 ApiPlayInfo定义 参数名称 是否必选 参数类型 说明 callerHintTone 否 String(0-128) 设置A拨打X号码时的通话前等待音，填写为放音文件名，可在放音文件管理页面查看。 不携带该参数时A会听到B的回铃音。 calleeHintTone 否 String(0-128) 设置B拨打X号码时的通话前等待音，填写为放音文件名，可在放音文件管理页面查看。 不携带该参数时B会听到A的回铃音。

使用说明 前提条件 已创建隐私保护通话应用，获取了APP_Key，APP_Secret和APP接入地址。 已申请到隐私保护号码。 若需要使用自定义放音，需要提前在放音文件管理页面上传并等待审核通过。 使用限制 1个X号码允许绑定5000对用户号码，但用户号码不可重复。例如，允许同时绑定AXB和CXD，但不允许同时绑定AXB和BXC。 注意事项 AXB模式支持设置AXB绑定关系时长（通过duration参数设置），绑定关系到期后自动解绑；还支持设置单次通话进行的最长时间（通过maxDuration参数设置），到期后系统自动挂断通话。 若要使用录音功能，需要完成以下两个步骤： 创建隐私保护通话应用时，“是否开通录音”选择“是”。 调用本接口设置归属该应用的隐私号码绑定关系时设置“recordFlag”为“true”。 注：如果是在控制台设置归属该应用的隐私号码绑定关系，需在设置绑定关系时勾选“支持录音”。 若要使用短信功能，需要完成以下三个步骤： 创建隐私保护通话应用时，“是否开通短信”选择“是”； 订购号码时，“是否需要短信功能”选择“是”； 调用本接口设置归属该应用的隐私号码绑定关系时不携带“privateSms”或设置“privateSms”为“true”。 注：如果是在控制台设置归属该应用的隐私号码绑定关系，需在设置绑定关系时勾选“支持短信”。

API请求地址 API请求地址由“APP接入地址”和“访问URI”组成，数据来源如下： 参数 来源 示例 APP接入地址 登录管理控制台，从隐私保护通话“应用管理”页面获取。 https://rtcpns.cn-north-1.myhuaweicloud.com 访问URI 从各API接口页面中的“接口类型说明”中获取。 AXB模式绑定接口：/rest/caas/relationnumber/partners/v1.0 综上，API请求地址示例如下： 设置AXB模式绑定关系 https://rtcpns.cn-north-1.myhuaweicloud.com/rest/caas/relationnumber/partners/v1.0