绑定
所有文档

          号码隐私保护服务 PNS

          绑定

          接口描述

          AXB绑定接口可以实现在一对一的场景中的号码隐私保护,在使用该接口前需要明确AXB三者角色,比如在外卖的场景中,A可以是用户的联系方式,X是中间隐私号码,B可以是外卖员的联系方式。在绑定成功后,A或者B拨打X号码都可以找到对方,而双方显示的都是这个X号码。

          请求结构

          POST /cloud/api/v{version}/axb/binding HTTP/1.1
          Host: pns.baidubce.com
          Content-Type: application/json; charset=utf-8
          x-bce-date: 2019-10-30T10:55:26Z
          Authorization: authorization string
          {
              "telA": "A号码",
              "telB": "B号码",
              "areaCode": "需要X号码所属区号",
              "record": "是否录音,1:录音;0:不录音",
              "expiration": "绑定失效时间(秒)",
              "customer": "业务侧随传数据,可以是json和任意字符串"
          }

          请求域名

          参考API文档中的服务域名

          请求头域

          除公共头域外,无其它特殊头域。

          请求参数

          参数名称 类型 是否必须 参数位置 描述
          version String URL参数 API版本号,参考通用说明中的API版本号
          telA String RequestBody参数 主叫号码 格式:手机或固话座机
          telB String RequestBody参数 被叫号码 格式:手机或固话座机
          telX String RequestBody参数 中间X号码,不传平台自动分配申请的X号码
          areaCode String RequestBody参数 需要的 X 号码所属于区号
          expiration String RequestBody参数 绑定关系有效时长,必须大于0,单位:秒
          record String RequestBody参数 录音状态record,1-需要录音;0-不需要录音
          customer Json RequestBody参数 业务侧随传数据,可以是json和任意字符串

          响应头域

          除了公共头域外,如果发生网关错误,可能头域中存在以下特殊头域:

          参数名 类型 说明
          X-Bce-Error-Code String 表示异常情况下的错误码
          X-Bce-Error-Message String 表示异常情况下的错误信息

          响应参数

          参数名称 类型 描述
          code String 平台返回的错误码,0表示成功
          msg String 平台放回的错误消息
          data Json 平台返回的响应数据

          绑定操作成功后的响应数据data:

          参数名称 类型 描述
          bindId String AXB绑定ID
          telX String AXB绑定X号码

          错误码

          请参照前文的网关错误码和平台错误码。

          请求示例

          POST /cloud/api/v{version}/axb/binding HTTP/1.1
          Host: pns.baidubce.com
          Content-Type: application/json; charset=utf-8
          x-bce-date: 2019-10-30T10:55:26Z
          Authorization: bce-auth-v1/318857a8f08b11e9845ca7e54775a0c2/2019-10-17T03:07:21Z/1800/host/212eef8cfe1ac94be56c4afedb9360bba621ef646c3c8288971d36801d70501a
          {
              "telA": "17600901081",
              "telB": "13911528327",
              "areaCode": "10",
              "record": "1",
              "expiration": "600",
              "customer": ""
          }

          响应示例

          HTTP/1.1 200 OK
          Content-Type: application/json;charset=UTF-8
          Date: Wed, 08 Jul 2019 03:28:11 GMT
          x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
          X-Bce-Gateway-Region: BJ
          {
             "code":"0",
             "msg":"成功",
             "data":{
                  "bindId":"1535822891021508888",
                  "telX":"17810301111"
             }
          }
          上一篇
          错误返回
          下一篇
          解绑