更新时间：2023-01-13 GMT+08:00
X号码状态通知接口
接口功能
X号码状态变化时，隐私保护通话平台会向客户推送通知。号码状态变化包括：
- 因号码删除、欠费、停机，号码状态从可用变为不可用；
- 号码状态从不可用恢复为可用；
- 不可用原因变化，例如从欠费变为停机。
请求方向
隐私保护通话平台（客户端） → 客户服务器（服务端）
使用说明
接口类型
请求方法 |
POST |
|---|---|
访问URI |
客户添加应用时填写的呼叫状态接收地址/X号码状态接收地址 |
通信协议 |
HTTPS/HTTP |
请求参数
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
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="随机数生成时间"。
|
编程语言 |
时间格式 |
|---|---|
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(枚举) |
该参数标识通知的事件类型。 取值范围如下：
|
numInfo |
否 |
X号码状态变化事件的信息，参数取值为列表，最大100条。 当eventType参数为numStatus时携带。 |
参数名称 |
是否必须 |
参数类型 |
说明 |
|---|---|---|---|
number |
是 |
String |
状态变化的X号码。 |
status |
是 |
String |
号码状态。
说明：
各号码状态对业务的影响如下：
|
cause |
否 |
String |
号码不可用原因。仅status为不可用时携带。
|
接口示例
POST /Xnumber/status 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 {"eventType":"numStatus","numInfo":[{"number":"+86156****0000","status":"9"}]}
响应参数
客户服务器接收到隐私保护通话平台的X号码状态变化通知后，返回的响应消息。
接口示例
HTTP/1.1 200 OK
父主题： AXB模式
