Instantly retrieve call records when a call starts using SecretStartReport-Phone Number Protection(PNP)-阿里云帮助中心

You can subscribe to call start report messages (SecretStartReport) using HTTP batch push. This service lets you instantly retrieve call record information when a call starts. This information includes details such as the call start time, caller number, and callee number, which helps your platform perform predictive processing.

Protocol specifications

Parameter	Description
Protocol	HTTP + JSON
Encoding	UTF-8

Request specifications

The request body is in JSON Array format. A single request can contain multiple call records.

Request example

[{
        "phone_no": "138****0000", 
        "pool_key": "12345678", 
        "city": "Chongqing", 
        "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"
}]

Field descriptions

Name	Type	Required	Example	Description
phone_no	String	Yes	138****0000	The A number.
pool_key	String	Yes	FC10000012345****	The key of the number pool.
city	String	No	Chongqing	The home location of the X number.
out_id	String	No	123456	The external business ID.
sub_id	Long	No	100002390038****	The binding ID.
unconnected_cause	Number	No	0	The reason for the call failure. Valid values: 0: Normal call. 1: Blocked by blacklist. 2: No binding relationship. 3: Call restriction. 4: Other.
call_time	String	No	2021-08-10 15:35:36	The time when the caller made the call.
peer_no	String	Yes	138****0000	The B number, N number, or G group number.
called_display_no	String	Yes	158****0000	The number displayed to the callee.
call_id	String	No	4461122c480****	The call ID. Note The `call_id` is limited to 100 characters.
partner_key	String	Yes	FC1390000****	The key of the number pool.
id	String	Yes	101407590****	The primary key.
secret_no	String	Yes	138****0000	The privacy number.
call_type	Number	No	1	The call type. Valid values: 0: Outgoing. 1: Incoming.
control_type	String	No	CONTINUE	The current connection stage. Valid values: IVR CONTINUE REJECT
control_msg	String	No	NO_SUBS_EXIST	Returns `NO_SUBS_EXIST` if no binding relationship exists.

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.

Re-push

If a push fails, the system retries three times at intervals of 1 minute, 5 minutes, and 10 minutes. If the push still fails, the system does not try again.