AI 助理
备案控制台
文档
输入文档关键字查找
首页号码隐私保护开发参考回执消息HTTP批量推送模式SecretReport

SecretReport

更新时间：2025-02-11 07:36:34
产品详情
我的收藏

您可以通过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

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的有效期是30天。录音文件的生成需要一定的时间。您可在等待15至20分钟后再去下载。

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****

ID主键，每条是唯一的。

secret_no

String

是

186****7614

隐私号码，即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

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

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，最大长度限制为128。

release_cause

Integer

否

31

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

extension

String

否

8011

分机号。

call_status

String

否

BUSY

智能状态码。

说明

call_status为智能状态码，因运营商侧原因，获取的话单报告消息不能保证一定会有该字段。您可参考下方字段取值说明。

call_status智能状态码取值说明

call_status字段取值

状态

说明

call_status字段取值

状态

说明

ANSWERED

通话成功。

被叫接通，双方成功建立通话。

BUSY

被叫忙。

该返回值产生情况描述如下：

主叫情景：该呼叫过程分为两段，先第一个语音提醒：“您好，请不要挂机，您拨打的电话正在通话中”；然后转为正常呼叫。

  • 主叫在第一个语音提醒中挂断。

  • 主叫在第一个语音后，转为正常呼叫时挂断。

  • 被叫在主叫第一个语音处挂断。

  • 被叫在主叫第一个语音结束后转为正常呼叫时挂断。

  • 被叫一直未接，主叫呼叫超时（先提醒“您好，请不要挂机，您拨打的电话正在通话中”，然后被叫一直无任何操作，主叫呼叫超时，提醒“您好，您拨叫的用户暂时无人接听，请您稍后再拨”）。

以上用户忙场景产生后，无论被叫拒接或主叫挂机，都归结为被叫忙状态返回。

NO_ANSWER

被叫无应答。

被叫方在空闲状态下，超过30秒为接听或拒接（收到关键字：无人接听），返回被叫无应答状态。

REJECT

被叫拒接。

被叫方在空闲状态下，振铃30秒以内，拒接来电，返回被叫方拒接。

HANGUP

主叫提前挂机。

被叫方在空闲且号码正常状态下，30秒内无拒接动作，而主叫侧挂机。

INAALID_NUMBER

空号。

被叫手机号码为空号的情况。

POWER_OFF

关机。

被叫关机或飞行模式下返回该状态。

UNAVAILABLE

暂时无法接听。

无确定信令或用ASR识别时长不足判断时，或不在服务区、暂时无法接通等归类到此状态码。

SUSPEND

停机。

被叫停机状态返回该状态。

NETWORK_ERROR

网络限制。

包含运营商拦截等网络限制。

OTHER

其他失败情形。

-

TP_TIMEOUT

无绑定呼叫。

-

响应说明

响应样例：

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

字段说明：

名称

类型

是否必选

示例值

描述

名称

类型

是否必选

示例值

描述

code

Number

是

0

应答编码。

msg

String

否

接收成功

描述信息。

说明

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

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

重新推送

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

上一篇：SecretStartReport下一篇：SecretRecording
  • 本页导读 （1）
  • 协议说明
  • 请求说明
  • 请求样例
  • 字段说明
  • call_status智能状态码取值说明
  • 响应说明
  • 响应样例：
  • 字段说明：
  • 重新推送