AX模式-华为云

隐私保护通话 PRIVATENUMBER-短信通知接口:响应参数

响应参数客户服务器接收到隐私保护通话平台的短信事件通知后，根据不同的模式返回不同响应消息。 Notify模式返回无消息体的200响应。 Block模式响应必须参照表7携带消息体，返回对短信事件的处理操作。表7 响应消息参数说明参数名称是否必选参数类型说明 actions 是 SMSActionType[] 短信操作指示。表8 SMSActionType定义参数名称是否必选参数类型说明 operation 是 String(1-32) 操作类型： vNumberRoute：转发短信。 DiscardMessage：丢弃短信。 message 否 MessageInfo 短信操作信息。仅当operation取值为“vNumberRoute”时有效。 extParas 否 JsonArray 预留参数，当前版本无需关注。 userData 否 String(1-256) 用户自定义数据。不允许携带以下字符：“{”，“}”（即大括号）。不允许包含中文字符，如果包含中文字符请采用Base64编码。说明：使用该参数的场景请联系华为云客服获取。表9 MessageInfo定义参数名称是否必选参数类型说明 called 否 String(1-64) 真实接收方号码。号码仅支持全局号码格式（包含国家码），比如+86138****7022。 calling 否 String(1-64) 真实发送方号码。和请求参数中的calling参数的取值保持一致。号码仅支持全局号码格式（包含国家码），比如+86138****7021。

隐私保护通话 PRIVATENUMBER AX模式

隐私保护通话 PRIVATENUMBER-短信通知接口:接口示例

接口示例接口示例仅供参考，请以实际消息为准。 notify模式请求示例 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":"TextSMS", "timeStamp":"2020-12-23T09:06:16.450Z", "extInfo":{"extParas":[{"key":"splitNum","value":"0"},{"key":"direction","value":"2"}]}, "sendResult":2 } } 响应示例 HTTP/1.1 200 OK Block模式请求示例 POST /block 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":"Block", "calling":"+86138****0001", "virtualNumber":"+86138****0000", "event":"TextSMS", "timeStamp":"2018-09-13T09:46:16.023Z", "extInfo":{"extParas":[{"key":"splitNum","value":"2"},{"key": "direction","value": "1"}]}, "sendResult":0 } } 响应示例 HTTP/1.1 200 OK Content-Type: application/JSON;charset=UTF-8 Content-Length: xx { "actions":[{ "operation":"vNumberRoute", "message":{"called":"+86138****0002", "calling":"+86138****0001" } }] }

隐私保护通话 PRIVATENUMBER AX模式

隐私保护通话 PRIVATENUMBER-短信通知接口:请求参数

请求参数表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：通知模式。 Block：控制模式。 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：因系统内部错误，发送失败。 6：SP指示丢弃，发送失败。 7：等待SP审核超时丢弃，发送失败。 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：其他用户发送短信给A。 1：A发送短信给其他用户。 2：异常场景无法获取发送方向。

隐私保护通话 PRIVATENUMBER AX模式

隐私保护通话 PRIVATENUMBER-短信通知接口:接口功能

接口功能隐私保护通话平台通过此接口向客户服务器推送隐私号短信通知。通知模式分为Notify和Block模式： Notify：通知模式，Notify模式的短信通知会被推送到客户添加应用时填写的短信通知地址，客户收到通知后返回HTTP状态码为200的空消息即可。 Block：控制模式，Block模式的短信通知会被推送到客户添加应用时填写的短信控制地址，客户收到通知后需按照Block模式响应参数返回响应，指示隐私保护通话平台转发或丢弃短信。 AX模式发送隐私号短信的流程如下： A发送短信给X，短信内容最后携带“@号码B”，如“@138****0021”（@必须是英文半角字符，号码B根据实际情况替换成真实用户号码，下同），隐私保护通话平台删除短信内容中的“@号码B”后将短信转发给B（发送方号码是X），并推送Notify模式的隐私号短信通知给客户服务器；若短信内容中未携带“@号码B”或携带的分隔符或号码格式错误，则隐私保护通话平台推送Block模式的隐私号短信通知给客户服务器，此时客户服务器必须返回响应参数对短信事件进行控制。隐私保护通话平台根据客户服务器返回的结果转发或丢弃隐私号短信；如果操作是转发，转发成功后推送Notify模式的隐私号短信通知给客户服务器。 B发送短信给X，隐私保护通话平台在短信最后添加“[From号码B]”后将短信转发给A（发送方号码是X），并推送Notify模式的隐私号短信通知给客户服务器。注：AX模式，A发送短信给X时需携带“@号码B”，“@号码B”不能去除。

隐私保护通话 PRIVATENUMBER AX模式

隐私保护通话 PRIVATENUMBER-AX模式接口使用说明:API请求地址

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

隐私保护通话 PRIVATENUMBER AX模式

隐私保护通话 PrivateNumber-AX模式设置临时被叫接口:接口示例

接口示例接口示例仅供参考，请以实际消息为准。请求示例 PUT /rest/caas/privatenumber/calleenumber/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"{ "origNum":"+86138****0001", "privateNum":"+86138****6666", "calleeNum":"+86138****1111" } 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Content-Length: xx { "resultcode":"0", "resultdesc":"Success" }

隐私保护通话 PrivateNumber AX模式

隐私保护通话 PrivateNumber-AX模式设置临时被叫接口:结果码说明

结果码说明表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. 平台达到系统流控上。请稍等一分钟后再试。 1010040 The app_key is not allowed to invoke the API. app_key没有调用本API的权限。调用的接口和app_key所属的应用模式不一致。如添加应用时选择的AXB模式的应用，调用接口时只能调用AXB模式的接口，不能调用其他模式的接口。 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。 500 1010001 Internal system error. 系统错误。请联系客服处理。 1023001 Internal error. 内部错误。 1023002 Response timeout. 响应超时。重新发送一次请求，若依然返回响应超时，请联系管理员处理。

隐私保护通话 PrivateNumber AX模式

隐私保护通话 PrivateNumber-AX模式设置临时被叫接口:请求参数

请求参数表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(4-31) AX中的A号码。填写为全局号码格式。手机号码格式为国家码（如+86）+手机号码（11位数字的手机号码，如138****0001），填写为"+86138****0001"。固话号码为国家码（如+86）+不带前置0的区号（如755）+本地固话号码（7或8位数字的固话号码，以实际号码为准，如28****01），填写为"+8675528****01"。系统不会解析该参数，可不携带。 privateNum 否 String(4-31) AX中的X号码。填写为全局号码格式（包含国家码），例如：+86138****0021。系统可通过subscriptionId或privateNum确定唯一一个绑定关系，即不携带subscriptionId时，必须携带privateNum。 subscriptionId 否 String(0-64) 指定“AX模式绑定接口”返回的绑定ID，确定唯一一组绑定关系。请求携带了subscriptionId时，系统会以subscriptionId的值为准，可不关注privateNum参数。 calleeNum 是 String(4-31) 本次呼叫的真实被叫号码。填写为全局号码格式。手机号码格式为国家码（如+86）+手机号码（11位数字的手机号码，如138****0001），填写为"+86138****0001"。固话号码为国家码（如+86）+不带前置0的区号（如755）+本地固话号码（7或8位数字的固话号码，以实际号码为准，如28****01），填写为"+8675528****01"。说明： origNum和calleeNum不能相同。 duration 否 Integer 临时被叫关系保持时间，单位为秒，取值范围1~259200（3天）。临时被叫关系过期后需要重新设置。如果不携带该参数，系统默认该参数为60。 userData 否 String(1-256) 用户自定义数据。不允许携带以下字符：“{”，“}”（即大括号）。不允许包含中文字符，如果包含中文字符请采用Base64编码。说明：若在设置绑定关系时携带该参数，绑定关系对应的呼叫、话单和短信通知消息中也会携带该参数。

隐私保护通话 PrivateNumber AX模式

云服务器内容精选

AX模式

7*24

备案

专业服务

退订

建议反馈

售前咨询热线