文档

SecretStartReport

更新时间:

您可以通过HTTP批量推送方式订阅呼叫发起时话单报告消息(SecretStartReport),可以在呼叫发起时立即获取到通话记录信息,包括通话开始时间、主被叫号码等,便于平台进行预判处理。

协议说明

参数

说明

协议

HTTP + JSON

编码

UTF-8

请求说明

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

请求样例

[{
        "phone_no": "138****0000", 
        "pool_key": "12345678", 
        "city": "重庆", 
        "sub_id": 100002390038****, 
        "out_id": "123456", 
        "unconnected_cause": 0, 
        "call_time": "2021-08-10 15:35:36", 
        "peer_no": "138****0000", 
        "called_display_no": "158****0000", 
        "call_id": "4461122c480****", 
        "partner_key": "FC1390000****", 
        "id": "101407590****", 
        "secret_no": "138****0000", 
        "call_type": 0, 
        "control_type": "CONTINUE"
}]

字段说明

名称

类型

是否必选

示例值

描述

phone_no

String

138****0000

A号码。

pool_key

String

FC10000012345****

对应的号池Key。

city

String

重庆

X号码归属地。

out_id

String

123456

外部业务ID。

sub_id

Long

100002390038****

绑定关系ID。

unconnected_cause

Number

0

未接通通话的原因。

取值:

  • 0:正常通话。

  • 1:黑名单拦截。

  • 2:无绑定关系。

  • 3:呼叫限制。

  • 4:其他。

call_time

String

2021-08-10 15:35:36

主叫拨打时间。

peer_no

String

138****0000

B号码、N号码或者G组号码。

called_display_no

String

158****0000

被叫显号。

call_id

String

4461122c480****

通话ID。

说明

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

partner_key

String

FC1390000****

商户Key。

id

String

101407590****

主键。

secret_no

String

138****0000

隐私号码。

call_type

Number

1

呼叫类型。取值:

  • 0:主叫。

  • 1:被叫。

control_type

String

CONTINUE

当前接续阶段。取值:

  • IVR

  • CONTINUE

  • REJECT

control_msg

String

NO_SUBS_EXIST

无绑定关系时返回NO_SUBS_EXIST。

响应说明

响应样例:

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

字段说明:

名称

类型

是否必选

示例值

描述

code

Number

0

应答编码。

msg

String

接收成功

描述信息。

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

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

重新推送

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