文档

SecretReport

更新时间:

您可以通过HTTP批量推送方式订阅呼叫结束后话单报告消息(SecretReport),可以在呼叫结束后获取通话记录信息,包括通话开始时间、通话结束时间、主被叫号码等,便于平台进行管理。

协议说明

参数说明
协议HTTP + JSON
编码UTF-8

请求说明

请求内容为JSON Array格式,单次请求可能会包含多个通话记录。

请求样例

[{
    "phone_no": "171****3225",
    "city": "北京",
    "call_out_time": "2021-08-25 20:11:30",
    "ring_time": "2021-08-25 20:11:35",
    "record_url": "https://*****.oss-cn-shanghai.aliyuncs.com",
    "ring_record_url": "https://****.oss-cn-shanghai.aliyuncs.com",
    "free_ring_time": "2021-08-25 20:11:35",
    "control_msg": "OK",
    "id": 101456851****,
    "secret_no": "186****7614",
    "call_type": 1,
    "control_type": "CONTINUE",
    "release_time": "2021-08-25 20:11:41",
    "pool_key": "FC10000009708****",
    "sub_id": 100004306803****,
    "unconnected_cause": 0,
    "call_time": "2021-08-25 20:11:29",
    "peer_no": "152****1504",
    "called_display_no": "158****0000",
    "release_dir": 1,
    "call_id": "43612633712c****",
    "start_time": "2021-08-25 20:11:38",
    "partner_key": "FC10000009708****",
    "out_id": "7368136812621****",
    "release_cause": 31
}]

字段说明

名称

类型

是否必选

示例

描述

phone_no

String

171****3225

AXB中的A号码。

city

String

北京

X号码归属地。

call_out_time

String

2021-08-25 20:11:30

呼叫被叫侧发起的时间。如未发起,则等于call_time的时间;短信话单时,此值传短信接收时间。

ring_time

String

2021-08-25 20:11:35

被叫响铃时间。如没有响铃时间,则等于call_out_time的时间。短信话单时,此值传短信接收时间。

record_url

String

https://*****.oss-cn-shanghai.aliyuncs.com

录音下载URL。

说明

录音下载URL的有效期是7天。

ring_record_url

String

https://****.oss-cn-shanghai.aliyuncs.com

放音录音URL。

说明

放音录音URL的有效期是7天。

free_ring_time

String

2021-08-25 20:11:35

被叫手机真实的振铃时间。

  • free_ring_time大于call_out_time表示被叫真实发生了振铃事件。

  • free_ring_time和call_out_time相等表示未振铃。

  • 如获取不到,则等于ring_time的时间。

control_msg

String

OK

延续信息。

  • OK:正常。

  • NO_SUBS_EXIST:无绑定关系时。

id

String

101456851****

主键。

secret_no

String

186****7614

AXB中的X号码。

call_type

Integer

1

呼叫类型。取值:

  • 0:主叫,即phone_no打给peer_no。

  • 1:被叫,即peer_no打给phone_no。

  • 4:呼叫拦截。

control_type

String

CONTINUE

当前接续阶段。取值:

  • IVR

  • CONTINUE

  • REJECT

release_time

String

2021-08-25 20:11:41

通话释放时间(通话计费结束时间);短信话单时,此值传短信接收时间。

说明

release_time和start_time之差表示通话时长,如果结果为0,说明呼叫未接通。

pool_key

String

FC10000009708****

对应的号池Key。

sub_id

Long

100004306803****

绑定关系ID。

unconnected_cause

Integer

0

未接通通话的原因。

  • 0:正常通话。

  • 1:黑名单拦截。

  • 2:无绑定关系。

  • 3:呼叫限制。

  • 4:其他。

call_time

String

2021-08-25 20:11:29

主叫拨打时间。

peer_no

String

152****1504

AXB中的B号码或者N号码。

called_display_no

String

158****0000

被叫显号。

release_dir

Integer

1

通话释放方向。

  • 0:平台释放。

  • 1:主叫挂断。

  • 2:被叫挂断

call_id

String

43612633712c****

通话记录的ID。

说明

call_id长度限制在100个字符以内。

start_time

String

2021-08-10 15:46:16

被叫接听时间(通话计费开始时间)。如未接通,则等于release_time的时间。短信话单时,此值传短信接收时间。

partner_key

String

FC10000013150****

商户Key。

out_id

String

7368136812621****

外部业务ID。

release_cause

Integer

31

释放原因。更多详情请参见话单错误码

extension

String

8011

分机号。

响应说明

响应样例:

{
  "code" : 0,
  "msg" : "接收成功"
}

字段说明:

名称

类型

是否必选

示例值

描述

code

Number

0

应答编码。

msg

String

接收成功

描述信息。

说明
  • 系统仅校验返回值的code是否为数字,不校验内容。若HTTP状态码为200,请求成功。HTTP状态码非200或响应超时情况下,系统会进行重试推送。

  • 若出现系统异常、消费失败等情况,建议HTTP响应码返回50X。

重新推送

第一次推送失败后,间隔1分钟、5分钟、10分钟后会进行重推,直至推送成功为止。如果推送3次后仍失败,不再重试。

  • 本页导读 (1)
文档反馈