Manage Use Cases

Use cases help organize and configure how your call and chat recordings are analyzed for different scenarios (e.g., sales, support, compliance). You must create a use case before you can upload any recordings for analysis.

Create Use Case

Create a new analysis use case with specific parameters, tags, and configurations.

Endpoint POST {{baseUrl}}/v1alpha/callintel/usecase

Request Body

Code
 
{
  "org_uuid": "33bbb237-6256-4c81-b423-a5bd16af5a32",
  "usecase_name": "Lead Generation Analysis",
  "usecase_desc": "Analyze sales calls for lead qualification",
  "usecase_type": "CALL",
  "analysis_config": {
    "analysis_questions": [
      "Is the lead interested in the product? (Yes/No)"
    ],
    "analysis_buckets": [
      {
        "objective_bucket_name": "hot-leads",
        "description": "The caller explicitly stated they are ready to buy."
      },
      {
        "objective_bucket_name": "warm-leads",
        "description": "The caller showed interest but asked for more time."
      },
      {
        "objective_bucket_name": "cold-leads",
        "description": "The caller said they are not interested or hung up."
      }
    ]
  },
  "is_comprehend_required": false
}

Note: usecase_type can be "CALL" or "CHAT".

Get Use Case

Retrieve detailed information about a specific analysis use case.

Endpoint GET {{baseUrl}}/v1alpha/callintel/usecase/{usecase_uuid}

Response Example

Code
 
{
  "usecase_uuid": "815545c1-61c1-4ec7-aa14-365a07909937",
  "org_uuid": "33bbb237-6256-4c81-b423-a5bd16af5a32",
  "usecase_name": "Lead Generation Analysis",
  "usecase_desc": "Analyze sales calls for lead qualification",
  "usecase_type": "CALL",
  "analysis_config": {
    "analysis_questions": [
      "Is the lead interested in the product? (Yes/No)"
    ],
    "analysis_buckets": [
      {
        "objective_bucket_name": "hot-leads",
        "description": "The caller explicitly stated they are ready to buy."
      },
      {
        "objective_bucket_name": "warm-leads",
        "description": "The caller showed interest but asked for more time."
      },
      {
        "objective_bucket_name": "cold-leads",
        "description": "The caller said they are not interested or hung up."
      }
    ]
  },
  "is_active": true,
  "is_comprehend_required": false,
  "compliance_config": {},
  "call_flow_config": {},
  "created_at": "2025-12-04T09:21:58.743Z",
  "updated_at": "2025-12-04T09:21:58.743Z"
}

Update Use Case

Update an existing analysis use case. Only include the fields you wish to update.

Endpoint PUT {{baseUrl}}/v1alpha/callintel/usecase/{usecase_uuid}

Request Body Example

Code
 
{
  "usecase_name": "Updated Lead Gen",
  "usecase_desc": "New description",
  "analysis_config": {
    "analysis_buckets": [
      {
        "objective_bucket_name": "bucket1",
        "description": "..."
      }
    ]
  },
  "is_active": true
}

Delete Use Case

Delete a specific analysis use case.

Endpoint DELETE {{baseUrl}}/v1alpha/callintel/usecase/{usecase_uuid}

Response Example

Code
 
{
  "message": "Usecase deleted successfully",
  "usecase_uuid": "815545c1-61c1-4ec7-aa14-365a07909937"
}

List Organization Use Cases

Retrieve a paginated list of all use cases for an organization. You can optionally filter by search term or usecase type.

Endpoint GET {{baseUrl}}/v1alpha/callintel/org-usecases/{org_uuid}?page=1&limit=10

Query Parameters