隐私保护通话 PrivateNumber隐私保护通话 PrivateNumber

更新时间:2021/09/14 GMT+08:00
分享

X号码状态通知接口

接口功能

X号码状态变化时,隐私保护通话平台会向客户推送通知。号码状态变化包括:
  • 因号码删除、欠费、停机,号码状态从可用变为不可用;
  • 号码状态从不可用恢复为可用;
  • 不可用原因变化,例如从欠费变为停机。

请求方向

隐私保护通话平台(服务端) → 客户服务器(客户端)

使用说明

  • 前提条件

    客户添加应用时需设置呼叫状态接收地址并启用推送X号码状态功能,并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。

    注:若需单独接收X号码状态通知,需填写X号码状态接收地址。呼叫状态接收地址X号码状态接收地址都填写了,隐私保护通话平台会向呼叫状态接收地址推送呼叫事件通知,向X号码状态接收地址推送X号码状态通知。

  • 使用限制

    业务平台推送呼叫状态给开发者应用,仅支持POST方式。

接口类型

表1 接口类型说明

请求方法

POST

访问URI

客户添加应用时填写的呼叫状态接收地址/X号码状态接收地址

通信协议

HTTPS/HTTP

请求参数

表2 请求Body参数说明

参数名称

是否必选

参数类型

说明

eventType

String(枚举)

该参数标识通知的事件类型。

取值范围如下:

  • numStatus:X号码状态变化

numInfo

numInfo [1-100]

X号码状态变化事件的信息,参数取值为列表,最大100条。

当eventType参数为numStatus时携带。

表3 numInfo定义

参数名称

是否必须

参数类型

说明

number

String

状态变化的X号码。

status

String

号码状态。

5:可用

9:不可用

10:不可绑定

cause

String

号码不可用原因。仅status为不可用时携带。

1:号码已删除

2:欠费

3:停机

接口示例

POST /Xnumber/status HTTP/1.1
Content-Length: 94
{"eventType":"numStatus","numInfo":[{"number":"+86156****0000","status":"9","cause":"3"}]}

响应参数

客户服务器接收到隐私保护通话平台的X号码状态变化通知后,返回的响应消息。

接口示例

HTTP/1.1 200 OK 
分享:

    相关文档

    相关产品