List Conversations For Caller

GET

https://api.speechify.ai/v1/agents/callers/:id/conversations

GET

/v1/agents/callers/:id/conversations

$ curl https://api.speechify.ai/v1/agents/callers/id/conversations \
>      -H "Authorization: Bearer <token>"

1 {
2   "next_cursor": "string",
3   "has_more": true,
4   "conversations": [
5     {
6       "id": "conv_01kr410dd3yrst4chn5kn0t78f",
7       "agent_id": "string",
8       "room_name": "string",
9       "status": "pending",
10       "transport": "web",
11       "created_at": "2024-01-15T09:30:00Z",
12       "metadata": {},
13       "message_count": 1,
14       "room_sid": "string",
15       "started_at": "2024-01-15T09:30:00Z",
16       "ended_at": "2024-01-15T09:30:00Z",
17       "duration_ms": 1,
18       "cost_cents": 1,
19       "recording_url": "string",
20       "recording_started_at": "2024-01-15T09:30:00Z",
21       "end_reason": null,
22       "caller_identity": "string",
23       "from_number": "string",
24       "to_number": "string",
25       "agent_snapshot": {
26         "schema_version": 1,
27         "captured_at": "2024-01-15T09:30:00Z",
28         "name": "string",
29         "prompt": "string",
30         "first_message": "string",
31         "language": "string",
32         "llm_provider": "string",
33         "llm_model": "string",
34         "llm_base_url": "string",
35         "llm_extra_body": {},
36         "voice_id": "string",
37         "temperature": 1.1,
38         "memory_enabled": true,
39         "memory_retention_days": 1,
40         "tts_speaking_rate": 1.1,
41         "tts_playback_rate": 1.1,
42         "response_delay_seconds": 1.1,
43         "stt_override": "string",
44         "amd": {
45           "enabled": true,
46           "on_voicemail": {
47             "action": "hangup",
48             "message": "string"
49           },
50           "on_ivr": {
51             "action": "proceed"
52           },
53           "on_unavailable": {
54             "action": "hangup"
55           },
56           "tuning": {
57             "human_speech_threshold_seconds": 1.1,
58             "no_speech_threshold_seconds": 1.1,
59             "timeout_seconds": 17.5,
60             "classification_prompt": "string"
61           }
62         },
63         "save_audio_recording": true,
64         "navigator_mode": true,
65         "ivr_memory_enabled": true,
66         "inactivity_timeout_seconds": 1,
67         "background_noise_preset": "office",
68         "background_noise_volume": 1.1
69       },
70       "dynamic_variables": {},
71       "ivr_menu_id": "string",
72       "ivr_path_taken": [
73         {}
74       ],
75       "ivr_surrender_reason": null
76     }
77   ]
78 }

List one page of conversations belonging to the caller, newest started first. Same wire envelope as the workspace-wide GET /v1/agents/conversations, narrowed to one caller.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

idstringRequired

Query parameters

cursorstringOptional

Opaque cursor from a prior response’s next_cursor.

limitintegerOptional1-200Defaults to 50

Page size. Defaults to 50; capped at 200.

Response

next_cursorstring or null

Opaque keyset cursor for the next page. Pass back as the cursor request parameter. null when the caller has reached the end of the list (has_more is also false in that case).

has_moreboolean

True when more rows exist beyond this page.

conversationslist of objects

Errors

400

Bad Request Error