Skip to main content

Recording Details API

Overview​

This API retrieves detailed information about a specific call recording based on the provided recording_id and api_key.

Endpoint URL​

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

Request Body​

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

  • recording_id: (number) ID of the recording for which details are requested.
  • api_key: (string) Your API key for authentication.

Example Request​

{
  "recording_id": 12345,
  "api_key": "your_api_key_here"
}

Response Success Response (200 OK):

{
  "status": 200,
  "message": "success",
  "data": {
    "recordingId": "recordingId",
    "agentDetails": {
      "agentName": "Agent's Username",
      "agentNumber": "Agent's Phone Number"
    },
    "customerDetails": {
      "customerName": "Customer's Name",
      "customerNumber": "Customer's Phone Number",
      "businessName": "Customer's Business Name"
    },
    "conversationSummary": "Summary of the conversation",
    "ticketSize": "$500",
    "actionItems": [
      {
        "description": "Follow up on contract details",
        "status": "pending",
        "priority": "high",
        "due_date": "2024-07-01",
        "created_at": "2024-06-29",
        "responsible_party": "Sales Team"
      }
    ],
    "callSentiment": "Positive/Negative/Neutral",
    "selectedTags": ["Tag1", "Tag2", "Tag3"]
  }
}

Error Response (400 Bad Request):

{
  "error": "Missing parameters: api_key, recording_id"
}
{
  "error": "api_key is invalid"
}
{
  "error": "Recording not found"
}
{
  "error": "Recording is skipped"
}
{
  "error": "Recording is still getting processed"
}
{
  "error": "Recording doesn't belong to you"
}