Use SecretRingReport to get call ringing information-Phone Number Protection(PNP)-阿里云帮助中心

You can subscribe to ringing event messages (SecretRingReport) using HTTP batch pushes to obtain ringing information during a call.

Notes

Only numbers from some carrier platforms support subscriptions to SecretRingReport.

Protocol specifications

Parameter	Description
Protocol	HTTP + JSON
Encoding	UTF-8

Request description

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

Request example

[{
        "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", 
        "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: Outgoing call. phone_no calls peer_no. 1: Incoming call. peer_no calls phone_no. 4: Call blocked.
call_id	String	44611dd0c30****	The call record ID.
call_time	String	2021-12-10 10:00:00	The time when the call was initiated.
pool_key	String	FC2256****	The key of the number pool.
ring_time	String	2021-12-10 10:00:03	The ringing time.
sub_id	Long	100004306803****	The binding ID.
city	String	Xi'an	The home city of the privacy number.
out_id	String	8136812621****	The external business ID.
extension	String	8011	The extension number.

Response description

Response example

{
  "code" : 0,
  "msg" : "Success"
}

Field descriptions

Name	Type	Required	Example	Description
code	Number	Yes	0	The acknowledgement code.
msg	String	No	Success	The description.

Note

A request is considered successful if the HTTP status code is 200. The system only validates that the returned code is a number, not the content itself. If the status code is not 200 or the response times out, the system retries the push.
Return an HTTP 50X response code for system errors or processing failures.

Retries

If an initial push fails, the system retries the push at intervals of 1, 5, and 10 minutes. If the push still fails after these three attempts, no further retries are attempted.