SecretRecording

Updated at:

You can subscribe to SecretRecording notifications to receive call recordings after a call ends. The service sends these notifications to your endpoint in batches via HTTP POST requests.

Protocol specifications

Parameter

Description

Protocol

HTTP + JSON

Encoding

UTF-8

Request

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

Request example

[{
    "pool_key": "FC10000009708****",
    "call_time": 1629893489000,
    "sub_id": 100004306803****,
    "out_id": "12**84",
    "call_id": "43612633712c****"
}]

Parameters

Parameter

Type

Required

Example

Description

pool_key

String

Yes

FC10000012345****

The unique identifier for the number pool.

sub_id

Number

Yes

100018********02

The unique identifier for the subscription.

call_id

String

Yes

416662cb********

The unique identifier for the call.

Note

call_id has a maximum length of 100 characters.

call_time

String

Yes

1553774465000

The time of the call as a UNIX timestamp in milliseconds.

out_id

String

No

12**84

The external business ID.

Response

Response example

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

Parameters

Parameter

Type

Required

Example

Description

code

Number

Yes

0

The result code.

msg

String

No

Received successfully

A descriptive message.

Note
  • The system only validates that the value of the code parameter in your response is a number. To acknowledge receipt of the notification, your endpoint must return an HTTP 200 status code. If the system receives a non-200 HTTP status code or the request times out, it initiates a push retry.

  • If your endpoint encounters a system error or consumption failure, return an HTTP 5xx status code.

Push retry

If the initial push fails, the system retries after 1, 5, and 10 minutes. If all three retries fail, the system makes no further attempts.