agentphone 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +270 -0
- package/package.json +69 -0
- package/reference.md +1711 -0
package/reference.md
ADDED
|
@@ -0,0 +1,1711 @@
|
|
|
1
|
+
# Reference
|
|
2
|
+
## Agents
|
|
3
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">listAgents</a>({ ...params }) -> AgentPhone.AgentListResponse</code></summary>
|
|
4
|
+
<dl>
|
|
5
|
+
<dd>
|
|
6
|
+
|
|
7
|
+
#### 📝 Description
|
|
8
|
+
|
|
9
|
+
<dl>
|
|
10
|
+
<dd>
|
|
11
|
+
|
|
12
|
+
<dl>
|
|
13
|
+
<dd>
|
|
14
|
+
|
|
15
|
+
List all agents for this project.
|
|
16
|
+
</dd>
|
|
17
|
+
</dl>
|
|
18
|
+
</dd>
|
|
19
|
+
</dl>
|
|
20
|
+
|
|
21
|
+
#### 🔌 Usage
|
|
22
|
+
|
|
23
|
+
<dl>
|
|
24
|
+
<dd>
|
|
25
|
+
|
|
26
|
+
<dl>
|
|
27
|
+
<dd>
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
await client.agents.listAgents();
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
</dd>
|
|
34
|
+
</dl>
|
|
35
|
+
</dd>
|
|
36
|
+
</dl>
|
|
37
|
+
|
|
38
|
+
#### ⚙️ Parameters
|
|
39
|
+
|
|
40
|
+
<dl>
|
|
41
|
+
<dd>
|
|
42
|
+
|
|
43
|
+
<dl>
|
|
44
|
+
<dd>
|
|
45
|
+
|
|
46
|
+
**request:** `AgentPhone.ListAgentsV1AgentsGetRequest`
|
|
47
|
+
|
|
48
|
+
</dd>
|
|
49
|
+
</dl>
|
|
50
|
+
|
|
51
|
+
<dl>
|
|
52
|
+
<dd>
|
|
53
|
+
|
|
54
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
55
|
+
|
|
56
|
+
</dd>
|
|
57
|
+
</dl>
|
|
58
|
+
</dd>
|
|
59
|
+
</dl>
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
</dd>
|
|
63
|
+
</dl>
|
|
64
|
+
</details>
|
|
65
|
+
|
|
66
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">createAgent</a>({ ...params }) -> AgentPhone.AgentResponse</code></summary>
|
|
67
|
+
<dl>
|
|
68
|
+
<dd>
|
|
69
|
+
|
|
70
|
+
#### 📝 Description
|
|
71
|
+
|
|
72
|
+
<dl>
|
|
73
|
+
<dd>
|
|
74
|
+
|
|
75
|
+
<dl>
|
|
76
|
+
<dd>
|
|
77
|
+
|
|
78
|
+
Create a new agent.
|
|
79
|
+
|
|
80
|
+
An agent represents an AI persona (Support Bot, Sales Agent, etc.)
|
|
81
|
+
that can have phone numbers attached to it.
|
|
82
|
+
|
|
83
|
+
voiceMode: "webhook" (default) forwards transcripts to your webhook.
|
|
84
|
+
"hosted" uses a built-in LLM with systemPrompt (no webhook needed).
|
|
85
|
+
</dd>
|
|
86
|
+
</dl>
|
|
87
|
+
</dd>
|
|
88
|
+
</dl>
|
|
89
|
+
|
|
90
|
+
#### 🔌 Usage
|
|
91
|
+
|
|
92
|
+
<dl>
|
|
93
|
+
<dd>
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dd>
|
|
97
|
+
|
|
98
|
+
```typescript
|
|
99
|
+
await client.agents.createAgent({
|
|
100
|
+
name: "name"
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
```
|
|
104
|
+
</dd>
|
|
105
|
+
</dl>
|
|
106
|
+
</dd>
|
|
107
|
+
</dl>
|
|
108
|
+
|
|
109
|
+
#### ⚙️ Parameters
|
|
110
|
+
|
|
111
|
+
<dl>
|
|
112
|
+
<dd>
|
|
113
|
+
|
|
114
|
+
<dl>
|
|
115
|
+
<dd>
|
|
116
|
+
|
|
117
|
+
**request:** `AgentPhone.CreateAgentRequest`
|
|
118
|
+
|
|
119
|
+
</dd>
|
|
120
|
+
</dl>
|
|
121
|
+
|
|
122
|
+
<dl>
|
|
123
|
+
<dd>
|
|
124
|
+
|
|
125
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
126
|
+
|
|
127
|
+
</dd>
|
|
128
|
+
</dl>
|
|
129
|
+
</dd>
|
|
130
|
+
</dl>
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
</dd>
|
|
134
|
+
</dl>
|
|
135
|
+
</details>
|
|
136
|
+
|
|
137
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">getAgent</a>({ ...params }) -> AgentPhone.AgentResponse</code></summary>
|
|
138
|
+
<dl>
|
|
139
|
+
<dd>
|
|
140
|
+
|
|
141
|
+
#### 📝 Description
|
|
142
|
+
|
|
143
|
+
<dl>
|
|
144
|
+
<dd>
|
|
145
|
+
|
|
146
|
+
<dl>
|
|
147
|
+
<dd>
|
|
148
|
+
|
|
149
|
+
Get a single agent with its attached numbers.
|
|
150
|
+
</dd>
|
|
151
|
+
</dl>
|
|
152
|
+
</dd>
|
|
153
|
+
</dl>
|
|
154
|
+
|
|
155
|
+
#### 🔌 Usage
|
|
156
|
+
|
|
157
|
+
<dl>
|
|
158
|
+
<dd>
|
|
159
|
+
|
|
160
|
+
<dl>
|
|
161
|
+
<dd>
|
|
162
|
+
|
|
163
|
+
```typescript
|
|
164
|
+
await client.agents.getAgent({
|
|
165
|
+
agent_id: "agent_id"
|
|
166
|
+
});
|
|
167
|
+
|
|
168
|
+
```
|
|
169
|
+
</dd>
|
|
170
|
+
</dl>
|
|
171
|
+
</dd>
|
|
172
|
+
</dl>
|
|
173
|
+
|
|
174
|
+
#### ⚙️ Parameters
|
|
175
|
+
|
|
176
|
+
<dl>
|
|
177
|
+
<dd>
|
|
178
|
+
|
|
179
|
+
<dl>
|
|
180
|
+
<dd>
|
|
181
|
+
|
|
182
|
+
**request:** `AgentPhone.GetAgentV1AgentsAgentIdGetRequest`
|
|
183
|
+
|
|
184
|
+
</dd>
|
|
185
|
+
</dl>
|
|
186
|
+
|
|
187
|
+
<dl>
|
|
188
|
+
<dd>
|
|
189
|
+
|
|
190
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
191
|
+
|
|
192
|
+
</dd>
|
|
193
|
+
</dl>
|
|
194
|
+
</dd>
|
|
195
|
+
</dl>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
</dd>
|
|
199
|
+
</dl>
|
|
200
|
+
</details>
|
|
201
|
+
|
|
202
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">deleteAgent</a>({ ...params }) -> AgentPhone.DeleteAgentResponse</code></summary>
|
|
203
|
+
<dl>
|
|
204
|
+
<dd>
|
|
205
|
+
|
|
206
|
+
#### 📝 Description
|
|
207
|
+
|
|
208
|
+
<dl>
|
|
209
|
+
<dd>
|
|
210
|
+
|
|
211
|
+
<dl>
|
|
212
|
+
<dd>
|
|
213
|
+
|
|
214
|
+
Delete an agent.
|
|
215
|
+
|
|
216
|
+
Phone numbers, conversations, and calls associated with the agent will have their
|
|
217
|
+
agent reference cleared (set to null) but will not be deleted themselves.
|
|
218
|
+
</dd>
|
|
219
|
+
</dl>
|
|
220
|
+
</dd>
|
|
221
|
+
</dl>
|
|
222
|
+
|
|
223
|
+
#### 🔌 Usage
|
|
224
|
+
|
|
225
|
+
<dl>
|
|
226
|
+
<dd>
|
|
227
|
+
|
|
228
|
+
<dl>
|
|
229
|
+
<dd>
|
|
230
|
+
|
|
231
|
+
```typescript
|
|
232
|
+
await client.agents.deleteAgent({
|
|
233
|
+
agent_id: "agent_id"
|
|
234
|
+
});
|
|
235
|
+
|
|
236
|
+
```
|
|
237
|
+
</dd>
|
|
238
|
+
</dl>
|
|
239
|
+
</dd>
|
|
240
|
+
</dl>
|
|
241
|
+
|
|
242
|
+
#### ⚙️ Parameters
|
|
243
|
+
|
|
244
|
+
<dl>
|
|
245
|
+
<dd>
|
|
246
|
+
|
|
247
|
+
<dl>
|
|
248
|
+
<dd>
|
|
249
|
+
|
|
250
|
+
**request:** `AgentPhone.DeleteAgentV1AgentsAgentIdDeleteRequest`
|
|
251
|
+
|
|
252
|
+
</dd>
|
|
253
|
+
</dl>
|
|
254
|
+
|
|
255
|
+
<dl>
|
|
256
|
+
<dd>
|
|
257
|
+
|
|
258
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
259
|
+
|
|
260
|
+
</dd>
|
|
261
|
+
</dl>
|
|
262
|
+
</dd>
|
|
263
|
+
</dl>
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
</dd>
|
|
267
|
+
</dl>
|
|
268
|
+
</details>
|
|
269
|
+
|
|
270
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">updateAgent</a>({ ...params }) -> AgentPhone.AgentResponse</code></summary>
|
|
271
|
+
<dl>
|
|
272
|
+
<dd>
|
|
273
|
+
|
|
274
|
+
#### 📝 Description
|
|
275
|
+
|
|
276
|
+
<dl>
|
|
277
|
+
<dd>
|
|
278
|
+
|
|
279
|
+
<dl>
|
|
280
|
+
<dd>
|
|
281
|
+
|
|
282
|
+
Update an agent's configuration.
|
|
283
|
+
|
|
284
|
+
Use this to change voice mode, system prompt, greeting, or voice.
|
|
285
|
+
Switching voiceMode to "hosted" re-provisions the Retell agent with built-in LLM.
|
|
286
|
+
</dd>
|
|
287
|
+
</dl>
|
|
288
|
+
</dd>
|
|
289
|
+
</dl>
|
|
290
|
+
|
|
291
|
+
#### 🔌 Usage
|
|
292
|
+
|
|
293
|
+
<dl>
|
|
294
|
+
<dd>
|
|
295
|
+
|
|
296
|
+
<dl>
|
|
297
|
+
<dd>
|
|
298
|
+
|
|
299
|
+
```typescript
|
|
300
|
+
await client.agents.updateAgent({
|
|
301
|
+
agent_id: "agent_id"
|
|
302
|
+
});
|
|
303
|
+
|
|
304
|
+
```
|
|
305
|
+
</dd>
|
|
306
|
+
</dl>
|
|
307
|
+
</dd>
|
|
308
|
+
</dl>
|
|
309
|
+
|
|
310
|
+
#### ⚙️ Parameters
|
|
311
|
+
|
|
312
|
+
<dl>
|
|
313
|
+
<dd>
|
|
314
|
+
|
|
315
|
+
<dl>
|
|
316
|
+
<dd>
|
|
317
|
+
|
|
318
|
+
**request:** `AgentPhone.UpdateAgentRequest`
|
|
319
|
+
|
|
320
|
+
</dd>
|
|
321
|
+
</dl>
|
|
322
|
+
|
|
323
|
+
<dl>
|
|
324
|
+
<dd>
|
|
325
|
+
|
|
326
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
327
|
+
|
|
328
|
+
</dd>
|
|
329
|
+
</dl>
|
|
330
|
+
</dd>
|
|
331
|
+
</dl>
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
</dd>
|
|
335
|
+
</dl>
|
|
336
|
+
</details>
|
|
337
|
+
|
|
338
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">attachNumberToAgent</a>({ ...params }) -> AgentPhone.AttachNumberResponse</code></summary>
|
|
339
|
+
<dl>
|
|
340
|
+
<dd>
|
|
341
|
+
|
|
342
|
+
#### 📝 Description
|
|
343
|
+
|
|
344
|
+
<dl>
|
|
345
|
+
<dd>
|
|
346
|
+
|
|
347
|
+
<dl>
|
|
348
|
+
<dd>
|
|
349
|
+
|
|
350
|
+
Attach an existing phone number to an agent.
|
|
351
|
+
|
|
352
|
+
The number must belong to the same project and not be released.
|
|
353
|
+
</dd>
|
|
354
|
+
</dl>
|
|
355
|
+
</dd>
|
|
356
|
+
</dl>
|
|
357
|
+
|
|
358
|
+
#### 🔌 Usage
|
|
359
|
+
|
|
360
|
+
<dl>
|
|
361
|
+
<dd>
|
|
362
|
+
|
|
363
|
+
<dl>
|
|
364
|
+
<dd>
|
|
365
|
+
|
|
366
|
+
```typescript
|
|
367
|
+
await client.agents.attachNumberToAgent({
|
|
368
|
+
agent_id: "agent_id",
|
|
369
|
+
numberId: "numberId"
|
|
370
|
+
});
|
|
371
|
+
|
|
372
|
+
```
|
|
373
|
+
</dd>
|
|
374
|
+
</dl>
|
|
375
|
+
</dd>
|
|
376
|
+
</dl>
|
|
377
|
+
|
|
378
|
+
#### ⚙️ Parameters
|
|
379
|
+
|
|
380
|
+
<dl>
|
|
381
|
+
<dd>
|
|
382
|
+
|
|
383
|
+
<dl>
|
|
384
|
+
<dd>
|
|
385
|
+
|
|
386
|
+
**request:** `AgentPhone.AttachNumberRequest`
|
|
387
|
+
|
|
388
|
+
</dd>
|
|
389
|
+
</dl>
|
|
390
|
+
|
|
391
|
+
<dl>
|
|
392
|
+
<dd>
|
|
393
|
+
|
|
394
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
395
|
+
|
|
396
|
+
</dd>
|
|
397
|
+
</dl>
|
|
398
|
+
</dd>
|
|
399
|
+
</dl>
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
</dd>
|
|
403
|
+
</dl>
|
|
404
|
+
</details>
|
|
405
|
+
|
|
406
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">listAgentConversations</a>({ ...params }) -> AgentPhone.AppRoutesAgentsConversationListResponse</code></summary>
|
|
407
|
+
<dl>
|
|
408
|
+
<dd>
|
|
409
|
+
|
|
410
|
+
#### 📝 Description
|
|
411
|
+
|
|
412
|
+
<dl>
|
|
413
|
+
<dd>
|
|
414
|
+
|
|
415
|
+
<dl>
|
|
416
|
+
<dd>
|
|
417
|
+
|
|
418
|
+
List all conversations for an agent.
|
|
419
|
+
</dd>
|
|
420
|
+
</dl>
|
|
421
|
+
</dd>
|
|
422
|
+
</dl>
|
|
423
|
+
|
|
424
|
+
#### 🔌 Usage
|
|
425
|
+
|
|
426
|
+
<dl>
|
|
427
|
+
<dd>
|
|
428
|
+
|
|
429
|
+
<dl>
|
|
430
|
+
<dd>
|
|
431
|
+
|
|
432
|
+
```typescript
|
|
433
|
+
await client.agents.listAgentConversations({
|
|
434
|
+
agent_id: "agent_id"
|
|
435
|
+
});
|
|
436
|
+
|
|
437
|
+
```
|
|
438
|
+
</dd>
|
|
439
|
+
</dl>
|
|
440
|
+
</dd>
|
|
441
|
+
</dl>
|
|
442
|
+
|
|
443
|
+
#### ⚙️ Parameters
|
|
444
|
+
|
|
445
|
+
<dl>
|
|
446
|
+
<dd>
|
|
447
|
+
|
|
448
|
+
<dl>
|
|
449
|
+
<dd>
|
|
450
|
+
|
|
451
|
+
**request:** `AgentPhone.ListAgentConversationsV1AgentsAgentIdConversationsGetRequest`
|
|
452
|
+
|
|
453
|
+
</dd>
|
|
454
|
+
</dl>
|
|
455
|
+
|
|
456
|
+
<dl>
|
|
457
|
+
<dd>
|
|
458
|
+
|
|
459
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
460
|
+
|
|
461
|
+
</dd>
|
|
462
|
+
</dl>
|
|
463
|
+
</dd>
|
|
464
|
+
</dl>
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
</dd>
|
|
468
|
+
</dl>
|
|
469
|
+
</details>
|
|
470
|
+
|
|
471
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">listAgentCalls</a>({ ...params }) -> AgentPhone.CallListResponse</code></summary>
|
|
472
|
+
<dl>
|
|
473
|
+
<dd>
|
|
474
|
+
|
|
475
|
+
#### 📝 Description
|
|
476
|
+
|
|
477
|
+
<dl>
|
|
478
|
+
<dd>
|
|
479
|
+
|
|
480
|
+
<dl>
|
|
481
|
+
<dd>
|
|
482
|
+
|
|
483
|
+
List all calls for an agent.
|
|
484
|
+
</dd>
|
|
485
|
+
</dl>
|
|
486
|
+
</dd>
|
|
487
|
+
</dl>
|
|
488
|
+
|
|
489
|
+
#### 🔌 Usage
|
|
490
|
+
|
|
491
|
+
<dl>
|
|
492
|
+
<dd>
|
|
493
|
+
|
|
494
|
+
<dl>
|
|
495
|
+
<dd>
|
|
496
|
+
|
|
497
|
+
```typescript
|
|
498
|
+
await client.agents.listAgentCalls({
|
|
499
|
+
agent_id: "agent_id"
|
|
500
|
+
});
|
|
501
|
+
|
|
502
|
+
```
|
|
503
|
+
</dd>
|
|
504
|
+
</dl>
|
|
505
|
+
</dd>
|
|
506
|
+
</dl>
|
|
507
|
+
|
|
508
|
+
#### ⚙️ Parameters
|
|
509
|
+
|
|
510
|
+
<dl>
|
|
511
|
+
<dd>
|
|
512
|
+
|
|
513
|
+
<dl>
|
|
514
|
+
<dd>
|
|
515
|
+
|
|
516
|
+
**request:** `AgentPhone.ListAgentCallsV1AgentsAgentIdCallsGetRequest`
|
|
517
|
+
|
|
518
|
+
</dd>
|
|
519
|
+
</dl>
|
|
520
|
+
|
|
521
|
+
<dl>
|
|
522
|
+
<dd>
|
|
523
|
+
|
|
524
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
525
|
+
|
|
526
|
+
</dd>
|
|
527
|
+
</dl>
|
|
528
|
+
</dd>
|
|
529
|
+
</dl>
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
</dd>
|
|
533
|
+
</dl>
|
|
534
|
+
</details>
|
|
535
|
+
|
|
536
|
+
## Numbers
|
|
537
|
+
<details><summary><code>client.numbers.<a href="/src/api/resources/numbers/client/Client.ts">listNumbers</a>({ ...params }) -> AgentPhone.PhoneNumberListResponse</code></summary>
|
|
538
|
+
<dl>
|
|
539
|
+
<dd>
|
|
540
|
+
|
|
541
|
+
#### 📝 Description
|
|
542
|
+
|
|
543
|
+
<dl>
|
|
544
|
+
<dd>
|
|
545
|
+
|
|
546
|
+
<dl>
|
|
547
|
+
<dd>
|
|
548
|
+
|
|
549
|
+
List all phone numbers for this project.
|
|
550
|
+
</dd>
|
|
551
|
+
</dl>
|
|
552
|
+
</dd>
|
|
553
|
+
</dl>
|
|
554
|
+
|
|
555
|
+
#### 🔌 Usage
|
|
556
|
+
|
|
557
|
+
<dl>
|
|
558
|
+
<dd>
|
|
559
|
+
|
|
560
|
+
<dl>
|
|
561
|
+
<dd>
|
|
562
|
+
|
|
563
|
+
```typescript
|
|
564
|
+
await client.numbers.listNumbers();
|
|
565
|
+
|
|
566
|
+
```
|
|
567
|
+
</dd>
|
|
568
|
+
</dl>
|
|
569
|
+
</dd>
|
|
570
|
+
</dl>
|
|
571
|
+
|
|
572
|
+
#### ⚙️ Parameters
|
|
573
|
+
|
|
574
|
+
<dl>
|
|
575
|
+
<dd>
|
|
576
|
+
|
|
577
|
+
<dl>
|
|
578
|
+
<dd>
|
|
579
|
+
|
|
580
|
+
**request:** `AgentPhone.ListNumbersV1NumbersGetRequest`
|
|
581
|
+
|
|
582
|
+
</dd>
|
|
583
|
+
</dl>
|
|
584
|
+
|
|
585
|
+
<dl>
|
|
586
|
+
<dd>
|
|
587
|
+
|
|
588
|
+
**requestOptions:** `NumbersClient.RequestOptions`
|
|
589
|
+
|
|
590
|
+
</dd>
|
|
591
|
+
</dl>
|
|
592
|
+
</dd>
|
|
593
|
+
</dl>
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
</dd>
|
|
597
|
+
</dl>
|
|
598
|
+
</details>
|
|
599
|
+
|
|
600
|
+
<details><summary><code>client.numbers.<a href="/src/api/resources/numbers/client/Client.ts">createNumber</a>({ ...params }) -> AgentPhone.PhoneNumberResponse</code></summary>
|
|
601
|
+
<dl>
|
|
602
|
+
<dd>
|
|
603
|
+
|
|
604
|
+
#### 📝 Description
|
|
605
|
+
|
|
606
|
+
<dl>
|
|
607
|
+
<dd>
|
|
608
|
+
|
|
609
|
+
<dl>
|
|
610
|
+
<dd>
|
|
611
|
+
|
|
612
|
+
Provision a new SMS-enabled phone number.
|
|
613
|
+
|
|
614
|
+
1. Check number limit (lifetime limit)
|
|
615
|
+
2. Search Twilio for available numbers
|
|
616
|
+
3. Purchase the first available one
|
|
617
|
+
4. Configure webhook URL
|
|
618
|
+
5. Store in our database
|
|
619
|
+
</dd>
|
|
620
|
+
</dl>
|
|
621
|
+
</dd>
|
|
622
|
+
</dl>
|
|
623
|
+
|
|
624
|
+
#### 🔌 Usage
|
|
625
|
+
|
|
626
|
+
<dl>
|
|
627
|
+
<dd>
|
|
628
|
+
|
|
629
|
+
<dl>
|
|
630
|
+
<dd>
|
|
631
|
+
|
|
632
|
+
```typescript
|
|
633
|
+
await client.numbers.createNumber();
|
|
634
|
+
|
|
635
|
+
```
|
|
636
|
+
</dd>
|
|
637
|
+
</dl>
|
|
638
|
+
</dd>
|
|
639
|
+
</dl>
|
|
640
|
+
|
|
641
|
+
#### ⚙️ Parameters
|
|
642
|
+
|
|
643
|
+
<dl>
|
|
644
|
+
<dd>
|
|
645
|
+
|
|
646
|
+
<dl>
|
|
647
|
+
<dd>
|
|
648
|
+
|
|
649
|
+
**request:** `AgentPhone.CreateNumberRequest`
|
|
650
|
+
|
|
651
|
+
</dd>
|
|
652
|
+
</dl>
|
|
653
|
+
|
|
654
|
+
<dl>
|
|
655
|
+
<dd>
|
|
656
|
+
|
|
657
|
+
**requestOptions:** `NumbersClient.RequestOptions`
|
|
658
|
+
|
|
659
|
+
</dd>
|
|
660
|
+
</dl>
|
|
661
|
+
</dd>
|
|
662
|
+
</dl>
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
</dd>
|
|
666
|
+
</dl>
|
|
667
|
+
</details>
|
|
668
|
+
|
|
669
|
+
<details><summary><code>client.numbers.<a href="/src/api/resources/numbers/client/Client.ts">getMessages</a>({ ...params }) -> AgentPhone.MessageListResponse</code></summary>
|
|
670
|
+
<dl>
|
|
671
|
+
<dd>
|
|
672
|
+
|
|
673
|
+
#### 📝 Description
|
|
674
|
+
|
|
675
|
+
<dl>
|
|
676
|
+
<dd>
|
|
677
|
+
|
|
678
|
+
<dl>
|
|
679
|
+
<dd>
|
|
680
|
+
|
|
681
|
+
Get messages for a specific phone number.
|
|
682
|
+
|
|
683
|
+
Supports cursor-based pagination via before/after timestamps.
|
|
684
|
+
</dd>
|
|
685
|
+
</dl>
|
|
686
|
+
</dd>
|
|
687
|
+
</dl>
|
|
688
|
+
|
|
689
|
+
#### 🔌 Usage
|
|
690
|
+
|
|
691
|
+
<dl>
|
|
692
|
+
<dd>
|
|
693
|
+
|
|
694
|
+
<dl>
|
|
695
|
+
<dd>
|
|
696
|
+
|
|
697
|
+
```typescript
|
|
698
|
+
await client.numbers.getMessages({
|
|
699
|
+
number_id: "number_id"
|
|
700
|
+
});
|
|
701
|
+
|
|
702
|
+
```
|
|
703
|
+
</dd>
|
|
704
|
+
</dl>
|
|
705
|
+
</dd>
|
|
706
|
+
</dl>
|
|
707
|
+
|
|
708
|
+
#### ⚙️ Parameters
|
|
709
|
+
|
|
710
|
+
<dl>
|
|
711
|
+
<dd>
|
|
712
|
+
|
|
713
|
+
<dl>
|
|
714
|
+
<dd>
|
|
715
|
+
|
|
716
|
+
**request:** `AgentPhone.GetMessagesV1NumbersNumberIdMessagesGetRequest`
|
|
717
|
+
|
|
718
|
+
</dd>
|
|
719
|
+
</dl>
|
|
720
|
+
|
|
721
|
+
<dl>
|
|
722
|
+
<dd>
|
|
723
|
+
|
|
724
|
+
**requestOptions:** `NumbersClient.RequestOptions`
|
|
725
|
+
|
|
726
|
+
</dd>
|
|
727
|
+
</dl>
|
|
728
|
+
</dd>
|
|
729
|
+
</dl>
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
</dd>
|
|
733
|
+
</dl>
|
|
734
|
+
</details>
|
|
735
|
+
|
|
736
|
+
<details><summary><code>client.numbers.<a href="/src/api/resources/numbers/client/Client.ts">deleteNumber</a>({ ...params }) -> unknown</code></summary>
|
|
737
|
+
<dl>
|
|
738
|
+
<dd>
|
|
739
|
+
|
|
740
|
+
#### 📝 Description
|
|
741
|
+
|
|
742
|
+
<dl>
|
|
743
|
+
<dd>
|
|
744
|
+
|
|
745
|
+
<dl>
|
|
746
|
+
<dd>
|
|
747
|
+
|
|
748
|
+
Release (delete) a phone number.
|
|
749
|
+
|
|
750
|
+
This will:
|
|
751
|
+
1. Release the number from Twilio (number goes back to Twilio's pool)
|
|
752
|
+
2. Mark the number as "released" in the database
|
|
753
|
+
3. Keep all messages and conversation history (for audit purposes)
|
|
754
|
+
|
|
755
|
+
WARNING: This action is irreversible! The number cannot be recovered.
|
|
756
|
+
</dd>
|
|
757
|
+
</dl>
|
|
758
|
+
</dd>
|
|
759
|
+
</dl>
|
|
760
|
+
|
|
761
|
+
#### 🔌 Usage
|
|
762
|
+
|
|
763
|
+
<dl>
|
|
764
|
+
<dd>
|
|
765
|
+
|
|
766
|
+
<dl>
|
|
767
|
+
<dd>
|
|
768
|
+
|
|
769
|
+
```typescript
|
|
770
|
+
await client.numbers.deleteNumber({
|
|
771
|
+
number_id: "number_id"
|
|
772
|
+
});
|
|
773
|
+
|
|
774
|
+
```
|
|
775
|
+
</dd>
|
|
776
|
+
</dl>
|
|
777
|
+
</dd>
|
|
778
|
+
</dl>
|
|
779
|
+
|
|
780
|
+
#### ⚙️ Parameters
|
|
781
|
+
|
|
782
|
+
<dl>
|
|
783
|
+
<dd>
|
|
784
|
+
|
|
785
|
+
<dl>
|
|
786
|
+
<dd>
|
|
787
|
+
|
|
788
|
+
**request:** `AgentPhone.DeleteNumberV1NumbersNumberIdDeleteRequest`
|
|
789
|
+
|
|
790
|
+
</dd>
|
|
791
|
+
</dl>
|
|
792
|
+
|
|
793
|
+
<dl>
|
|
794
|
+
<dd>
|
|
795
|
+
|
|
796
|
+
**requestOptions:** `NumbersClient.RequestOptions`
|
|
797
|
+
|
|
798
|
+
</dd>
|
|
799
|
+
</dl>
|
|
800
|
+
</dd>
|
|
801
|
+
</dl>
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
</dd>
|
|
805
|
+
</dl>
|
|
806
|
+
</details>
|
|
807
|
+
|
|
808
|
+
## Webhooks
|
|
809
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getWebhook</a>() -> AgentPhone.WebhookResponse | null</code></summary>
|
|
810
|
+
<dl>
|
|
811
|
+
<dd>
|
|
812
|
+
|
|
813
|
+
#### 📝 Description
|
|
814
|
+
|
|
815
|
+
<dl>
|
|
816
|
+
<dd>
|
|
817
|
+
|
|
818
|
+
<dl>
|
|
819
|
+
<dd>
|
|
820
|
+
|
|
821
|
+
Get the webhook configuration for this project.
|
|
822
|
+
</dd>
|
|
823
|
+
</dl>
|
|
824
|
+
</dd>
|
|
825
|
+
</dl>
|
|
826
|
+
|
|
827
|
+
#### 🔌 Usage
|
|
828
|
+
|
|
829
|
+
<dl>
|
|
830
|
+
<dd>
|
|
831
|
+
|
|
832
|
+
<dl>
|
|
833
|
+
<dd>
|
|
834
|
+
|
|
835
|
+
```typescript
|
|
836
|
+
await client.webhooks.getWebhook();
|
|
837
|
+
|
|
838
|
+
```
|
|
839
|
+
</dd>
|
|
840
|
+
</dl>
|
|
841
|
+
</dd>
|
|
842
|
+
</dl>
|
|
843
|
+
|
|
844
|
+
#### ⚙️ Parameters
|
|
845
|
+
|
|
846
|
+
<dl>
|
|
847
|
+
<dd>
|
|
848
|
+
|
|
849
|
+
<dl>
|
|
850
|
+
<dd>
|
|
851
|
+
|
|
852
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
853
|
+
|
|
854
|
+
</dd>
|
|
855
|
+
</dl>
|
|
856
|
+
</dd>
|
|
857
|
+
</dl>
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
</dd>
|
|
861
|
+
</dl>
|
|
862
|
+
</details>
|
|
863
|
+
|
|
864
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">createOrUpdateWebhook</a>({ ...params }) -> AgentPhone.WebhookResponse</code></summary>
|
|
865
|
+
<dl>
|
|
866
|
+
<dd>
|
|
867
|
+
|
|
868
|
+
#### 📝 Description
|
|
869
|
+
|
|
870
|
+
<dl>
|
|
871
|
+
<dd>
|
|
872
|
+
|
|
873
|
+
<dl>
|
|
874
|
+
<dd>
|
|
875
|
+
|
|
876
|
+
Register or update the webhook URL for this project.
|
|
877
|
+
|
|
878
|
+
If a webhook already exists, it will be updated.
|
|
879
|
+
A new secret is generated each time.
|
|
880
|
+
|
|
881
|
+
contextLimit: Number of recent messages to include in webhook payloads (0-50, default: 10).
|
|
882
|
+
Set to 0 to disable history in webhooks.
|
|
883
|
+
</dd>
|
|
884
|
+
</dl>
|
|
885
|
+
</dd>
|
|
886
|
+
</dl>
|
|
887
|
+
|
|
888
|
+
#### 🔌 Usage
|
|
889
|
+
|
|
890
|
+
<dl>
|
|
891
|
+
<dd>
|
|
892
|
+
|
|
893
|
+
<dl>
|
|
894
|
+
<dd>
|
|
895
|
+
|
|
896
|
+
```typescript
|
|
897
|
+
await client.webhooks.createOrUpdateWebhook({
|
|
898
|
+
url: "url"
|
|
899
|
+
});
|
|
900
|
+
|
|
901
|
+
```
|
|
902
|
+
</dd>
|
|
903
|
+
</dl>
|
|
904
|
+
</dd>
|
|
905
|
+
</dl>
|
|
906
|
+
|
|
907
|
+
#### ⚙️ Parameters
|
|
908
|
+
|
|
909
|
+
<dl>
|
|
910
|
+
<dd>
|
|
911
|
+
|
|
912
|
+
<dl>
|
|
913
|
+
<dd>
|
|
914
|
+
|
|
915
|
+
**request:** `AgentPhone.WebhookCreateRequest`
|
|
916
|
+
|
|
917
|
+
</dd>
|
|
918
|
+
</dl>
|
|
919
|
+
|
|
920
|
+
<dl>
|
|
921
|
+
<dd>
|
|
922
|
+
|
|
923
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
924
|
+
|
|
925
|
+
</dd>
|
|
926
|
+
</dl>
|
|
927
|
+
</dd>
|
|
928
|
+
</dl>
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
</dd>
|
|
932
|
+
</dl>
|
|
933
|
+
</details>
|
|
934
|
+
|
|
935
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">deleteWebhook</a>() -> unknown</code></summary>
|
|
936
|
+
<dl>
|
|
937
|
+
<dd>
|
|
938
|
+
|
|
939
|
+
#### 📝 Description
|
|
940
|
+
|
|
941
|
+
<dl>
|
|
942
|
+
<dd>
|
|
943
|
+
|
|
944
|
+
<dl>
|
|
945
|
+
<dd>
|
|
946
|
+
|
|
947
|
+
Remove the webhook for this project.
|
|
948
|
+
</dd>
|
|
949
|
+
</dl>
|
|
950
|
+
</dd>
|
|
951
|
+
</dl>
|
|
952
|
+
|
|
953
|
+
#### 🔌 Usage
|
|
954
|
+
|
|
955
|
+
<dl>
|
|
956
|
+
<dd>
|
|
957
|
+
|
|
958
|
+
<dl>
|
|
959
|
+
<dd>
|
|
960
|
+
|
|
961
|
+
```typescript
|
|
962
|
+
await client.webhooks.deleteWebhook();
|
|
963
|
+
|
|
964
|
+
```
|
|
965
|
+
</dd>
|
|
966
|
+
</dl>
|
|
967
|
+
</dd>
|
|
968
|
+
</dl>
|
|
969
|
+
|
|
970
|
+
#### ⚙️ Parameters
|
|
971
|
+
|
|
972
|
+
<dl>
|
|
973
|
+
<dd>
|
|
974
|
+
|
|
975
|
+
<dl>
|
|
976
|
+
<dd>
|
|
977
|
+
|
|
978
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
979
|
+
|
|
980
|
+
</dd>
|
|
981
|
+
</dl>
|
|
982
|
+
</dd>
|
|
983
|
+
</dl>
|
|
984
|
+
|
|
985
|
+
|
|
986
|
+
</dd>
|
|
987
|
+
</dl>
|
|
988
|
+
</details>
|
|
989
|
+
|
|
990
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">listDeliveries</a>({ ...params }) -> AgentPhone.WebhookDeliveryResponse[]</code></summary>
|
|
991
|
+
<dl>
|
|
992
|
+
<dd>
|
|
993
|
+
|
|
994
|
+
#### 📝 Description
|
|
995
|
+
|
|
996
|
+
<dl>
|
|
997
|
+
<dd>
|
|
998
|
+
|
|
999
|
+
<dl>
|
|
1000
|
+
<dd>
|
|
1001
|
+
|
|
1002
|
+
Get recent webhook delivery attempts.
|
|
1003
|
+
</dd>
|
|
1004
|
+
</dl>
|
|
1005
|
+
</dd>
|
|
1006
|
+
</dl>
|
|
1007
|
+
|
|
1008
|
+
#### 🔌 Usage
|
|
1009
|
+
|
|
1010
|
+
<dl>
|
|
1011
|
+
<dd>
|
|
1012
|
+
|
|
1013
|
+
<dl>
|
|
1014
|
+
<dd>
|
|
1015
|
+
|
|
1016
|
+
```typescript
|
|
1017
|
+
await client.webhooks.listDeliveries();
|
|
1018
|
+
|
|
1019
|
+
```
|
|
1020
|
+
</dd>
|
|
1021
|
+
</dl>
|
|
1022
|
+
</dd>
|
|
1023
|
+
</dl>
|
|
1024
|
+
|
|
1025
|
+
#### ⚙️ Parameters
|
|
1026
|
+
|
|
1027
|
+
<dl>
|
|
1028
|
+
<dd>
|
|
1029
|
+
|
|
1030
|
+
<dl>
|
|
1031
|
+
<dd>
|
|
1032
|
+
|
|
1033
|
+
**request:** `AgentPhone.ListDeliveriesV1WebhooksDeliveriesGetRequest`
|
|
1034
|
+
|
|
1035
|
+
</dd>
|
|
1036
|
+
</dl>
|
|
1037
|
+
|
|
1038
|
+
<dl>
|
|
1039
|
+
<dd>
|
|
1040
|
+
|
|
1041
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1042
|
+
|
|
1043
|
+
</dd>
|
|
1044
|
+
</dl>
|
|
1045
|
+
</dd>
|
|
1046
|
+
</dl>
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
</dd>
|
|
1050
|
+
</dl>
|
|
1051
|
+
</details>
|
|
1052
|
+
|
|
1053
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">testWebhook</a>() -> unknown</code></summary>
|
|
1054
|
+
<dl>
|
|
1055
|
+
<dd>
|
|
1056
|
+
|
|
1057
|
+
#### 📝 Description
|
|
1058
|
+
|
|
1059
|
+
<dl>
|
|
1060
|
+
<dd>
|
|
1061
|
+
|
|
1062
|
+
<dl>
|
|
1063
|
+
<dd>
|
|
1064
|
+
|
|
1065
|
+
Send a test webhook to verify the endpoint is working.
|
|
1066
|
+
|
|
1067
|
+
Sends a fake message payload to the configured URL.
|
|
1068
|
+
</dd>
|
|
1069
|
+
</dl>
|
|
1070
|
+
</dd>
|
|
1071
|
+
</dl>
|
|
1072
|
+
|
|
1073
|
+
#### 🔌 Usage
|
|
1074
|
+
|
|
1075
|
+
<dl>
|
|
1076
|
+
<dd>
|
|
1077
|
+
|
|
1078
|
+
<dl>
|
|
1079
|
+
<dd>
|
|
1080
|
+
|
|
1081
|
+
```typescript
|
|
1082
|
+
await client.webhooks.testWebhook();
|
|
1083
|
+
|
|
1084
|
+
```
|
|
1085
|
+
</dd>
|
|
1086
|
+
</dl>
|
|
1087
|
+
</dd>
|
|
1088
|
+
</dl>
|
|
1089
|
+
|
|
1090
|
+
#### ⚙️ Parameters
|
|
1091
|
+
|
|
1092
|
+
<dl>
|
|
1093
|
+
<dd>
|
|
1094
|
+
|
|
1095
|
+
<dl>
|
|
1096
|
+
<dd>
|
|
1097
|
+
|
|
1098
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1099
|
+
|
|
1100
|
+
</dd>
|
|
1101
|
+
</dl>
|
|
1102
|
+
</dd>
|
|
1103
|
+
</dl>
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
</dd>
|
|
1107
|
+
</dl>
|
|
1108
|
+
</details>
|
|
1109
|
+
|
|
1110
|
+
## Conversations
|
|
1111
|
+
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">listConversations</a>({ ...params }) -> AgentPhone.AppRoutesConversationsConversationListResponse</code></summary>
|
|
1112
|
+
<dl>
|
|
1113
|
+
<dd>
|
|
1114
|
+
|
|
1115
|
+
#### 📝 Description
|
|
1116
|
+
|
|
1117
|
+
<dl>
|
|
1118
|
+
<dd>
|
|
1119
|
+
|
|
1120
|
+
<dl>
|
|
1121
|
+
<dd>
|
|
1122
|
+
|
|
1123
|
+
List all conversations for this project.
|
|
1124
|
+
|
|
1125
|
+
Sorted by most recent activity (lastMessageAt desc).
|
|
1126
|
+
</dd>
|
|
1127
|
+
</dl>
|
|
1128
|
+
</dd>
|
|
1129
|
+
</dl>
|
|
1130
|
+
|
|
1131
|
+
#### 🔌 Usage
|
|
1132
|
+
|
|
1133
|
+
<dl>
|
|
1134
|
+
<dd>
|
|
1135
|
+
|
|
1136
|
+
<dl>
|
|
1137
|
+
<dd>
|
|
1138
|
+
|
|
1139
|
+
```typescript
|
|
1140
|
+
await client.conversations.listConversations();
|
|
1141
|
+
|
|
1142
|
+
```
|
|
1143
|
+
</dd>
|
|
1144
|
+
</dl>
|
|
1145
|
+
</dd>
|
|
1146
|
+
</dl>
|
|
1147
|
+
|
|
1148
|
+
#### ⚙️ Parameters
|
|
1149
|
+
|
|
1150
|
+
<dl>
|
|
1151
|
+
<dd>
|
|
1152
|
+
|
|
1153
|
+
<dl>
|
|
1154
|
+
<dd>
|
|
1155
|
+
|
|
1156
|
+
**request:** `AgentPhone.ListConversationsV1ConversationsGetRequest`
|
|
1157
|
+
|
|
1158
|
+
</dd>
|
|
1159
|
+
</dl>
|
|
1160
|
+
|
|
1161
|
+
<dl>
|
|
1162
|
+
<dd>
|
|
1163
|
+
|
|
1164
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
1165
|
+
|
|
1166
|
+
</dd>
|
|
1167
|
+
</dl>
|
|
1168
|
+
</dd>
|
|
1169
|
+
</dl>
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
</dd>
|
|
1173
|
+
</dl>
|
|
1174
|
+
</details>
|
|
1175
|
+
|
|
1176
|
+
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">getConversation</a>({ ...params }) -> AgentPhone.ConversationDetail</code></summary>
|
|
1177
|
+
<dl>
|
|
1178
|
+
<dd>
|
|
1179
|
+
|
|
1180
|
+
#### 📝 Description
|
|
1181
|
+
|
|
1182
|
+
<dl>
|
|
1183
|
+
<dd>
|
|
1184
|
+
|
|
1185
|
+
<dl>
|
|
1186
|
+
<dd>
|
|
1187
|
+
|
|
1188
|
+
Get a conversation with its recent messages.
|
|
1189
|
+
</dd>
|
|
1190
|
+
</dl>
|
|
1191
|
+
</dd>
|
|
1192
|
+
</dl>
|
|
1193
|
+
|
|
1194
|
+
#### 🔌 Usage
|
|
1195
|
+
|
|
1196
|
+
<dl>
|
|
1197
|
+
<dd>
|
|
1198
|
+
|
|
1199
|
+
<dl>
|
|
1200
|
+
<dd>
|
|
1201
|
+
|
|
1202
|
+
```typescript
|
|
1203
|
+
await client.conversations.getConversation({
|
|
1204
|
+
conversation_id: "conversation_id"
|
|
1205
|
+
});
|
|
1206
|
+
|
|
1207
|
+
```
|
|
1208
|
+
</dd>
|
|
1209
|
+
</dl>
|
|
1210
|
+
</dd>
|
|
1211
|
+
</dl>
|
|
1212
|
+
|
|
1213
|
+
#### ⚙️ Parameters
|
|
1214
|
+
|
|
1215
|
+
<dl>
|
|
1216
|
+
<dd>
|
|
1217
|
+
|
|
1218
|
+
<dl>
|
|
1219
|
+
<dd>
|
|
1220
|
+
|
|
1221
|
+
**request:** `AgentPhone.GetConversationV1ConversationsConversationIdGetRequest`
|
|
1222
|
+
|
|
1223
|
+
</dd>
|
|
1224
|
+
</dl>
|
|
1225
|
+
|
|
1226
|
+
<dl>
|
|
1227
|
+
<dd>
|
|
1228
|
+
|
|
1229
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
1230
|
+
|
|
1231
|
+
</dd>
|
|
1232
|
+
</dl>
|
|
1233
|
+
</dd>
|
|
1234
|
+
</dl>
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
</dd>
|
|
1238
|
+
</dl>
|
|
1239
|
+
</details>
|
|
1240
|
+
|
|
1241
|
+
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">updateConversation</a>({ ...params }) -> AgentPhone.ConversationDetail</code></summary>
|
|
1242
|
+
<dl>
|
|
1243
|
+
<dd>
|
|
1244
|
+
|
|
1245
|
+
#### 📝 Description
|
|
1246
|
+
|
|
1247
|
+
<dl>
|
|
1248
|
+
<dd>
|
|
1249
|
+
|
|
1250
|
+
<dl>
|
|
1251
|
+
<dd>
|
|
1252
|
+
|
|
1253
|
+
Update conversation metadata (state).
|
|
1254
|
+
|
|
1255
|
+
Use this to store custom context for AI agents:
|
|
1256
|
+
- Customer information (name, account ID)
|
|
1257
|
+
- Business context (order ID, ticket number)
|
|
1258
|
+
- Session state (current topic, preferences)
|
|
1259
|
+
|
|
1260
|
+
The metadata is included in webhook payloads as `conversationState`.
|
|
1261
|
+
</dd>
|
|
1262
|
+
</dl>
|
|
1263
|
+
</dd>
|
|
1264
|
+
</dl>
|
|
1265
|
+
|
|
1266
|
+
#### 🔌 Usage
|
|
1267
|
+
|
|
1268
|
+
<dl>
|
|
1269
|
+
<dd>
|
|
1270
|
+
|
|
1271
|
+
<dl>
|
|
1272
|
+
<dd>
|
|
1273
|
+
|
|
1274
|
+
```typescript
|
|
1275
|
+
await client.conversations.updateConversation({
|
|
1276
|
+
conversation_id: "conversation_id"
|
|
1277
|
+
});
|
|
1278
|
+
|
|
1279
|
+
```
|
|
1280
|
+
</dd>
|
|
1281
|
+
</dl>
|
|
1282
|
+
</dd>
|
|
1283
|
+
</dl>
|
|
1284
|
+
|
|
1285
|
+
#### ⚙️ Parameters
|
|
1286
|
+
|
|
1287
|
+
<dl>
|
|
1288
|
+
<dd>
|
|
1289
|
+
|
|
1290
|
+
<dl>
|
|
1291
|
+
<dd>
|
|
1292
|
+
|
|
1293
|
+
**request:** `AgentPhone.UpdateConversationRequest`
|
|
1294
|
+
|
|
1295
|
+
</dd>
|
|
1296
|
+
</dl>
|
|
1297
|
+
|
|
1298
|
+
<dl>
|
|
1299
|
+
<dd>
|
|
1300
|
+
|
|
1301
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
1302
|
+
|
|
1303
|
+
</dd>
|
|
1304
|
+
</dl>
|
|
1305
|
+
</dd>
|
|
1306
|
+
</dl>
|
|
1307
|
+
|
|
1308
|
+
|
|
1309
|
+
</dd>
|
|
1310
|
+
</dl>
|
|
1311
|
+
</details>
|
|
1312
|
+
|
|
1313
|
+
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">getConversationMessages</a>({ ...params }) -> AgentPhone.MessagesListResponse</code></summary>
|
|
1314
|
+
<dl>
|
|
1315
|
+
<dd>
|
|
1316
|
+
|
|
1317
|
+
#### 📝 Description
|
|
1318
|
+
|
|
1319
|
+
<dl>
|
|
1320
|
+
<dd>
|
|
1321
|
+
|
|
1322
|
+
<dl>
|
|
1323
|
+
<dd>
|
|
1324
|
+
|
|
1325
|
+
Get paginated messages for a conversation.
|
|
1326
|
+
|
|
1327
|
+
Use before/after for cursor-based pagination.
|
|
1328
|
+
</dd>
|
|
1329
|
+
</dl>
|
|
1330
|
+
</dd>
|
|
1331
|
+
</dl>
|
|
1332
|
+
|
|
1333
|
+
#### 🔌 Usage
|
|
1334
|
+
|
|
1335
|
+
<dl>
|
|
1336
|
+
<dd>
|
|
1337
|
+
|
|
1338
|
+
<dl>
|
|
1339
|
+
<dd>
|
|
1340
|
+
|
|
1341
|
+
```typescript
|
|
1342
|
+
await client.conversations.getConversationMessages({
|
|
1343
|
+
conversation_id: "conversation_id"
|
|
1344
|
+
});
|
|
1345
|
+
|
|
1346
|
+
```
|
|
1347
|
+
</dd>
|
|
1348
|
+
</dl>
|
|
1349
|
+
</dd>
|
|
1350
|
+
</dl>
|
|
1351
|
+
|
|
1352
|
+
#### ⚙️ Parameters
|
|
1353
|
+
|
|
1354
|
+
<dl>
|
|
1355
|
+
<dd>
|
|
1356
|
+
|
|
1357
|
+
<dl>
|
|
1358
|
+
<dd>
|
|
1359
|
+
|
|
1360
|
+
**request:** `AgentPhone.GetConversationMessagesV1ConversationsConversationIdMessagesGetRequest`
|
|
1361
|
+
|
|
1362
|
+
</dd>
|
|
1363
|
+
</dl>
|
|
1364
|
+
|
|
1365
|
+
<dl>
|
|
1366
|
+
<dd>
|
|
1367
|
+
|
|
1368
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
1369
|
+
|
|
1370
|
+
</dd>
|
|
1371
|
+
</dl>
|
|
1372
|
+
</dd>
|
|
1373
|
+
</dl>
|
|
1374
|
+
|
|
1375
|
+
|
|
1376
|
+
</dd>
|
|
1377
|
+
</dl>
|
|
1378
|
+
</details>
|
|
1379
|
+
|
|
1380
|
+
## Calls
|
|
1381
|
+
<details><summary><code>client.calls.<a href="/src/api/resources/calls/client/Client.ts">listCalls</a>({ ...params }) -> unknown</code></summary>
|
|
1382
|
+
<dl>
|
|
1383
|
+
<dd>
|
|
1384
|
+
|
|
1385
|
+
#### 📝 Description
|
|
1386
|
+
|
|
1387
|
+
<dl>
|
|
1388
|
+
<dd>
|
|
1389
|
+
|
|
1390
|
+
<dl>
|
|
1391
|
+
<dd>
|
|
1392
|
+
|
|
1393
|
+
List all calls for this project.
|
|
1394
|
+
</dd>
|
|
1395
|
+
</dl>
|
|
1396
|
+
</dd>
|
|
1397
|
+
</dl>
|
|
1398
|
+
|
|
1399
|
+
#### 🔌 Usage
|
|
1400
|
+
|
|
1401
|
+
<dl>
|
|
1402
|
+
<dd>
|
|
1403
|
+
|
|
1404
|
+
<dl>
|
|
1405
|
+
<dd>
|
|
1406
|
+
|
|
1407
|
+
```typescript
|
|
1408
|
+
await client.calls.listCalls();
|
|
1409
|
+
|
|
1410
|
+
```
|
|
1411
|
+
</dd>
|
|
1412
|
+
</dl>
|
|
1413
|
+
</dd>
|
|
1414
|
+
</dl>
|
|
1415
|
+
|
|
1416
|
+
#### ⚙️ Parameters
|
|
1417
|
+
|
|
1418
|
+
<dl>
|
|
1419
|
+
<dd>
|
|
1420
|
+
|
|
1421
|
+
<dl>
|
|
1422
|
+
<dd>
|
|
1423
|
+
|
|
1424
|
+
**request:** `AgentPhone.ListCallsV1CallsGetRequest`
|
|
1425
|
+
|
|
1426
|
+
</dd>
|
|
1427
|
+
</dl>
|
|
1428
|
+
|
|
1429
|
+
<dl>
|
|
1430
|
+
<dd>
|
|
1431
|
+
|
|
1432
|
+
**requestOptions:** `CallsClient.RequestOptions`
|
|
1433
|
+
|
|
1434
|
+
</dd>
|
|
1435
|
+
</dl>
|
|
1436
|
+
</dd>
|
|
1437
|
+
</dl>
|
|
1438
|
+
|
|
1439
|
+
|
|
1440
|
+
</dd>
|
|
1441
|
+
</dl>
|
|
1442
|
+
</details>
|
|
1443
|
+
|
|
1444
|
+
<details><summary><code>client.calls.<a href="/src/api/resources/calls/client/Client.ts">createOutboundCall</a>({ ...params }) -> unknown</code></summary>
|
|
1445
|
+
<dl>
|
|
1446
|
+
<dd>
|
|
1447
|
+
|
|
1448
|
+
#### 📝 Description
|
|
1449
|
+
|
|
1450
|
+
<dl>
|
|
1451
|
+
<dd>
|
|
1452
|
+
|
|
1453
|
+
<dl>
|
|
1454
|
+
<dd>
|
|
1455
|
+
|
|
1456
|
+
Initiate an outbound call.
|
|
1457
|
+
|
|
1458
|
+
This endpoint allows you to programmatically make phone calls from your agent
|
|
1459
|
+
to any phone number. The call will use the agent's assigned phone number as the
|
|
1460
|
+
caller ID.
|
|
1461
|
+
|
|
1462
|
+
Flow:
|
|
1463
|
+
1. Validates the agent belongs to your project and has a phone number
|
|
1464
|
+
2. Initiates a call via Twilio from the agent's number to the destination
|
|
1465
|
+
3. When recipient answers, speaks the initial greeting (if provided)
|
|
1466
|
+
4. Listens for recipient's speech and sends to your webhook
|
|
1467
|
+
5. Continues conversation using your webhook responses
|
|
1468
|
+
</dd>
|
|
1469
|
+
</dl>
|
|
1470
|
+
</dd>
|
|
1471
|
+
</dl>
|
|
1472
|
+
|
|
1473
|
+
#### 🔌 Usage
|
|
1474
|
+
|
|
1475
|
+
<dl>
|
|
1476
|
+
<dd>
|
|
1477
|
+
|
|
1478
|
+
<dl>
|
|
1479
|
+
<dd>
|
|
1480
|
+
|
|
1481
|
+
```typescript
|
|
1482
|
+
await client.calls.createOutboundCall({
|
|
1483
|
+
agentId: "agentId",
|
|
1484
|
+
toNumber: "toNumber"
|
|
1485
|
+
});
|
|
1486
|
+
|
|
1487
|
+
```
|
|
1488
|
+
</dd>
|
|
1489
|
+
</dl>
|
|
1490
|
+
</dd>
|
|
1491
|
+
</dl>
|
|
1492
|
+
|
|
1493
|
+
#### ⚙️ Parameters
|
|
1494
|
+
|
|
1495
|
+
<dl>
|
|
1496
|
+
<dd>
|
|
1497
|
+
|
|
1498
|
+
<dl>
|
|
1499
|
+
<dd>
|
|
1500
|
+
|
|
1501
|
+
**request:** `AgentPhone.CreateOutboundCallRequest`
|
|
1502
|
+
|
|
1503
|
+
</dd>
|
|
1504
|
+
</dl>
|
|
1505
|
+
|
|
1506
|
+
<dl>
|
|
1507
|
+
<dd>
|
|
1508
|
+
|
|
1509
|
+
**requestOptions:** `CallsClient.RequestOptions`
|
|
1510
|
+
|
|
1511
|
+
</dd>
|
|
1512
|
+
</dl>
|
|
1513
|
+
</dd>
|
|
1514
|
+
</dl>
|
|
1515
|
+
|
|
1516
|
+
|
|
1517
|
+
</dd>
|
|
1518
|
+
</dl>
|
|
1519
|
+
</details>
|
|
1520
|
+
|
|
1521
|
+
<details><summary><code>client.calls.<a href="/src/api/resources/calls/client/Client.ts">getCall</a>({ ...params }) -> unknown</code></summary>
|
|
1522
|
+
<dl>
|
|
1523
|
+
<dd>
|
|
1524
|
+
|
|
1525
|
+
#### 📝 Description
|
|
1526
|
+
|
|
1527
|
+
<dl>
|
|
1528
|
+
<dd>
|
|
1529
|
+
|
|
1530
|
+
<dl>
|
|
1531
|
+
<dd>
|
|
1532
|
+
|
|
1533
|
+
Get a specific call with its transcripts.
|
|
1534
|
+
</dd>
|
|
1535
|
+
</dl>
|
|
1536
|
+
</dd>
|
|
1537
|
+
</dl>
|
|
1538
|
+
|
|
1539
|
+
#### 🔌 Usage
|
|
1540
|
+
|
|
1541
|
+
<dl>
|
|
1542
|
+
<dd>
|
|
1543
|
+
|
|
1544
|
+
<dl>
|
|
1545
|
+
<dd>
|
|
1546
|
+
|
|
1547
|
+
```typescript
|
|
1548
|
+
await client.calls.getCall({
|
|
1549
|
+
call_id: "call_id"
|
|
1550
|
+
});
|
|
1551
|
+
|
|
1552
|
+
```
|
|
1553
|
+
</dd>
|
|
1554
|
+
</dl>
|
|
1555
|
+
</dd>
|
|
1556
|
+
</dl>
|
|
1557
|
+
|
|
1558
|
+
#### ⚙️ Parameters
|
|
1559
|
+
|
|
1560
|
+
<dl>
|
|
1561
|
+
<dd>
|
|
1562
|
+
|
|
1563
|
+
<dl>
|
|
1564
|
+
<dd>
|
|
1565
|
+
|
|
1566
|
+
**request:** `AgentPhone.GetCallV1CallsCallIdGetRequest`
|
|
1567
|
+
|
|
1568
|
+
</dd>
|
|
1569
|
+
</dl>
|
|
1570
|
+
|
|
1571
|
+
<dl>
|
|
1572
|
+
<dd>
|
|
1573
|
+
|
|
1574
|
+
**requestOptions:** `CallsClient.RequestOptions`
|
|
1575
|
+
|
|
1576
|
+
</dd>
|
|
1577
|
+
</dl>
|
|
1578
|
+
</dd>
|
|
1579
|
+
</dl>
|
|
1580
|
+
|
|
1581
|
+
|
|
1582
|
+
</dd>
|
|
1583
|
+
</dl>
|
|
1584
|
+
</details>
|
|
1585
|
+
|
|
1586
|
+
<details><summary><code>client.calls.<a href="/src/api/resources/calls/client/Client.ts">listCallsForNumber</a>({ ...params }) -> unknown</code></summary>
|
|
1587
|
+
<dl>
|
|
1588
|
+
<dd>
|
|
1589
|
+
|
|
1590
|
+
#### 📝 Description
|
|
1591
|
+
|
|
1592
|
+
<dl>
|
|
1593
|
+
<dd>
|
|
1594
|
+
|
|
1595
|
+
<dl>
|
|
1596
|
+
<dd>
|
|
1597
|
+
|
|
1598
|
+
List all calls for a specific phone number.
|
|
1599
|
+
</dd>
|
|
1600
|
+
</dl>
|
|
1601
|
+
</dd>
|
|
1602
|
+
</dl>
|
|
1603
|
+
|
|
1604
|
+
#### 🔌 Usage
|
|
1605
|
+
|
|
1606
|
+
<dl>
|
|
1607
|
+
<dd>
|
|
1608
|
+
|
|
1609
|
+
<dl>
|
|
1610
|
+
<dd>
|
|
1611
|
+
|
|
1612
|
+
```typescript
|
|
1613
|
+
await client.calls.listCallsForNumber({
|
|
1614
|
+
number_id: "number_id"
|
|
1615
|
+
});
|
|
1616
|
+
|
|
1617
|
+
```
|
|
1618
|
+
</dd>
|
|
1619
|
+
</dl>
|
|
1620
|
+
</dd>
|
|
1621
|
+
</dl>
|
|
1622
|
+
|
|
1623
|
+
#### ⚙️ Parameters
|
|
1624
|
+
|
|
1625
|
+
<dl>
|
|
1626
|
+
<dd>
|
|
1627
|
+
|
|
1628
|
+
<dl>
|
|
1629
|
+
<dd>
|
|
1630
|
+
|
|
1631
|
+
**request:** `AgentPhone.ListCallsForNumberV1NumbersNumberIdCallsGetRequest`
|
|
1632
|
+
|
|
1633
|
+
</dd>
|
|
1634
|
+
</dl>
|
|
1635
|
+
|
|
1636
|
+
<dl>
|
|
1637
|
+
<dd>
|
|
1638
|
+
|
|
1639
|
+
**requestOptions:** `CallsClient.RequestOptions`
|
|
1640
|
+
|
|
1641
|
+
</dd>
|
|
1642
|
+
</dl>
|
|
1643
|
+
</dd>
|
|
1644
|
+
</dl>
|
|
1645
|
+
|
|
1646
|
+
|
|
1647
|
+
</dd>
|
|
1648
|
+
</dl>
|
|
1649
|
+
</details>
|
|
1650
|
+
|
|
1651
|
+
## Usage
|
|
1652
|
+
<details><summary><code>client.usage.<a href="/src/api/resources/usage/client/Client.ts">getUsage</a>() -> AgentPhone.UsageResponse</code></summary>
|
|
1653
|
+
<dl>
|
|
1654
|
+
<dd>
|
|
1655
|
+
|
|
1656
|
+
#### 📝 Description
|
|
1657
|
+
|
|
1658
|
+
<dl>
|
|
1659
|
+
<dd>
|
|
1660
|
+
|
|
1661
|
+
<dl>
|
|
1662
|
+
<dd>
|
|
1663
|
+
|
|
1664
|
+
Get usage statistics for the current project.
|
|
1665
|
+
|
|
1666
|
+
Returns:
|
|
1667
|
+
- Phone number limits (used/limit/remaining)
|
|
1668
|
+
- Message statistics (total, last 24h, last 7 days)
|
|
1669
|
+
- Call statistics (total, last 24h, last 7 days)
|
|
1670
|
+
- Webhook delivery statistics
|
|
1671
|
+
</dd>
|
|
1672
|
+
</dl>
|
|
1673
|
+
</dd>
|
|
1674
|
+
</dl>
|
|
1675
|
+
|
|
1676
|
+
#### 🔌 Usage
|
|
1677
|
+
|
|
1678
|
+
<dl>
|
|
1679
|
+
<dd>
|
|
1680
|
+
|
|
1681
|
+
<dl>
|
|
1682
|
+
<dd>
|
|
1683
|
+
|
|
1684
|
+
```typescript
|
|
1685
|
+
await client.usage.getUsage();
|
|
1686
|
+
|
|
1687
|
+
```
|
|
1688
|
+
</dd>
|
|
1689
|
+
</dl>
|
|
1690
|
+
</dd>
|
|
1691
|
+
</dl>
|
|
1692
|
+
|
|
1693
|
+
#### ⚙️ Parameters
|
|
1694
|
+
|
|
1695
|
+
<dl>
|
|
1696
|
+
<dd>
|
|
1697
|
+
|
|
1698
|
+
<dl>
|
|
1699
|
+
<dd>
|
|
1700
|
+
|
|
1701
|
+
**requestOptions:** `UsageClient.RequestOptions`
|
|
1702
|
+
|
|
1703
|
+
</dd>
|
|
1704
|
+
</dl>
|
|
1705
|
+
</dd>
|
|
1706
|
+
</dl>
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
</dd>
|
|
1710
|
+
</dl>
|
|
1711
|
+
</details>
|