VoiceRecordReportAiccs

Updated at:

Subscribe to VoiceRecordReportAiccs messages via HTTP batch push to receive the recording details for a call after it ends.

Protocol specification

CategoryDescription
ProtocolHTTP + JSON
EncodingUTF-8

Request format

The request body is a JSON array.
  • Sample request:
    [
      {
        "call_id": "100001616500^1000018****",
        "start_time": "2017-06-01 10:00:00",
        "end_time": "2017-06-01 10:03:00",
        "duration": "10",
        "status_code": "200010",
        "record_file": "http://xxxx",
        "out_id": "123456",
        "record_begin_time": "2017-06-01 10:00:00"
      }
    ]
  • Field descriptions:
    ParameterTypeExampleDescription
    call_idString100001616500^1000018****The call ID.
    start_timeString2017-06-01 10:00:00The time when the call started. This field is empty if the call did not connect.
    end_timeString2017-06-01 10:03:00The time when the call ended. This field is empty if the call did not connect.
    durationInteger10The call duration in seconds. The value is 0 if the call did not connect.
    status_codeString200010The call result status code. For more information, see Call status codes.
    record_fileStringhttp://xxxxThe recording file URL.
    out_idString123456A passthrough field. The service returns the value provided in the original API request.
    record_begin_timeString2017-06-01 10:00:00The time when the recording started.

Response format

  • Sample response:
    {
      "code": 0,
      "msg": "Received successfully"
    }
  • Field descriptions:
    ParameterTypeRequiredDescriptionExample
    codeNumberYesThe response code. A value of 0 indicates success.0
    msgStringNoA descriptive message.Received successfully
Note
  • The system only validates that the value of the code field in the response is a number; it does not validate the specific value. The push is considered successful if your endpoint returns an HTTP status code of 200. If your endpoint returns a non-200 HTTP status code or a response timeout occurs, the system initiates a push retry.
  • If your service encounters a temporary issue, such as a system exception or processing failure, return a 5xx HTTP status code to trigger a push retry.

Push retries

If the initial push attempt fails, the system performs three retries at intervals of 1 minute, 5 minutes, and 10 minutes. If the third retry also fails, the system makes no further attempts.