订阅回执消息
所有文档

          号码隐私保护服务 PNS

          订阅回执消息

          场景

          用户在使用对应模式的X号码过程中,可以通过开启订阅回执消息的功能,来接收对应的话单明细。这里话单明细包含通话话单以及短信话单,一旦用户开启订阅回执消息的功能,在通话结束后或者短信发送后,会将话单以POST请求的方式推送到业务方配置的URL中。

          对于通话话单,如果通话包含录音文件时,录音文件的转储需要一定时间,一般可在通话结束后4-5分钟收到话单。

          如何配置

          在PNS概览页中开启订阅回执消息功能,并设置对应的URL。用户需要保证对应的URL可以正确接收话单明细,并返回正确的响应内容。 订阅回执消息1.png

          在配置对应URL时,我们会模拟一个假话单推送到对应的URL中,如果得到的响应内容中code为非0,则认为用户配置的URL不合法。 订阅回执消息2.png

          话单参数

          通话话单参数如下表所示:

          参数名称 类型 是否必须 参数位置 描述
          callId String RequestBody参数 通话Id
          bindId String RequestBody参数 绑定Id,和绑定接口返回的bindId一致
          ani String RequestBody参数 主叫号码 格式:手机或固话座机
          dnis String RequestBody参数 被叫号码 格式:手机或固话座机
          telX String RequestBody参数 X号码
          telY String RequestBody参数 Y号码,预留字段
          modeType String RequestBody参数 AXB、AX等
          talkingTimeLen Integer RequestBody参数 通话时长,单位:秒
          startTime String RequestBody参数 拨打时间 格式: yyyy-MM-dd hh:mm:ss
          talkingTime String RequestBody参数 通话时间 格式: yyyy-MM-dd hh:mm:ss
          endTime String RequestBody参数 挂断时间 格式: yyyy-MM-dd hh:mm:ss
          endType String RequestBody参数 挂机结束方 (0表示平台释放,1表示主叫,2表示被叫)
          endState Integer RequestBody参数 挂机状态原因
          recUrl String RequestBody参数 通话录音地址
          customer Json RequestBody参数 业务侧随传数据,可以是json和任意字符串

          短信话单参数如下所示:

          参数名称 类型 是否必须 参数位置 描述
          modeType String RequestBody参数 AXB、AX等
          bindId String RequestBody参数 绑定Id,和绑定接口返回的bindId一致
          smsSender String RequestBody参数 短信发送者号码
          smsReceiver String RequestBody参数 短信接收者号码
          telX String RequestBody参数 X号码
          telY String RequestBody参数 Y号码,预留字段
          smsCnt Integer RequestBody参数 短信条数,运营商会将长短信拆分为多条短信发送的情况
          sendTime String RequestBody参数 短信发送时间 格式: yyyy-MM-dd hh:mm:ss
          endState Integer RequestBody参数 结束状态,预留字段
          customer Json RequestBody参数 业务侧随传数据,可以是json和任意字符串

          请求头域

          参数名 描述
          Content-Type application/json; charset=utf-8

          响应头域

          响应头期望如下:

          参数名 描述
          Content-Type application/json; charset=utf-8

          响应参数

          在话单推送到对应的URL后,期望能给出如下响应:

          参数名称 类型 描述
          code Integer 0表示成功
          msg String 错误消息

          挂机状态

          在推送通话话单中存在挂机状态码字段,状态码对应关系如下表格所示:

          状态码 描述
          1 通话结束
          2 通话结束
          3 通话结束
          4 用户无应答
          5 用户忙
          6 用户缺席
          7 路由失败
          11 用户关机
          12 用户停机
          13 用户拒接
          14 用户空号
          15 其他
          16 路由失败
          17 用户无应答
          18 通话结束
          19 用户无应答
          20 用户缺席
          21 用户拒接
          30 通话结束
          31 路由失败
          32 路由失败
          54 用户关机
          其他 未知错误

          推送示例

          通话话单推送示例如下:

          POST 业务方URI HTTP/1.1
          Host: 业务方URL
          Content-Type: application/json; charset=utf-8
          {
              "callId": "420190823170313",
              "bindId": "042019082317021",
              "ani": "13700001111",
              "dnis": "13700001112",
              "telX": "13700001113",
              "telY": "",
          	"modeType": "AXB",
              "talkingTimeLen": 30,
              "startTime": "2019-12-11 10:10:10",
              "talkingTime": "2019-12-11 10:10:12",
              "endTime": "2019-12-11 10:10:42",
              "endType": "2",
              "endState": 2,
              "recUrl": "http://bos.baidu.com",
          	"customer": ""
          }

          短信话单推送示例如下:

          POST 业务方URI HTTP/1.1
          Host: 业务方URL
          Content-Type: application/json; charset=utf-8
          {
              "modeType": "AXB",
              "bindId": "042019082317021",
              "smsSender": "13700001111",
              "smsReceiver": "13700001112",
              "telX": "13700001113",
              "telY": "",
              "smsCnt": 2,
              "sendTime": "2019-12-11 10:10:10",
              "endState": null,
          	"customer": ""
          }

          响应示例

          在业务方接收到对应的话单后,期望业务方响应正常,返回code=0。如果返回code非0,我们会认为业务方没有正常接收话单,会有重试的操作,会导致业务方重复接收话单的情况。

          HTTP/1.1 200 OK
          Content-Type: application/json;charset=UTF-8
          {
             "code": 0,
             "msg": "消息提示"
          }
          上一篇
          使用统计
          下一篇
          绑定配置