SecretPickUpReport

Updated at:

You can subscribe to SecretPickUpReport event messages using an HTTP batch push to obtain information about when a call is answered.

Notes

Subscriptions to SecretPickUpReport are supported only for numbers from specific carrier platforms.

Protocol specifications

Parameter

Description

Protocol

HTTP + JSON

Encoding

UTF-8

Requests

The request body is a JSON array. A single request can contain multiple call records.

Sample request

[{
        "phone_no": "1314456****", 
        "secret_no": "1304984****", 
        "peer_no": "1304984****", 
        "call_type": "1", 
        "call_id": "4461122c480****", 
        "call_time": "2021-12-10 10:00:00", 
        "pool_key": "FC2256****", 
        "ring_time": "2021-12-10 10:00:03",         
        "start_time": "2021-12-10 10:06:00", 
        "sub_id": "100004306803****", 
        "city": "Xi'an", 
        "out_id": "8136812621****"
}]

Field descriptions

Parameter name

Parameter type

Example

Description

phone_no

String

1314456****

Number A.

secret_no

String

1304984****

The privacy number.

peer_no

String

1380000****

Number B, number N, or a number from group G.

call_type

Number

1

The call type. Valid values:

  • 0: Outbound call. phone_no calls peer_no.

  • 1: Inbound call. peer_no calls phone_no.

  • 4: Call intercept.

call_id

String

44611dd0c30****

The call record ID.

call_time

String

2021-12-10 10:00:00

The time when the caller placed the call.

pool_key

String

FC2256****

The key of the number pool.

ring_Time

String

2021-12-10 10:00:03

The ringing time.

start_time

String

2021-12-10 10:06:00

The time when the called party answered.

sub_id

Long

100004306803****

The binding ID.

city

String

Xi'an

The location of the privacy number.

out_id

String

8136812621****

The external business ID.

extension

String

8011

The extension number.

Response specifications

Response example:

{
  "code" : 0,
  "msg" : "Accepted successfully"
}

Field descriptions:

Name

Type

Required

Example

Description

code

Number

Yes

0

The acknowledgement code.

msg

String

No

Accepted successfully

The description.

Note
  • The system only checks whether the `code` in the return value is a number and does not validate the content. A request is considered successful if the HTTP status code is 200. If the HTTP status code is not 200 or a timeout occurs, the system retries the push.

  • If a system exception or consumption failure occurs, return an HTTP 5xx status code.

Repush

If an initial push fails, the system retries the push up to three times. The retries occur at 1-minute, 5-minute, and 10-minute intervals. If the third retry also fails, the system makes no further attempts.