v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

Service Agent

List aicalls

Retrieves a paginated list of AI calls for the service agent's customer. Optionally filter by the origin resource (reference_type + reference_id) to find AI calls tied to a specific call, conversation, task, or contact case — e.g. to check whether an AI call is already in progress for a given contact case before starting a new one.

get/service_agents/aicalls

Query parameters

page_sizeinteger

Example:25

Number of results to return per page.

page_tokenstring

Cursor token for pagination. Use the next_page_token value from the previous response.

reference_type'' | 'call' | 'conversation' | 'task' | 'contact_case'

Type of reference associated with the ai call.

Example:call

Filter by the reference type of the origin resource. Must be supplied together with reference_id; supplying only one of the two returns a 400 error.

reference_idstring uuid

Filter by the ID of the origin resource (e.g. a contact case ID). Must be supplied together with reference_type; supplying only one of the two returns a 400 error.

Status of the ai call.

Example:progressing

Filter by AI call status. Useful together with reference_type and reference_id to check whether an AI call is currently active for a given reference (e.g. pass status=progressing to avoid matching a prior, already-terminated AI call for the same contact case).

Response

A list of AI calls.

next_page_tokenstring

Cursor token for the next page of results. Pass this value as the page_token parameter in the next request.

Example response

{
  "result": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "assistance_type": "ai",
      "assistance_id": "550e8400-e29b-41d4-a716-446655440000",
      "ai_engine_model": "openai.gpt-5",
      "ai_tts_type": "elevenlabs",
      "ai_tts_voice_id": "21m00Tcm4TlvDq8ikWAM",
      "ai_stt_type": "deepgram",
      "ai_vad_config": {
        "confidence": 0.7,
        "start_secs": 0.2,
        "stop_secs": 0.5,
        "min_volume": 0.6
      },
      "parameter": {
        "language": "en-US",
        "department": "support"
      },
      "activeflow_id": "550e8400-e29b-41d4-a716-446655440000",
      "reference_type": "call",
      "reference_id": "550e8400-e29b-41d4-a716-446655440000",
      "confbridge_id": "550e8400-e29b-41d4-a716-446655440000",
      "current_member_id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "progressing",
      "stt_language": "en-US",
      "tm_end": "2026-01-15T09:30:00.000000Z",
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z"
    }
  ]
}