Skip to main content

Call Transcription API

Overview​

This API allows you to retrieve the transcription of a specific call recording. It provides a convenient way to access the textual representation of call recordings for analysis, record-keeping, or compliance purposes.

Endpoint​

GET https://webhook.calloptix.com/api/webhook/get_transcription

Payload​

The request body must include the following fields:

  • api_key (required): Your API key for authentication.
  • recording_id (required): The unique identifier for the call recording.

Response​

The API responds with a JSON object containing the following fields:

  • status: The HTTP status code of the response.
  • message: A message indicating the result of the operation.
  • data: An object containing details about the uploaded recording, which includes:
    • recordingId: The unique identifier of the call recording.
    • transcript: An array of objects, each representing a segment of the transcription with the following properties:
      • speaker: Identifies the speaker in the segment.
      • text: The transcribed text of the segment.

Example Request​

curl -X POST "https://webhook.calloptix.com/api/webhook/add_custom_recording" \
     -H "Content-Type: application/json" \
     -d '{
           "api_key": "your_api_key_here",
           "recording_id": "your_recording_id_here"
         }'

Example Response​

{
    "status": 200,
    "message": "success",
    "data": {
        "recordingId": 2276,
        "transcript": [
            {
                "speaker": "Speaker 0",
                "text": "hello okay 8 seconds just wait for 3 4 seconds hold okay disconnecting"
            }
        ]
    }
}

Error Response (400 Bad Request):​

{
  "error": "Missing parameters: api_key, recording_id"
}

{
  "error": "api_key is invalid"
}

{
  "error": "something went wrong!"
}