Skip to main content

Call Recording Upload API

Overview​

This API allows you to securely upload call recordings and associated metadata to Calloptix for further processing and analysis.

Endpoint URL​

POST https://webhook.calloptix.com/api/webhook/add_custom_recording

Request Body​

The request body should be a JSON object with the following parameters:

  • api_key: (string) Your API key for authentication.
  • recording_url: (string) URL of the call recording file to be uploaded.
  • agent_number: (string) Phone number of the agent.
  • customer_number: (string) Phone number of the customer.
  • direction: (string, optional) Direction of the call.
  • status: (string, optional) Status of call.
  • source: (string, optional) Source of the call recording (e.g., "VOIP", "custom").
  • metadata: (object, optional) Additional metadata related to the call.

Example Request​

{
"api_key": "your_api_key_here",
"recording_url": "https://example.com/your-recording.mp3",
"agent_number": "+1234567890",
"customer_number": "+9876543210",
"direction": "incoming",
"status": "completed",
"source": "VOIP",
"metadata": {
"department": "Sales",
"campaign_id": "CAM2024"
}
}

Response Success Response (200 OK):

{
"status": 200,
"message": "success",
"data": {
"recordingId": "unique_recording_id",
"metadata": {
"department": "Sales",
"campaign_id": "CAM2024"
}
}
}

Error Response (400 Bad Request):

{
"error": "Missing parameters: api_key, recording_url, call_from, call_to, call_duration"
}

{
"error": "api_key is invalid"
}

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