@epilot/sdk 2.20.35 → 2.20.36
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/definitions/chat-runtime.json +1 -1
- package/definitions/chat.json +749 -126
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/chat.cjs +8 -8
- package/dist/apis/chat.d.cts +2 -2
- package/dist/apis/chat.d.ts +2 -2
- package/dist/apis/chat.js +2 -2
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/chat-3MIK7DUI.js +7 -0
- package/dist/chat-IWMQEXCD.cjs +7 -0
- package/dist/{chat-runtime-MF35HI2U.js → chat-runtime-O46V7MCD.js} +1 -1
- package/dist/chat-runtime-QSGSW6SL.cjs +5 -0
- package/dist/{chat.d-0w0TaT-a.d.cts → chat.d-mUHenLz7.d.cts} +564 -365
- package/dist/{chat.d-0w0TaT-a.d.ts → chat.d-mUHenLz7.d.ts} +564 -365
- package/dist/chunk-2F4JXHGX.js +14 -0
- package/dist/chunk-QWQ6UINA.cjs +14 -0
- package/dist/{chunk-RE2KDGKQ.cjs → chunk-RSP6PAXQ.cjs} +2 -2
- package/dist/{chunk-OXXS3O7X.js → chunk-YH6DUNL2.js} +2 -2
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/docs/chat.md +231 -77
- package/package.json +1 -1
- package/dist/chat-5EOD2OPN.cjs +0 -7
- package/dist/chat-D5KXPRYY.js +0 -7
- package/dist/chat-runtime-MYMUFT3Y.cjs +0 -5
- package/dist/chunk-6ZTP7EQE.js +0 -14
- package/dist/chunk-A5THJ4SF.cjs +0 -14
package/definitions/chat.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "epilot Chat API",
|
|
5
5
|
"version": "0.1.0",
|
|
6
|
-
"description": "
|
|
6
|
+
"description": "Website Chat management and anonymous browser chat."
|
|
7
7
|
},
|
|
8
8
|
"servers": [
|
|
9
9
|
{
|
|
@@ -16,12 +16,12 @@
|
|
|
16
16
|
}
|
|
17
17
|
],
|
|
18
18
|
"paths": {
|
|
19
|
-
"/v1/
|
|
19
|
+
"/v1/website-chats": {
|
|
20
20
|
"get": {
|
|
21
21
|
"tags": [
|
|
22
|
-
"
|
|
22
|
+
"Website Chats"
|
|
23
23
|
],
|
|
24
|
-
"operationId": "
|
|
24
|
+
"operationId": "listWebsiteChats",
|
|
25
25
|
"security": [
|
|
26
26
|
{
|
|
27
27
|
"EpilotAuth": []
|
|
@@ -29,28 +29,28 @@
|
|
|
29
29
|
],
|
|
30
30
|
"responses": {
|
|
31
31
|
"200": {
|
|
32
|
-
"description": "
|
|
32
|
+
"description": "Website Chat response",
|
|
33
33
|
"content": {
|
|
34
34
|
"application/json": {
|
|
35
35
|
"schema": {
|
|
36
36
|
"type": "object",
|
|
37
37
|
"required": [
|
|
38
|
-
"
|
|
38
|
+
"website_chats"
|
|
39
39
|
],
|
|
40
40
|
"properties": {
|
|
41
|
-
"
|
|
41
|
+
"website_chats": {
|
|
42
42
|
"type": "array",
|
|
43
43
|
"items": {
|
|
44
44
|
"type": "object",
|
|
45
45
|
"required": [
|
|
46
|
-
"
|
|
46
|
+
"website_chat_id",
|
|
47
47
|
"org_id",
|
|
48
48
|
"agent_id",
|
|
49
49
|
"binding_id",
|
|
50
50
|
"version",
|
|
51
51
|
"name",
|
|
52
|
-
"
|
|
53
|
-
"
|
|
52
|
+
"settings",
|
|
53
|
+
"embed",
|
|
54
54
|
"created_at",
|
|
55
55
|
"updated_at"
|
|
56
56
|
],
|
|
@@ -65,7 +65,7 @@
|
|
|
65
65
|
"format": "uuid",
|
|
66
66
|
"nullable": true
|
|
67
67
|
},
|
|
68
|
-
"
|
|
68
|
+
"settings": {
|
|
69
69
|
"type": "object",
|
|
70
70
|
"additionalProperties": false,
|
|
71
71
|
"required": [
|
|
@@ -78,7 +78,7 @@
|
|
|
78
78
|
"type": "array",
|
|
79
79
|
"maxItems": 50,
|
|
80
80
|
"uniqueItems": true,
|
|
81
|
-
"description": "Exact HTTPS origins. Empty means the
|
|
81
|
+
"description": "Exact HTTPS origins. Empty means the Website Chat cannot start sessions.",
|
|
82
82
|
"items": {
|
|
83
83
|
"type": "string",
|
|
84
84
|
"maxLength": 2048
|
|
@@ -100,7 +100,7 @@
|
|
|
100
100
|
"type": "string",
|
|
101
101
|
"format": "uuid",
|
|
102
102
|
"nullable": true,
|
|
103
|
-
"description": "Design Builder configuration for the
|
|
103
|
+
"description": "Design Builder configuration for the Website Chat only."
|
|
104
104
|
},
|
|
105
105
|
"authentication": {
|
|
106
106
|
"type": "object",
|
|
@@ -126,7 +126,7 @@
|
|
|
126
126
|
}
|
|
127
127
|
}
|
|
128
128
|
},
|
|
129
|
-
"
|
|
129
|
+
"website_chat_id": {
|
|
130
130
|
"type": "string",
|
|
131
131
|
"format": "uuid",
|
|
132
132
|
"readOnly": true,
|
|
@@ -157,7 +157,7 @@
|
|
|
157
157
|
"format": "date-time",
|
|
158
158
|
"readOnly": true
|
|
159
159
|
},
|
|
160
|
-
"
|
|
160
|
+
"embed": {
|
|
161
161
|
"type": "object",
|
|
162
162
|
"readOnly": true,
|
|
163
163
|
"required": [
|
|
@@ -192,7 +192,7 @@
|
|
|
192
192
|
}
|
|
193
193
|
},
|
|
194
194
|
"400": {
|
|
195
|
-
"description": "Invalid
|
|
195
|
+
"description": "Invalid Website Chat settings",
|
|
196
196
|
"content": {
|
|
197
197
|
"application/json": {
|
|
198
198
|
"schema": {
|
|
@@ -213,7 +213,7 @@
|
|
|
213
213
|
}
|
|
214
214
|
},
|
|
215
215
|
"404": {
|
|
216
|
-
"description": "
|
|
216
|
+
"description": "Website Chat not found in this organisation",
|
|
217
217
|
"content": {
|
|
218
218
|
"application/json": {
|
|
219
219
|
"schema": {
|
|
@@ -234,7 +234,7 @@
|
|
|
234
234
|
}
|
|
235
235
|
},
|
|
236
236
|
"409": {
|
|
237
|
-
"description": "
|
|
237
|
+
"description": "Website Chat or assigned agent changed; reload before retrying",
|
|
238
238
|
"content": {
|
|
239
239
|
"application/json": {
|
|
240
240
|
"schema": {
|
|
@@ -268,9 +268,9 @@
|
|
|
268
268
|
},
|
|
269
269
|
"post": {
|
|
270
270
|
"tags": [
|
|
271
|
-
"
|
|
271
|
+
"Website Chats"
|
|
272
272
|
],
|
|
273
|
-
"operationId": "
|
|
273
|
+
"operationId": "createWebsiteChat",
|
|
274
274
|
"security": [
|
|
275
275
|
{
|
|
276
276
|
"EpilotAuth": []
|
|
@@ -278,20 +278,20 @@
|
|
|
278
278
|
],
|
|
279
279
|
"responses": {
|
|
280
280
|
"201": {
|
|
281
|
-
"description": "
|
|
281
|
+
"description": "Website Chat response",
|
|
282
282
|
"content": {
|
|
283
283
|
"application/json": {
|
|
284
284
|
"schema": {
|
|
285
285
|
"type": "object",
|
|
286
286
|
"required": [
|
|
287
|
-
"
|
|
287
|
+
"website_chat_id",
|
|
288
288
|
"org_id",
|
|
289
289
|
"agent_id",
|
|
290
290
|
"binding_id",
|
|
291
291
|
"version",
|
|
292
292
|
"name",
|
|
293
|
-
"
|
|
294
|
-
"
|
|
293
|
+
"settings",
|
|
294
|
+
"embed",
|
|
295
295
|
"created_at",
|
|
296
296
|
"updated_at"
|
|
297
297
|
],
|
|
@@ -306,7 +306,7 @@
|
|
|
306
306
|
"format": "uuid",
|
|
307
307
|
"nullable": true
|
|
308
308
|
},
|
|
309
|
-
"
|
|
309
|
+
"settings": {
|
|
310
310
|
"type": "object",
|
|
311
311
|
"additionalProperties": false,
|
|
312
312
|
"required": [
|
|
@@ -319,7 +319,7 @@
|
|
|
319
319
|
"type": "array",
|
|
320
320
|
"maxItems": 50,
|
|
321
321
|
"uniqueItems": true,
|
|
322
|
-
"description": "Exact HTTPS origins. Empty means the
|
|
322
|
+
"description": "Exact HTTPS origins. Empty means the Website Chat cannot start sessions.",
|
|
323
323
|
"items": {
|
|
324
324
|
"type": "string",
|
|
325
325
|
"maxLength": 2048
|
|
@@ -341,7 +341,7 @@
|
|
|
341
341
|
"type": "string",
|
|
342
342
|
"format": "uuid",
|
|
343
343
|
"nullable": true,
|
|
344
|
-
"description": "Design Builder configuration for the
|
|
344
|
+
"description": "Design Builder configuration for the Website Chat only."
|
|
345
345
|
},
|
|
346
346
|
"authentication": {
|
|
347
347
|
"type": "object",
|
|
@@ -367,7 +367,7 @@
|
|
|
367
367
|
}
|
|
368
368
|
}
|
|
369
369
|
},
|
|
370
|
-
"
|
|
370
|
+
"website_chat_id": {
|
|
371
371
|
"type": "string",
|
|
372
372
|
"format": "uuid",
|
|
373
373
|
"readOnly": true,
|
|
@@ -398,7 +398,7 @@
|
|
|
398
398
|
"format": "date-time",
|
|
399
399
|
"readOnly": true
|
|
400
400
|
},
|
|
401
|
-
"
|
|
401
|
+
"embed": {
|
|
402
402
|
"type": "object",
|
|
403
403
|
"readOnly": true,
|
|
404
404
|
"required": [
|
|
@@ -427,7 +427,7 @@
|
|
|
427
427
|
}
|
|
428
428
|
},
|
|
429
429
|
"400": {
|
|
430
|
-
"description": "Invalid
|
|
430
|
+
"description": "Invalid Website Chat settings",
|
|
431
431
|
"content": {
|
|
432
432
|
"application/json": {
|
|
433
433
|
"schema": {
|
|
@@ -448,7 +448,7 @@
|
|
|
448
448
|
}
|
|
449
449
|
},
|
|
450
450
|
"404": {
|
|
451
|
-
"description": "
|
|
451
|
+
"description": "Website Chat not found in this organisation",
|
|
452
452
|
"content": {
|
|
453
453
|
"application/json": {
|
|
454
454
|
"schema": {
|
|
@@ -469,7 +469,7 @@
|
|
|
469
469
|
}
|
|
470
470
|
},
|
|
471
471
|
"409": {
|
|
472
|
-
"description": "
|
|
472
|
+
"description": "Website Chat or assigned agent changed; reload before retrying",
|
|
473
473
|
"content": {
|
|
474
474
|
"application/json": {
|
|
475
475
|
"schema": {
|
|
@@ -500,7 +500,7 @@
|
|
|
500
500
|
"required": [
|
|
501
501
|
"name",
|
|
502
502
|
"agent_id",
|
|
503
|
-
"
|
|
503
|
+
"settings"
|
|
504
504
|
],
|
|
505
505
|
"properties": {
|
|
506
506
|
"name": {
|
|
@@ -513,7 +513,7 @@
|
|
|
513
513
|
"format": "uuid",
|
|
514
514
|
"nullable": true
|
|
515
515
|
},
|
|
516
|
-
"
|
|
516
|
+
"settings": {
|
|
517
517
|
"type": "object",
|
|
518
518
|
"additionalProperties": false,
|
|
519
519
|
"required": [
|
|
@@ -526,7 +526,7 @@
|
|
|
526
526
|
"type": "array",
|
|
527
527
|
"maxItems": 50,
|
|
528
528
|
"uniqueItems": true,
|
|
529
|
-
"description": "Exact HTTPS origins. Empty means the
|
|
529
|
+
"description": "Exact HTTPS origins. Empty means the Website Chat cannot start sessions.",
|
|
530
530
|
"items": {
|
|
531
531
|
"type": "string",
|
|
532
532
|
"maxLength": 2048
|
|
@@ -548,7 +548,7 @@
|
|
|
548
548
|
"type": "string",
|
|
549
549
|
"format": "uuid",
|
|
550
550
|
"nullable": true,
|
|
551
|
-
"description": "Design Builder configuration for the
|
|
551
|
+
"description": "Design Builder configuration for the Website Chat only."
|
|
552
552
|
},
|
|
553
553
|
"authentication": {
|
|
554
554
|
"type": "object",
|
|
@@ -581,11 +581,11 @@
|
|
|
581
581
|
}
|
|
582
582
|
}
|
|
583
583
|
},
|
|
584
|
-
"/v1/
|
|
584
|
+
"/v1/website-chats/{website_chat_id}": {
|
|
585
585
|
"parameters": [
|
|
586
586
|
{
|
|
587
587
|
"in": "path",
|
|
588
|
-
"name": "
|
|
588
|
+
"name": "website_chat_id",
|
|
589
589
|
"required": true,
|
|
590
590
|
"schema": {
|
|
591
591
|
"type": "string",
|
|
@@ -595,9 +595,9 @@
|
|
|
595
595
|
],
|
|
596
596
|
"get": {
|
|
597
597
|
"tags": [
|
|
598
|
-
"
|
|
598
|
+
"Website Chats"
|
|
599
599
|
],
|
|
600
|
-
"operationId": "
|
|
600
|
+
"operationId": "getWebsiteChat",
|
|
601
601
|
"security": [
|
|
602
602
|
{
|
|
603
603
|
"EpilotAuth": []
|
|
@@ -605,20 +605,20 @@
|
|
|
605
605
|
],
|
|
606
606
|
"responses": {
|
|
607
607
|
"200": {
|
|
608
|
-
"description": "
|
|
608
|
+
"description": "Website Chat response",
|
|
609
609
|
"content": {
|
|
610
610
|
"application/json": {
|
|
611
611
|
"schema": {
|
|
612
612
|
"type": "object",
|
|
613
613
|
"required": [
|
|
614
|
-
"
|
|
614
|
+
"website_chat_id",
|
|
615
615
|
"org_id",
|
|
616
616
|
"agent_id",
|
|
617
617
|
"binding_id",
|
|
618
618
|
"version",
|
|
619
619
|
"name",
|
|
620
|
-
"
|
|
621
|
-
"
|
|
620
|
+
"settings",
|
|
621
|
+
"embed",
|
|
622
622
|
"created_at",
|
|
623
623
|
"updated_at"
|
|
624
624
|
],
|
|
@@ -633,7 +633,7 @@
|
|
|
633
633
|
"format": "uuid",
|
|
634
634
|
"nullable": true
|
|
635
635
|
},
|
|
636
|
-
"
|
|
636
|
+
"settings": {
|
|
637
637
|
"type": "object",
|
|
638
638
|
"additionalProperties": false,
|
|
639
639
|
"required": [
|
|
@@ -646,7 +646,7 @@
|
|
|
646
646
|
"type": "array",
|
|
647
647
|
"maxItems": 50,
|
|
648
648
|
"uniqueItems": true,
|
|
649
|
-
"description": "Exact HTTPS origins. Empty means the
|
|
649
|
+
"description": "Exact HTTPS origins. Empty means the Website Chat cannot start sessions.",
|
|
650
650
|
"items": {
|
|
651
651
|
"type": "string",
|
|
652
652
|
"maxLength": 2048
|
|
@@ -668,7 +668,7 @@
|
|
|
668
668
|
"type": "string",
|
|
669
669
|
"format": "uuid",
|
|
670
670
|
"nullable": true,
|
|
671
|
-
"description": "Design Builder configuration for the
|
|
671
|
+
"description": "Design Builder configuration for the Website Chat only."
|
|
672
672
|
},
|
|
673
673
|
"authentication": {
|
|
674
674
|
"type": "object",
|
|
@@ -694,7 +694,7 @@
|
|
|
694
694
|
}
|
|
695
695
|
}
|
|
696
696
|
},
|
|
697
|
-
"
|
|
697
|
+
"website_chat_id": {
|
|
698
698
|
"type": "string",
|
|
699
699
|
"format": "uuid",
|
|
700
700
|
"readOnly": true,
|
|
@@ -725,7 +725,7 @@
|
|
|
725
725
|
"format": "date-time",
|
|
726
726
|
"readOnly": true
|
|
727
727
|
},
|
|
728
|
-
"
|
|
728
|
+
"embed": {
|
|
729
729
|
"type": "object",
|
|
730
730
|
"readOnly": true,
|
|
731
731
|
"required": [
|
|
@@ -754,7 +754,7 @@
|
|
|
754
754
|
}
|
|
755
755
|
},
|
|
756
756
|
"400": {
|
|
757
|
-
"description": "Invalid
|
|
757
|
+
"description": "Invalid Website Chat settings",
|
|
758
758
|
"content": {
|
|
759
759
|
"application/json": {
|
|
760
760
|
"schema": {
|
|
@@ -775,7 +775,7 @@
|
|
|
775
775
|
}
|
|
776
776
|
},
|
|
777
777
|
"404": {
|
|
778
|
-
"description": "
|
|
778
|
+
"description": "Website Chat not found in this organisation",
|
|
779
779
|
"content": {
|
|
780
780
|
"application/json": {
|
|
781
781
|
"schema": {
|
|
@@ -796,7 +796,7 @@
|
|
|
796
796
|
}
|
|
797
797
|
},
|
|
798
798
|
"409": {
|
|
799
|
-
"description": "
|
|
799
|
+
"description": "Website Chat or assigned agent changed; reload before retrying",
|
|
800
800
|
"content": {
|
|
801
801
|
"application/json": {
|
|
802
802
|
"schema": {
|
|
@@ -820,9 +820,9 @@
|
|
|
820
820
|
},
|
|
821
821
|
"put": {
|
|
822
822
|
"tags": [
|
|
823
|
-
"
|
|
823
|
+
"Website Chats"
|
|
824
824
|
],
|
|
825
|
-
"operationId": "
|
|
825
|
+
"operationId": "updateWebsiteChat",
|
|
826
826
|
"security": [
|
|
827
827
|
{
|
|
828
828
|
"EpilotAuth": []
|
|
@@ -830,20 +830,20 @@
|
|
|
830
830
|
],
|
|
831
831
|
"responses": {
|
|
832
832
|
"200": {
|
|
833
|
-
"description": "
|
|
833
|
+
"description": "Website Chat response",
|
|
834
834
|
"content": {
|
|
835
835
|
"application/json": {
|
|
836
836
|
"schema": {
|
|
837
837
|
"type": "object",
|
|
838
838
|
"required": [
|
|
839
|
-
"
|
|
839
|
+
"website_chat_id",
|
|
840
840
|
"org_id",
|
|
841
841
|
"agent_id",
|
|
842
842
|
"binding_id",
|
|
843
843
|
"version",
|
|
844
844
|
"name",
|
|
845
|
-
"
|
|
846
|
-
"
|
|
845
|
+
"settings",
|
|
846
|
+
"embed",
|
|
847
847
|
"created_at",
|
|
848
848
|
"updated_at"
|
|
849
849
|
],
|
|
@@ -858,7 +858,7 @@
|
|
|
858
858
|
"format": "uuid",
|
|
859
859
|
"nullable": true
|
|
860
860
|
},
|
|
861
|
-
"
|
|
861
|
+
"settings": {
|
|
862
862
|
"type": "object",
|
|
863
863
|
"additionalProperties": false,
|
|
864
864
|
"required": [
|
|
@@ -871,7 +871,7 @@
|
|
|
871
871
|
"type": "array",
|
|
872
872
|
"maxItems": 50,
|
|
873
873
|
"uniqueItems": true,
|
|
874
|
-
"description": "Exact HTTPS origins. Empty means the
|
|
874
|
+
"description": "Exact HTTPS origins. Empty means the Website Chat cannot start sessions.",
|
|
875
875
|
"items": {
|
|
876
876
|
"type": "string",
|
|
877
877
|
"maxLength": 2048
|
|
@@ -893,7 +893,7 @@
|
|
|
893
893
|
"type": "string",
|
|
894
894
|
"format": "uuid",
|
|
895
895
|
"nullable": true,
|
|
896
|
-
"description": "Design Builder configuration for the
|
|
896
|
+
"description": "Design Builder configuration for the Website Chat only."
|
|
897
897
|
},
|
|
898
898
|
"authentication": {
|
|
899
899
|
"type": "object",
|
|
@@ -919,7 +919,7 @@
|
|
|
919
919
|
}
|
|
920
920
|
}
|
|
921
921
|
},
|
|
922
|
-
"
|
|
922
|
+
"website_chat_id": {
|
|
923
923
|
"type": "string",
|
|
924
924
|
"format": "uuid",
|
|
925
925
|
"readOnly": true,
|
|
@@ -950,7 +950,7 @@
|
|
|
950
950
|
"format": "date-time",
|
|
951
951
|
"readOnly": true
|
|
952
952
|
},
|
|
953
|
-
"
|
|
953
|
+
"embed": {
|
|
954
954
|
"type": "object",
|
|
955
955
|
"readOnly": true,
|
|
956
956
|
"required": [
|
|
@@ -979,7 +979,7 @@
|
|
|
979
979
|
}
|
|
980
980
|
},
|
|
981
981
|
"400": {
|
|
982
|
-
"description": "Invalid
|
|
982
|
+
"description": "Invalid Website Chat settings",
|
|
983
983
|
"content": {
|
|
984
984
|
"application/json": {
|
|
985
985
|
"schema": {
|
|
@@ -1000,7 +1000,7 @@
|
|
|
1000
1000
|
}
|
|
1001
1001
|
},
|
|
1002
1002
|
"404": {
|
|
1003
|
-
"description": "
|
|
1003
|
+
"description": "Website Chat not found in this organisation",
|
|
1004
1004
|
"content": {
|
|
1005
1005
|
"application/json": {
|
|
1006
1006
|
"schema": {
|
|
@@ -1021,7 +1021,7 @@
|
|
|
1021
1021
|
}
|
|
1022
1022
|
},
|
|
1023
1023
|
"409": {
|
|
1024
|
-
"description": "
|
|
1024
|
+
"description": "Website Chat or assigned agent changed; reload before retrying",
|
|
1025
1025
|
"content": {
|
|
1026
1026
|
"application/json": {
|
|
1027
1027
|
"schema": {
|
|
@@ -1063,7 +1063,7 @@
|
|
|
1063
1063
|
"format": "uuid",
|
|
1064
1064
|
"nullable": true
|
|
1065
1065
|
},
|
|
1066
|
-
"
|
|
1066
|
+
"settings": {
|
|
1067
1067
|
"type": "object",
|
|
1068
1068
|
"additionalProperties": false,
|
|
1069
1069
|
"required": [
|
|
@@ -1076,7 +1076,7 @@
|
|
|
1076
1076
|
"type": "array",
|
|
1077
1077
|
"maxItems": 50,
|
|
1078
1078
|
"uniqueItems": true,
|
|
1079
|
-
"description": "Exact HTTPS origins. Empty means the
|
|
1079
|
+
"description": "Exact HTTPS origins. Empty means the Website Chat cannot start sessions.",
|
|
1080
1080
|
"items": {
|
|
1081
1081
|
"type": "string",
|
|
1082
1082
|
"maxLength": 2048
|
|
@@ -1098,7 +1098,7 @@
|
|
|
1098
1098
|
"type": "string",
|
|
1099
1099
|
"format": "uuid",
|
|
1100
1100
|
"nullable": true,
|
|
1101
|
-
"description": "Design Builder configuration for the
|
|
1101
|
+
"description": "Design Builder configuration for the Website Chat only."
|
|
1102
1102
|
},
|
|
1103
1103
|
"authentication": {
|
|
1104
1104
|
"type": "object",
|
|
@@ -1137,9 +1137,9 @@
|
|
|
1137
1137
|
},
|
|
1138
1138
|
"delete": {
|
|
1139
1139
|
"tags": [
|
|
1140
|
-
"
|
|
1140
|
+
"Website Chats"
|
|
1141
1141
|
],
|
|
1142
|
-
"operationId": "
|
|
1142
|
+
"operationId": "deleteWebsiteChat",
|
|
1143
1143
|
"security": [
|
|
1144
1144
|
{
|
|
1145
1145
|
"EpilotAuth": []
|
|
@@ -1147,10 +1147,10 @@
|
|
|
1147
1147
|
],
|
|
1148
1148
|
"responses": {
|
|
1149
1149
|
"204": {
|
|
1150
|
-
"description": "
|
|
1150
|
+
"description": "Website Chat deleted"
|
|
1151
1151
|
},
|
|
1152
1152
|
"400": {
|
|
1153
|
-
"description": "Invalid
|
|
1153
|
+
"description": "Invalid Website Chat settings",
|
|
1154
1154
|
"content": {
|
|
1155
1155
|
"application/json": {
|
|
1156
1156
|
"schema": {
|
|
@@ -1171,7 +1171,7 @@
|
|
|
1171
1171
|
}
|
|
1172
1172
|
},
|
|
1173
1173
|
"404": {
|
|
1174
|
-
"description": "
|
|
1174
|
+
"description": "Website Chat not found in this organisation",
|
|
1175
1175
|
"content": {
|
|
1176
1176
|
"application/json": {
|
|
1177
1177
|
"schema": {
|
|
@@ -1192,7 +1192,7 @@
|
|
|
1192
1192
|
}
|
|
1193
1193
|
},
|
|
1194
1194
|
"409": {
|
|
1195
|
-
"description": "
|
|
1195
|
+
"description": "Website Chat or assigned agent changed; reload before retrying",
|
|
1196
1196
|
"content": {
|
|
1197
1197
|
"application/json": {
|
|
1198
1198
|
"schema": {
|
|
@@ -1226,15 +1226,15 @@
|
|
|
1226
1226
|
]
|
|
1227
1227
|
}
|
|
1228
1228
|
},
|
|
1229
|
-
"/v1/
|
|
1229
|
+
"/v1/website-chats/{website_chat_id}/configuration": {
|
|
1230
1230
|
"get": {
|
|
1231
|
-
"operationId": "
|
|
1232
|
-
"description": "Resolve visitor-facing configuration for an independent
|
|
1231
|
+
"operationId": "getPublicWebsiteChat",
|
|
1232
|
+
"description": "Resolve visitor-facing configuration for an independent Website Chat and its current agent assignment. The Website Chat ID is not an organisation ID or a destination such as website or portal.",
|
|
1233
1233
|
"parameters": [
|
|
1234
1234
|
{
|
|
1235
1235
|
"in": "path",
|
|
1236
|
-
"name": "
|
|
1237
|
-
"description": "Public
|
|
1236
|
+
"name": "website_chat_id",
|
|
1237
|
+
"description": "Public Website Chat ID, also used as website_chat_id in bootstrap and data-epilot-chat in the embed.",
|
|
1238
1238
|
"example": "550e8400-e29b-41d4-a716-446655440000",
|
|
1239
1239
|
"required": true,
|
|
1240
1240
|
"schema": {
|
|
@@ -1274,6 +1274,18 @@
|
|
|
1274
1274
|
"de"
|
|
1275
1275
|
]
|
|
1276
1276
|
},
|
|
1277
|
+
"authentication": {
|
|
1278
|
+
"type": "object",
|
|
1279
|
+
"additionalProperties": false,
|
|
1280
|
+
"required": [
|
|
1281
|
+
"email_code"
|
|
1282
|
+
],
|
|
1283
|
+
"properties": {
|
|
1284
|
+
"email_code": {
|
|
1285
|
+
"type": "boolean"
|
|
1286
|
+
}
|
|
1287
|
+
}
|
|
1288
|
+
},
|
|
1277
1289
|
"design": {
|
|
1278
1290
|
"type": "object",
|
|
1279
1291
|
"additionalProperties": false,
|
|
@@ -1423,7 +1435,7 @@
|
|
|
1423
1435
|
}
|
|
1424
1436
|
},
|
|
1425
1437
|
"default": {
|
|
1426
|
-
"description": "400 invalid input, 401 expired capability, 403 origin denied, 404 unpublished
|
|
1438
|
+
"description": "400 invalid input, 401 expired capability, 403 origin denied, 404 unpublished Website Chat, 409 conflict, 413 too large, 429 rate limit, or 503 unavailable.",
|
|
1427
1439
|
"content": {
|
|
1428
1440
|
"application/json": {
|
|
1429
1441
|
"schema": {
|
|
@@ -1435,6 +1447,12 @@
|
|
|
1435
1447
|
"code": {
|
|
1436
1448
|
"type": "string",
|
|
1437
1449
|
"enum": [
|
|
1450
|
+
"INVALID_VERIFICATION_CODE",
|
|
1451
|
+
"VERIFICATION_EXPIRED",
|
|
1452
|
+
"VERIFICATION_CONFLICT",
|
|
1453
|
+
"VERIFICATION_DISABLED",
|
|
1454
|
+
"VERIFICATION_UNAVAILABLE",
|
|
1455
|
+
"IDENTITY_CHANGED",
|
|
1438
1456
|
"INVALID_REQUEST",
|
|
1439
1457
|
"ORIGIN_DENIED",
|
|
1440
1458
|
"NOT_FOUND",
|
|
@@ -1461,7 +1479,7 @@
|
|
|
1461
1479
|
"/v1/bootstrap": {
|
|
1462
1480
|
"post": {
|
|
1463
1481
|
"operationId": "createPublicChatGrant",
|
|
1464
|
-
"description": "Called by the host website with its
|
|
1482
|
+
"description": "Called by the host website with its website_chat_id. Checks the saved website origin allowlist and issues a single-use grant for the iframe to exchange at POST /v1/sessions within 60 seconds. This deadline does not limit the resulting session.",
|
|
1465
1483
|
"requestBody": {
|
|
1466
1484
|
"required": true,
|
|
1467
1485
|
"content": {
|
|
@@ -1470,10 +1488,10 @@
|
|
|
1470
1488
|
"type": "object",
|
|
1471
1489
|
"additionalProperties": false,
|
|
1472
1490
|
"required": [
|
|
1473
|
-
"
|
|
1491
|
+
"website_chat_id"
|
|
1474
1492
|
],
|
|
1475
1493
|
"properties": {
|
|
1476
|
-
"
|
|
1494
|
+
"website_chat_id": {
|
|
1477
1495
|
"type": "string",
|
|
1478
1496
|
"pattern": "^[a-zA-Z0-9_-]{1,100}$"
|
|
1479
1497
|
}
|
|
@@ -1492,7 +1510,7 @@
|
|
|
1492
1510
|
"required": [
|
|
1493
1511
|
"grant",
|
|
1494
1512
|
"expires_in",
|
|
1495
|
-
"
|
|
1513
|
+
"frame_origin"
|
|
1496
1514
|
],
|
|
1497
1515
|
"properties": {
|
|
1498
1516
|
"grant": {
|
|
@@ -1502,7 +1520,7 @@
|
|
|
1502
1520
|
"type": "integer",
|
|
1503
1521
|
"example": 60
|
|
1504
1522
|
},
|
|
1505
|
-
"
|
|
1523
|
+
"frame_origin": {
|
|
1506
1524
|
"type": "string",
|
|
1507
1525
|
"format": "uri"
|
|
1508
1526
|
}
|
|
@@ -1512,7 +1530,7 @@
|
|
|
1512
1530
|
}
|
|
1513
1531
|
},
|
|
1514
1532
|
"default": {
|
|
1515
|
-
"description": "400 invalid input, 401 expired capability, 403 origin denied, 404 unpublished
|
|
1533
|
+
"description": "400 invalid input, 401 expired capability, 403 origin denied, 404 unpublished Website Chat, 409 conflict, 413 too large, 429 rate limit, or 503 unavailable.",
|
|
1516
1534
|
"content": {
|
|
1517
1535
|
"application/json": {
|
|
1518
1536
|
"schema": {
|
|
@@ -1524,6 +1542,12 @@
|
|
|
1524
1542
|
"code": {
|
|
1525
1543
|
"type": "string",
|
|
1526
1544
|
"enum": [
|
|
1545
|
+
"INVALID_VERIFICATION_CODE",
|
|
1546
|
+
"VERIFICATION_EXPIRED",
|
|
1547
|
+
"VERIFICATION_CONFLICT",
|
|
1548
|
+
"VERIFICATION_DISABLED",
|
|
1549
|
+
"VERIFICATION_UNAVAILABLE",
|
|
1550
|
+
"IDENTITY_CHANGED",
|
|
1527
1551
|
"INVALID_REQUEST",
|
|
1528
1552
|
"ORIGIN_DENIED",
|
|
1529
1553
|
"NOT_FOUND",
|
|
@@ -1582,7 +1606,7 @@
|
|
|
1582
1606
|
"token",
|
|
1583
1607
|
"conversation_id",
|
|
1584
1608
|
"expires_at",
|
|
1585
|
-
"
|
|
1609
|
+
"website_chat"
|
|
1586
1610
|
],
|
|
1587
1611
|
"properties": {
|
|
1588
1612
|
"token": {
|
|
@@ -1596,7 +1620,7 @@
|
|
|
1596
1620
|
"type": "integer",
|
|
1597
1621
|
"description": "Unix seconds"
|
|
1598
1622
|
},
|
|
1599
|
-
"
|
|
1623
|
+
"website_chat": {
|
|
1600
1624
|
"type": "object",
|
|
1601
1625
|
"required": [
|
|
1602
1626
|
"key",
|
|
@@ -1622,6 +1646,18 @@
|
|
|
1622
1646
|
"de"
|
|
1623
1647
|
]
|
|
1624
1648
|
},
|
|
1649
|
+
"authentication": {
|
|
1650
|
+
"type": "object",
|
|
1651
|
+
"additionalProperties": false,
|
|
1652
|
+
"required": [
|
|
1653
|
+
"email_code"
|
|
1654
|
+
],
|
|
1655
|
+
"properties": {
|
|
1656
|
+
"email_code": {
|
|
1657
|
+
"type": "boolean"
|
|
1658
|
+
}
|
|
1659
|
+
}
|
|
1660
|
+
},
|
|
1625
1661
|
"design": {
|
|
1626
1662
|
"type": "object",
|
|
1627
1663
|
"additionalProperties": false,
|
|
@@ -1773,7 +1809,7 @@
|
|
|
1773
1809
|
}
|
|
1774
1810
|
},
|
|
1775
1811
|
"default": {
|
|
1776
|
-
"description": "400 invalid input, 401 expired capability, 403 origin denied, 404 unpublished
|
|
1812
|
+
"description": "400 invalid input, 401 expired capability, 403 origin denied, 404 unpublished Website Chat, 409 conflict, 413 too large, 429 rate limit, or 503 unavailable.",
|
|
1777
1813
|
"content": {
|
|
1778
1814
|
"application/json": {
|
|
1779
1815
|
"schema": {
|
|
@@ -1785,6 +1821,12 @@
|
|
|
1785
1821
|
"code": {
|
|
1786
1822
|
"type": "string",
|
|
1787
1823
|
"enum": [
|
|
1824
|
+
"INVALID_VERIFICATION_CODE",
|
|
1825
|
+
"VERIFICATION_EXPIRED",
|
|
1826
|
+
"VERIFICATION_CONFLICT",
|
|
1827
|
+
"VERIFICATION_DISABLED",
|
|
1828
|
+
"VERIFICATION_UNAVAILABLE",
|
|
1829
|
+
"IDENTITY_CHANGED",
|
|
1788
1830
|
"INVALID_REQUEST",
|
|
1789
1831
|
"ORIGIN_DENIED",
|
|
1790
1832
|
"NOT_FOUND",
|
|
@@ -1870,7 +1912,7 @@
|
|
|
1870
1912
|
}
|
|
1871
1913
|
},
|
|
1872
1914
|
"default": {
|
|
1873
|
-
"description": "400 invalid input, 401 expired capability, 403 origin denied, 404 unpublished
|
|
1915
|
+
"description": "400 invalid input, 401 expired capability, 403 origin denied, 404 unpublished Website Chat, 409 conflict, 413 too large, 429 rate limit, or 503 unavailable.",
|
|
1874
1916
|
"content": {
|
|
1875
1917
|
"application/json": {
|
|
1876
1918
|
"schema": {
|
|
@@ -1882,6 +1924,511 @@
|
|
|
1882
1924
|
"code": {
|
|
1883
1925
|
"type": "string",
|
|
1884
1926
|
"enum": [
|
|
1927
|
+
"INVALID_VERIFICATION_CODE",
|
|
1928
|
+
"VERIFICATION_EXPIRED",
|
|
1929
|
+
"VERIFICATION_CONFLICT",
|
|
1930
|
+
"VERIFICATION_DISABLED",
|
|
1931
|
+
"VERIFICATION_UNAVAILABLE",
|
|
1932
|
+
"IDENTITY_CHANGED",
|
|
1933
|
+
"INVALID_REQUEST",
|
|
1934
|
+
"ORIGIN_DENIED",
|
|
1935
|
+
"NOT_FOUND",
|
|
1936
|
+
"INVALID_GRANT",
|
|
1937
|
+
"SESSION_EXPIRED",
|
|
1938
|
+
"RATE_LIMITED",
|
|
1939
|
+
"SESSION_LIMIT",
|
|
1940
|
+
"USAGE_LIMIT",
|
|
1941
|
+
"REQUEST_CONFLICT",
|
|
1942
|
+
"IN_PROGRESS",
|
|
1943
|
+
"UNAVAILABLE",
|
|
1944
|
+
"TEMPORARILY_UNAVAILABLE"
|
|
1945
|
+
]
|
|
1946
|
+
}
|
|
1947
|
+
}
|
|
1948
|
+
}
|
|
1949
|
+
}
|
|
1950
|
+
}
|
|
1951
|
+
}
|
|
1952
|
+
}
|
|
1953
|
+
}
|
|
1954
|
+
},
|
|
1955
|
+
"/v1/verification": {
|
|
1956
|
+
"get": {
|
|
1957
|
+
"operationId": "getChatVerification",
|
|
1958
|
+
"security": [
|
|
1959
|
+
{
|
|
1960
|
+
"AnonymousSession": []
|
|
1961
|
+
}
|
|
1962
|
+
],
|
|
1963
|
+
"description": "Read this session's verification state. No contact IDs or candidate records are exposed.",
|
|
1964
|
+
"responses": {
|
|
1965
|
+
"200": {
|
|
1966
|
+
"description": "Current verification state",
|
|
1967
|
+
"content": {
|
|
1968
|
+
"application/json": {
|
|
1969
|
+
"schema": {
|
|
1970
|
+
"type": "object",
|
|
1971
|
+
"additionalProperties": false,
|
|
1972
|
+
"required": [
|
|
1973
|
+
"available",
|
|
1974
|
+
"conversation_id",
|
|
1975
|
+
"status"
|
|
1976
|
+
],
|
|
1977
|
+
"properties": {
|
|
1978
|
+
"available": {
|
|
1979
|
+
"type": "boolean"
|
|
1980
|
+
},
|
|
1981
|
+
"conversation_id": {
|
|
1982
|
+
"type": "string",
|
|
1983
|
+
"format": "uuid"
|
|
1984
|
+
},
|
|
1985
|
+
"status": {
|
|
1986
|
+
"type": "string",
|
|
1987
|
+
"enum": [
|
|
1988
|
+
"anonymous",
|
|
1989
|
+
"sending",
|
|
1990
|
+
"pending",
|
|
1991
|
+
"verified"
|
|
1992
|
+
]
|
|
1993
|
+
},
|
|
1994
|
+
"challenge_id": {
|
|
1995
|
+
"type": "string",
|
|
1996
|
+
"format": "uuid"
|
|
1997
|
+
},
|
|
1998
|
+
"code_expires_at": {
|
|
1999
|
+
"type": "integer",
|
|
2000
|
+
"description": "Unix seconds"
|
|
2001
|
+
},
|
|
2002
|
+
"resend_after": {
|
|
2003
|
+
"type": "integer",
|
|
2004
|
+
"description": "Unix seconds"
|
|
2005
|
+
},
|
|
2006
|
+
"email": {
|
|
2007
|
+
"type": "string",
|
|
2008
|
+
"format": "email",
|
|
2009
|
+
"maxLength": 254
|
|
2010
|
+
},
|
|
2011
|
+
"contact_resolution": {
|
|
2012
|
+
"type": "string",
|
|
2013
|
+
"enum": [
|
|
2014
|
+
"matched",
|
|
2015
|
+
"ambiguous",
|
|
2016
|
+
"not_found"
|
|
2017
|
+
]
|
|
2018
|
+
}
|
|
2019
|
+
}
|
|
2020
|
+
}
|
|
2021
|
+
}
|
|
2022
|
+
}
|
|
2023
|
+
},
|
|
2024
|
+
"default": {
|
|
2025
|
+
"description": "400 invalid input, 401 expired capability, 403 origin denied, 404 unpublished Website Chat, 409 conflict, 413 too large, 429 rate limit, or 503 unavailable.",
|
|
2026
|
+
"content": {
|
|
2027
|
+
"application/json": {
|
|
2028
|
+
"schema": {
|
|
2029
|
+
"type": "object",
|
|
2030
|
+
"required": [
|
|
2031
|
+
"code"
|
|
2032
|
+
],
|
|
2033
|
+
"properties": {
|
|
2034
|
+
"code": {
|
|
2035
|
+
"type": "string",
|
|
2036
|
+
"enum": [
|
|
2037
|
+
"INVALID_VERIFICATION_CODE",
|
|
2038
|
+
"VERIFICATION_EXPIRED",
|
|
2039
|
+
"VERIFICATION_CONFLICT",
|
|
2040
|
+
"VERIFICATION_DISABLED",
|
|
2041
|
+
"VERIFICATION_UNAVAILABLE",
|
|
2042
|
+
"IDENTITY_CHANGED",
|
|
2043
|
+
"INVALID_REQUEST",
|
|
2044
|
+
"ORIGIN_DENIED",
|
|
2045
|
+
"NOT_FOUND",
|
|
2046
|
+
"INVALID_GRANT",
|
|
2047
|
+
"SESSION_EXPIRED",
|
|
2048
|
+
"RATE_LIMITED",
|
|
2049
|
+
"SESSION_LIMIT",
|
|
2050
|
+
"USAGE_LIMIT",
|
|
2051
|
+
"REQUEST_CONFLICT",
|
|
2052
|
+
"IN_PROGRESS",
|
|
2053
|
+
"UNAVAILABLE",
|
|
2054
|
+
"TEMPORARILY_UNAVAILABLE"
|
|
2055
|
+
]
|
|
2056
|
+
}
|
|
2057
|
+
}
|
|
2058
|
+
}
|
|
2059
|
+
}
|
|
2060
|
+
}
|
|
2061
|
+
}
|
|
2062
|
+
}
|
|
2063
|
+
}
|
|
2064
|
+
},
|
|
2065
|
+
"/v1/verification/email": {
|
|
2066
|
+
"post": {
|
|
2067
|
+
"operationId": "startChatEmailVerification",
|
|
2068
|
+
"security": [
|
|
2069
|
+
{
|
|
2070
|
+
"AnonymousSession": []
|
|
2071
|
+
}
|
|
2072
|
+
],
|
|
2073
|
+
"description": "Start or resend an email challenge using the template saved on this session's Website Chat. Repeating the same request_id and payload does not send another email. Codes must never be sent as chat messages.",
|
|
2074
|
+
"requestBody": {
|
|
2075
|
+
"required": true,
|
|
2076
|
+
"content": {
|
|
2077
|
+
"application/json": {
|
|
2078
|
+
"schema": {
|
|
2079
|
+
"type": "object",
|
|
2080
|
+
"additionalProperties": false,
|
|
2081
|
+
"required": [
|
|
2082
|
+
"request_id",
|
|
2083
|
+
"email",
|
|
2084
|
+
"locale"
|
|
2085
|
+
],
|
|
2086
|
+
"properties": {
|
|
2087
|
+
"request_id": {
|
|
2088
|
+
"type": "string",
|
|
2089
|
+
"format": "uuid"
|
|
2090
|
+
},
|
|
2091
|
+
"email": {
|
|
2092
|
+
"type": "string",
|
|
2093
|
+
"format": "email",
|
|
2094
|
+
"maxLength": 254
|
|
2095
|
+
},
|
|
2096
|
+
"locale": {
|
|
2097
|
+
"type": "string",
|
|
2098
|
+
"enum": [
|
|
2099
|
+
"en",
|
|
2100
|
+
"de"
|
|
2101
|
+
]
|
|
2102
|
+
}
|
|
2103
|
+
}
|
|
2104
|
+
}
|
|
2105
|
+
}
|
|
2106
|
+
}
|
|
2107
|
+
},
|
|
2108
|
+
"responses": {
|
|
2109
|
+
"200": {
|
|
2110
|
+
"description": "Current verification state; pending does not reveal whether an email is registered",
|
|
2111
|
+
"content": {
|
|
2112
|
+
"application/json": {
|
|
2113
|
+
"schema": {
|
|
2114
|
+
"type": "object",
|
|
2115
|
+
"additionalProperties": false,
|
|
2116
|
+
"required": [
|
|
2117
|
+
"available",
|
|
2118
|
+
"conversation_id",
|
|
2119
|
+
"status"
|
|
2120
|
+
],
|
|
2121
|
+
"properties": {
|
|
2122
|
+
"available": {
|
|
2123
|
+
"type": "boolean"
|
|
2124
|
+
},
|
|
2125
|
+
"conversation_id": {
|
|
2126
|
+
"type": "string",
|
|
2127
|
+
"format": "uuid"
|
|
2128
|
+
},
|
|
2129
|
+
"status": {
|
|
2130
|
+
"type": "string",
|
|
2131
|
+
"enum": [
|
|
2132
|
+
"anonymous",
|
|
2133
|
+
"sending",
|
|
2134
|
+
"pending",
|
|
2135
|
+
"verified"
|
|
2136
|
+
]
|
|
2137
|
+
},
|
|
2138
|
+
"challenge_id": {
|
|
2139
|
+
"type": "string",
|
|
2140
|
+
"format": "uuid"
|
|
2141
|
+
},
|
|
2142
|
+
"code_expires_at": {
|
|
2143
|
+
"type": "integer",
|
|
2144
|
+
"description": "Unix seconds"
|
|
2145
|
+
},
|
|
2146
|
+
"resend_after": {
|
|
2147
|
+
"type": "integer",
|
|
2148
|
+
"description": "Unix seconds"
|
|
2149
|
+
},
|
|
2150
|
+
"email": {
|
|
2151
|
+
"type": "string",
|
|
2152
|
+
"format": "email",
|
|
2153
|
+
"maxLength": 254
|
|
2154
|
+
},
|
|
2155
|
+
"contact_resolution": {
|
|
2156
|
+
"type": "string",
|
|
2157
|
+
"enum": [
|
|
2158
|
+
"matched",
|
|
2159
|
+
"ambiguous",
|
|
2160
|
+
"not_found"
|
|
2161
|
+
]
|
|
2162
|
+
}
|
|
2163
|
+
}
|
|
2164
|
+
}
|
|
2165
|
+
}
|
|
2166
|
+
}
|
|
2167
|
+
},
|
|
2168
|
+
"default": {
|
|
2169
|
+
"description": "400 invalid input, 401 expired capability, 403 origin denied, 404 unpublished Website Chat, 409 conflict, 413 too large, 429 rate limit, or 503 unavailable.",
|
|
2170
|
+
"content": {
|
|
2171
|
+
"application/json": {
|
|
2172
|
+
"schema": {
|
|
2173
|
+
"type": "object",
|
|
2174
|
+
"required": [
|
|
2175
|
+
"code"
|
|
2176
|
+
],
|
|
2177
|
+
"properties": {
|
|
2178
|
+
"code": {
|
|
2179
|
+
"type": "string",
|
|
2180
|
+
"enum": [
|
|
2181
|
+
"INVALID_VERIFICATION_CODE",
|
|
2182
|
+
"VERIFICATION_EXPIRED",
|
|
2183
|
+
"VERIFICATION_CONFLICT",
|
|
2184
|
+
"VERIFICATION_DISABLED",
|
|
2185
|
+
"VERIFICATION_UNAVAILABLE",
|
|
2186
|
+
"IDENTITY_CHANGED",
|
|
2187
|
+
"INVALID_REQUEST",
|
|
2188
|
+
"ORIGIN_DENIED",
|
|
2189
|
+
"NOT_FOUND",
|
|
2190
|
+
"INVALID_GRANT",
|
|
2191
|
+
"SESSION_EXPIRED",
|
|
2192
|
+
"RATE_LIMITED",
|
|
2193
|
+
"SESSION_LIMIT",
|
|
2194
|
+
"USAGE_LIMIT",
|
|
2195
|
+
"REQUEST_CONFLICT",
|
|
2196
|
+
"IN_PROGRESS",
|
|
2197
|
+
"UNAVAILABLE",
|
|
2198
|
+
"TEMPORARILY_UNAVAILABLE"
|
|
2199
|
+
]
|
|
2200
|
+
}
|
|
2201
|
+
}
|
|
2202
|
+
}
|
|
2203
|
+
}
|
|
2204
|
+
}
|
|
2205
|
+
}
|
|
2206
|
+
}
|
|
2207
|
+
}
|
|
2208
|
+
},
|
|
2209
|
+
"/v1/verification/code": {
|
|
2210
|
+
"post": {
|
|
2211
|
+
"operationId": "verifyChatEmailCode",
|
|
2212
|
+
"security": [
|
|
2213
|
+
{
|
|
2214
|
+
"AnonymousSession": []
|
|
2215
|
+
}
|
|
2216
|
+
],
|
|
2217
|
+
"description": "Verify a code for this session's current challenge. Success binds email proof and contact resolution to this session and starts a new conversation. It grants no account-tool permission.",
|
|
2218
|
+
"requestBody": {
|
|
2219
|
+
"required": true,
|
|
2220
|
+
"content": {
|
|
2221
|
+
"application/json": {
|
|
2222
|
+
"schema": {
|
|
2223
|
+
"type": "object",
|
|
2224
|
+
"additionalProperties": false,
|
|
2225
|
+
"required": [
|
|
2226
|
+
"challenge_id",
|
|
2227
|
+
"code"
|
|
2228
|
+
],
|
|
2229
|
+
"properties": {
|
|
2230
|
+
"challenge_id": {
|
|
2231
|
+
"type": "string",
|
|
2232
|
+
"format": "uuid"
|
|
2233
|
+
},
|
|
2234
|
+
"code": {
|
|
2235
|
+
"type": "string",
|
|
2236
|
+
"pattern": "^\\d{6}$"
|
|
2237
|
+
}
|
|
2238
|
+
}
|
|
2239
|
+
}
|
|
2240
|
+
}
|
|
2241
|
+
}
|
|
2242
|
+
},
|
|
2243
|
+
"responses": {
|
|
2244
|
+
"200": {
|
|
2245
|
+
"description": "Verification result; duplicate contacts remain unresolved",
|
|
2246
|
+
"content": {
|
|
2247
|
+
"application/json": {
|
|
2248
|
+
"schema": {
|
|
2249
|
+
"type": "object",
|
|
2250
|
+
"additionalProperties": false,
|
|
2251
|
+
"required": [
|
|
2252
|
+
"available",
|
|
2253
|
+
"conversation_id",
|
|
2254
|
+
"status"
|
|
2255
|
+
],
|
|
2256
|
+
"properties": {
|
|
2257
|
+
"available": {
|
|
2258
|
+
"type": "boolean"
|
|
2259
|
+
},
|
|
2260
|
+
"conversation_id": {
|
|
2261
|
+
"type": "string",
|
|
2262
|
+
"format": "uuid"
|
|
2263
|
+
},
|
|
2264
|
+
"status": {
|
|
2265
|
+
"type": "string",
|
|
2266
|
+
"enum": [
|
|
2267
|
+
"anonymous",
|
|
2268
|
+
"sending",
|
|
2269
|
+
"pending",
|
|
2270
|
+
"verified"
|
|
2271
|
+
]
|
|
2272
|
+
},
|
|
2273
|
+
"challenge_id": {
|
|
2274
|
+
"type": "string",
|
|
2275
|
+
"format": "uuid"
|
|
2276
|
+
},
|
|
2277
|
+
"code_expires_at": {
|
|
2278
|
+
"type": "integer",
|
|
2279
|
+
"description": "Unix seconds"
|
|
2280
|
+
},
|
|
2281
|
+
"resend_after": {
|
|
2282
|
+
"type": "integer",
|
|
2283
|
+
"description": "Unix seconds"
|
|
2284
|
+
},
|
|
2285
|
+
"email": {
|
|
2286
|
+
"type": "string",
|
|
2287
|
+
"format": "email",
|
|
2288
|
+
"maxLength": 254
|
|
2289
|
+
},
|
|
2290
|
+
"contact_resolution": {
|
|
2291
|
+
"type": "string",
|
|
2292
|
+
"enum": [
|
|
2293
|
+
"matched",
|
|
2294
|
+
"ambiguous",
|
|
2295
|
+
"not_found"
|
|
2296
|
+
]
|
|
2297
|
+
}
|
|
2298
|
+
}
|
|
2299
|
+
}
|
|
2300
|
+
}
|
|
2301
|
+
}
|
|
2302
|
+
},
|
|
2303
|
+
"default": {
|
|
2304
|
+
"description": "400 invalid input, 401 expired capability, 403 origin denied, 404 unpublished Website Chat, 409 conflict, 413 too large, 429 rate limit, or 503 unavailable.",
|
|
2305
|
+
"content": {
|
|
2306
|
+
"application/json": {
|
|
2307
|
+
"schema": {
|
|
2308
|
+
"type": "object",
|
|
2309
|
+
"required": [
|
|
2310
|
+
"code"
|
|
2311
|
+
],
|
|
2312
|
+
"properties": {
|
|
2313
|
+
"code": {
|
|
2314
|
+
"type": "string",
|
|
2315
|
+
"enum": [
|
|
2316
|
+
"INVALID_VERIFICATION_CODE",
|
|
2317
|
+
"VERIFICATION_EXPIRED",
|
|
2318
|
+
"VERIFICATION_CONFLICT",
|
|
2319
|
+
"VERIFICATION_DISABLED",
|
|
2320
|
+
"VERIFICATION_UNAVAILABLE",
|
|
2321
|
+
"IDENTITY_CHANGED",
|
|
2322
|
+
"INVALID_REQUEST",
|
|
2323
|
+
"ORIGIN_DENIED",
|
|
2324
|
+
"NOT_FOUND",
|
|
2325
|
+
"INVALID_GRANT",
|
|
2326
|
+
"SESSION_EXPIRED",
|
|
2327
|
+
"RATE_LIMITED",
|
|
2328
|
+
"SESSION_LIMIT",
|
|
2329
|
+
"USAGE_LIMIT",
|
|
2330
|
+
"REQUEST_CONFLICT",
|
|
2331
|
+
"IN_PROGRESS",
|
|
2332
|
+
"UNAVAILABLE",
|
|
2333
|
+
"TEMPORARILY_UNAVAILABLE"
|
|
2334
|
+
]
|
|
2335
|
+
}
|
|
2336
|
+
}
|
|
2337
|
+
}
|
|
2338
|
+
}
|
|
2339
|
+
}
|
|
2340
|
+
}
|
|
2341
|
+
}
|
|
2342
|
+
}
|
|
2343
|
+
},
|
|
2344
|
+
"/v1/verification/cancel": {
|
|
2345
|
+
"post": {
|
|
2346
|
+
"operationId": "cancelChatVerification",
|
|
2347
|
+
"security": [
|
|
2348
|
+
{
|
|
2349
|
+
"AnonymousSession": []
|
|
2350
|
+
}
|
|
2351
|
+
],
|
|
2352
|
+
"description": "Cancel a pending challenge or clear verified identity. Clearing verified identity starts a new anonymous conversation. In-flight verification cannot restore the cleared identity.",
|
|
2353
|
+
"responses": {
|
|
2354
|
+
"200": {
|
|
2355
|
+
"description": "Anonymous session state",
|
|
2356
|
+
"content": {
|
|
2357
|
+
"application/json": {
|
|
2358
|
+
"schema": {
|
|
2359
|
+
"type": "object",
|
|
2360
|
+
"additionalProperties": false,
|
|
2361
|
+
"required": [
|
|
2362
|
+
"available",
|
|
2363
|
+
"conversation_id",
|
|
2364
|
+
"status"
|
|
2365
|
+
],
|
|
2366
|
+
"properties": {
|
|
2367
|
+
"available": {
|
|
2368
|
+
"type": "boolean"
|
|
2369
|
+
},
|
|
2370
|
+
"conversation_id": {
|
|
2371
|
+
"type": "string",
|
|
2372
|
+
"format": "uuid"
|
|
2373
|
+
},
|
|
2374
|
+
"status": {
|
|
2375
|
+
"type": "string",
|
|
2376
|
+
"enum": [
|
|
2377
|
+
"anonymous",
|
|
2378
|
+
"sending",
|
|
2379
|
+
"pending",
|
|
2380
|
+
"verified"
|
|
2381
|
+
]
|
|
2382
|
+
},
|
|
2383
|
+
"challenge_id": {
|
|
2384
|
+
"type": "string",
|
|
2385
|
+
"format": "uuid"
|
|
2386
|
+
},
|
|
2387
|
+
"code_expires_at": {
|
|
2388
|
+
"type": "integer",
|
|
2389
|
+
"description": "Unix seconds"
|
|
2390
|
+
},
|
|
2391
|
+
"resend_after": {
|
|
2392
|
+
"type": "integer",
|
|
2393
|
+
"description": "Unix seconds"
|
|
2394
|
+
},
|
|
2395
|
+
"email": {
|
|
2396
|
+
"type": "string",
|
|
2397
|
+
"format": "email",
|
|
2398
|
+
"maxLength": 254
|
|
2399
|
+
},
|
|
2400
|
+
"contact_resolution": {
|
|
2401
|
+
"type": "string",
|
|
2402
|
+
"enum": [
|
|
2403
|
+
"matched",
|
|
2404
|
+
"ambiguous",
|
|
2405
|
+
"not_found"
|
|
2406
|
+
]
|
|
2407
|
+
}
|
|
2408
|
+
}
|
|
2409
|
+
}
|
|
2410
|
+
}
|
|
2411
|
+
}
|
|
2412
|
+
},
|
|
2413
|
+
"default": {
|
|
2414
|
+
"description": "400 invalid input, 401 expired capability, 403 origin denied, 404 unpublished Website Chat, 409 conflict, 413 too large, 429 rate limit, or 503 unavailable.",
|
|
2415
|
+
"content": {
|
|
2416
|
+
"application/json": {
|
|
2417
|
+
"schema": {
|
|
2418
|
+
"type": "object",
|
|
2419
|
+
"required": [
|
|
2420
|
+
"code"
|
|
2421
|
+
],
|
|
2422
|
+
"properties": {
|
|
2423
|
+
"code": {
|
|
2424
|
+
"type": "string",
|
|
2425
|
+
"enum": [
|
|
2426
|
+
"INVALID_VERIFICATION_CODE",
|
|
2427
|
+
"VERIFICATION_EXPIRED",
|
|
2428
|
+
"VERIFICATION_CONFLICT",
|
|
2429
|
+
"VERIFICATION_DISABLED",
|
|
2430
|
+
"VERIFICATION_UNAVAILABLE",
|
|
2431
|
+
"IDENTITY_CHANGED",
|
|
1885
2432
|
"INVALID_REQUEST",
|
|
1886
2433
|
"ORIGIN_DENIED",
|
|
1887
2434
|
"NOT_FOUND",
|
|
@@ -1914,29 +2461,29 @@
|
|
|
1914
2461
|
"AnonymousSession": {
|
|
1915
2462
|
"type": "http",
|
|
1916
2463
|
"scheme": "bearer",
|
|
1917
|
-
"description": "Opaque, expiring
|
|
2464
|
+
"description": "Opaque, expiring Chat session token; never an epilot user or Portal access token."
|
|
1918
2465
|
}
|
|
1919
2466
|
},
|
|
1920
2467
|
"schemas": {
|
|
1921
|
-
"
|
|
2468
|
+
"ListWebsiteChatsResponse": {
|
|
1922
2469
|
"type": "object",
|
|
1923
2470
|
"required": [
|
|
1924
|
-
"
|
|
2471
|
+
"website_chats"
|
|
1925
2472
|
],
|
|
1926
2473
|
"properties": {
|
|
1927
|
-
"
|
|
2474
|
+
"website_chats": {
|
|
1928
2475
|
"type": "array",
|
|
1929
2476
|
"items": {
|
|
1930
2477
|
"type": "object",
|
|
1931
2478
|
"required": [
|
|
1932
|
-
"
|
|
2479
|
+
"website_chat_id",
|
|
1933
2480
|
"org_id",
|
|
1934
2481
|
"agent_id",
|
|
1935
2482
|
"binding_id",
|
|
1936
2483
|
"version",
|
|
1937
2484
|
"name",
|
|
1938
|
-
"
|
|
1939
|
-
"
|
|
2485
|
+
"settings",
|
|
2486
|
+
"embed",
|
|
1940
2487
|
"created_at",
|
|
1941
2488
|
"updated_at"
|
|
1942
2489
|
],
|
|
@@ -1951,7 +2498,7 @@
|
|
|
1951
2498
|
"format": "uuid",
|
|
1952
2499
|
"nullable": true
|
|
1953
2500
|
},
|
|
1954
|
-
"
|
|
2501
|
+
"settings": {
|
|
1955
2502
|
"type": "object",
|
|
1956
2503
|
"additionalProperties": false,
|
|
1957
2504
|
"required": [
|
|
@@ -1964,7 +2511,7 @@
|
|
|
1964
2511
|
"type": "array",
|
|
1965
2512
|
"maxItems": 50,
|
|
1966
2513
|
"uniqueItems": true,
|
|
1967
|
-
"description": "Exact HTTPS origins. Empty means the
|
|
2514
|
+
"description": "Exact HTTPS origins. Empty means the Website Chat cannot start sessions.",
|
|
1968
2515
|
"items": {
|
|
1969
2516
|
"type": "string",
|
|
1970
2517
|
"maxLength": 2048
|
|
@@ -1986,7 +2533,7 @@
|
|
|
1986
2533
|
"type": "string",
|
|
1987
2534
|
"format": "uuid",
|
|
1988
2535
|
"nullable": true,
|
|
1989
|
-
"description": "Design Builder configuration for the
|
|
2536
|
+
"description": "Design Builder configuration for the Website Chat only."
|
|
1990
2537
|
},
|
|
1991
2538
|
"authentication": {
|
|
1992
2539
|
"type": "object",
|
|
@@ -2012,7 +2559,7 @@
|
|
|
2012
2559
|
}
|
|
2013
2560
|
}
|
|
2014
2561
|
},
|
|
2015
|
-
"
|
|
2562
|
+
"website_chat_id": {
|
|
2016
2563
|
"type": "string",
|
|
2017
2564
|
"format": "uuid",
|
|
2018
2565
|
"readOnly": true,
|
|
@@ -2043,7 +2590,7 @@
|
|
|
2043
2590
|
"format": "date-time",
|
|
2044
2591
|
"readOnly": true
|
|
2045
2592
|
},
|
|
2046
|
-
"
|
|
2593
|
+
"embed": {
|
|
2047
2594
|
"type": "object",
|
|
2048
2595
|
"readOnly": true,
|
|
2049
2596
|
"required": [
|
|
@@ -2074,17 +2621,17 @@
|
|
|
2074
2621
|
}
|
|
2075
2622
|
}
|
|
2076
2623
|
},
|
|
2077
|
-
"
|
|
2624
|
+
"WebsiteChat": {
|
|
2078
2625
|
"type": "object",
|
|
2079
2626
|
"required": [
|
|
2080
|
-
"
|
|
2627
|
+
"website_chat_id",
|
|
2081
2628
|
"org_id",
|
|
2082
2629
|
"agent_id",
|
|
2083
2630
|
"binding_id",
|
|
2084
2631
|
"version",
|
|
2085
2632
|
"name",
|
|
2086
|
-
"
|
|
2087
|
-
"
|
|
2633
|
+
"settings",
|
|
2634
|
+
"embed",
|
|
2088
2635
|
"created_at",
|
|
2089
2636
|
"updated_at"
|
|
2090
2637
|
],
|
|
@@ -2099,7 +2646,7 @@
|
|
|
2099
2646
|
"format": "uuid",
|
|
2100
2647
|
"nullable": true
|
|
2101
2648
|
},
|
|
2102
|
-
"
|
|
2649
|
+
"settings": {
|
|
2103
2650
|
"type": "object",
|
|
2104
2651
|
"additionalProperties": false,
|
|
2105
2652
|
"required": [
|
|
@@ -2112,7 +2659,7 @@
|
|
|
2112
2659
|
"type": "array",
|
|
2113
2660
|
"maxItems": 50,
|
|
2114
2661
|
"uniqueItems": true,
|
|
2115
|
-
"description": "Exact HTTPS origins. Empty means the
|
|
2662
|
+
"description": "Exact HTTPS origins. Empty means the Website Chat cannot start sessions.",
|
|
2116
2663
|
"items": {
|
|
2117
2664
|
"type": "string",
|
|
2118
2665
|
"maxLength": 2048
|
|
@@ -2134,7 +2681,7 @@
|
|
|
2134
2681
|
"type": "string",
|
|
2135
2682
|
"format": "uuid",
|
|
2136
2683
|
"nullable": true,
|
|
2137
|
-
"description": "Design Builder configuration for the
|
|
2684
|
+
"description": "Design Builder configuration for the Website Chat only."
|
|
2138
2685
|
},
|
|
2139
2686
|
"authentication": {
|
|
2140
2687
|
"type": "object",
|
|
@@ -2160,7 +2707,7 @@
|
|
|
2160
2707
|
}
|
|
2161
2708
|
}
|
|
2162
2709
|
},
|
|
2163
|
-
"
|
|
2710
|
+
"website_chat_id": {
|
|
2164
2711
|
"type": "string",
|
|
2165
2712
|
"format": "uuid",
|
|
2166
2713
|
"readOnly": true,
|
|
@@ -2191,7 +2738,7 @@
|
|
|
2191
2738
|
"format": "date-time",
|
|
2192
2739
|
"readOnly": true
|
|
2193
2740
|
},
|
|
2194
|
-
"
|
|
2741
|
+
"embed": {
|
|
2195
2742
|
"type": "object",
|
|
2196
2743
|
"readOnly": true,
|
|
2197
2744
|
"required": [
|
|
@@ -2229,7 +2776,7 @@
|
|
|
2229
2776
|
"type": "array",
|
|
2230
2777
|
"maxItems": 50,
|
|
2231
2778
|
"uniqueItems": true,
|
|
2232
|
-
"description": "Exact HTTPS origins. Empty means the
|
|
2779
|
+
"description": "Exact HTTPS origins. Empty means the Website Chat cannot start sessions.",
|
|
2233
2780
|
"items": {
|
|
2234
2781
|
"type": "string",
|
|
2235
2782
|
"maxLength": 2048
|
|
@@ -2251,7 +2798,7 @@
|
|
|
2251
2798
|
"type": "string",
|
|
2252
2799
|
"format": "uuid",
|
|
2253
2800
|
"nullable": true,
|
|
2254
|
-
"description": "Design Builder configuration for the
|
|
2801
|
+
"description": "Design Builder configuration for the Website Chat only."
|
|
2255
2802
|
},
|
|
2256
2803
|
"authentication": {
|
|
2257
2804
|
"type": "object",
|
|
@@ -2291,13 +2838,13 @@
|
|
|
2291
2838
|
}
|
|
2292
2839
|
}
|
|
2293
2840
|
},
|
|
2294
|
-
"
|
|
2841
|
+
"CreateWebsiteChatRequest": {
|
|
2295
2842
|
"type": "object",
|
|
2296
2843
|
"additionalProperties": false,
|
|
2297
2844
|
"required": [
|
|
2298
2845
|
"name",
|
|
2299
2846
|
"agent_id",
|
|
2300
|
-
"
|
|
2847
|
+
"settings"
|
|
2301
2848
|
],
|
|
2302
2849
|
"properties": {
|
|
2303
2850
|
"name": {
|
|
@@ -2310,7 +2857,7 @@
|
|
|
2310
2857
|
"format": "uuid",
|
|
2311
2858
|
"nullable": true
|
|
2312
2859
|
},
|
|
2313
|
-
"
|
|
2860
|
+
"settings": {
|
|
2314
2861
|
"type": "object",
|
|
2315
2862
|
"additionalProperties": false,
|
|
2316
2863
|
"required": [
|
|
@@ -2323,7 +2870,7 @@
|
|
|
2323
2870
|
"type": "array",
|
|
2324
2871
|
"maxItems": 50,
|
|
2325
2872
|
"uniqueItems": true,
|
|
2326
|
-
"description": "Exact HTTPS origins. Empty means the
|
|
2873
|
+
"description": "Exact HTTPS origins. Empty means the Website Chat cannot start sessions.",
|
|
2327
2874
|
"items": {
|
|
2328
2875
|
"type": "string",
|
|
2329
2876
|
"maxLength": 2048
|
|
@@ -2345,7 +2892,7 @@
|
|
|
2345
2892
|
"type": "string",
|
|
2346
2893
|
"format": "uuid",
|
|
2347
2894
|
"nullable": true,
|
|
2348
|
-
"description": "Design Builder configuration for the
|
|
2895
|
+
"description": "Design Builder configuration for the Website Chat only."
|
|
2349
2896
|
},
|
|
2350
2897
|
"authentication": {
|
|
2351
2898
|
"type": "object",
|
|
@@ -2373,7 +2920,7 @@
|
|
|
2373
2920
|
}
|
|
2374
2921
|
}
|
|
2375
2922
|
},
|
|
2376
|
-
"
|
|
2923
|
+
"UpdateWebsiteChatRequest": {
|
|
2377
2924
|
"type": "object",
|
|
2378
2925
|
"additionalProperties": false,
|
|
2379
2926
|
"required": [
|
|
@@ -2390,7 +2937,7 @@
|
|
|
2390
2937
|
"format": "uuid",
|
|
2391
2938
|
"nullable": true
|
|
2392
2939
|
},
|
|
2393
|
-
"
|
|
2940
|
+
"settings": {
|
|
2394
2941
|
"type": "object",
|
|
2395
2942
|
"additionalProperties": false,
|
|
2396
2943
|
"required": [
|
|
@@ -2403,7 +2950,7 @@
|
|
|
2403
2950
|
"type": "array",
|
|
2404
2951
|
"maxItems": 50,
|
|
2405
2952
|
"uniqueItems": true,
|
|
2406
|
-
"description": "Exact HTTPS origins. Empty means the
|
|
2953
|
+
"description": "Exact HTTPS origins. Empty means the Website Chat cannot start sessions.",
|
|
2407
2954
|
"items": {
|
|
2408
2955
|
"type": "string",
|
|
2409
2956
|
"maxLength": 2048
|
|
@@ -2425,7 +2972,7 @@
|
|
|
2425
2972
|
"type": "string",
|
|
2426
2973
|
"format": "uuid",
|
|
2427
2974
|
"nullable": true,
|
|
2428
|
-
"description": "Design Builder configuration for the
|
|
2975
|
+
"description": "Design Builder configuration for the Website Chat only."
|
|
2429
2976
|
},
|
|
2430
2977
|
"authentication": {
|
|
2431
2978
|
"type": "object",
|
|
@@ -2458,7 +3005,59 @@
|
|
|
2458
3005
|
}
|
|
2459
3006
|
}
|
|
2460
3007
|
},
|
|
2461
|
-
"
|
|
3008
|
+
"VerificationState": {
|
|
3009
|
+
"type": "object",
|
|
3010
|
+
"additionalProperties": false,
|
|
3011
|
+
"required": [
|
|
3012
|
+
"available",
|
|
3013
|
+
"conversation_id",
|
|
3014
|
+
"status"
|
|
3015
|
+
],
|
|
3016
|
+
"properties": {
|
|
3017
|
+
"available": {
|
|
3018
|
+
"type": "boolean"
|
|
3019
|
+
},
|
|
3020
|
+
"conversation_id": {
|
|
3021
|
+
"type": "string",
|
|
3022
|
+
"format": "uuid"
|
|
3023
|
+
},
|
|
3024
|
+
"status": {
|
|
3025
|
+
"type": "string",
|
|
3026
|
+
"enum": [
|
|
3027
|
+
"anonymous",
|
|
3028
|
+
"sending",
|
|
3029
|
+
"pending",
|
|
3030
|
+
"verified"
|
|
3031
|
+
]
|
|
3032
|
+
},
|
|
3033
|
+
"challenge_id": {
|
|
3034
|
+
"type": "string",
|
|
3035
|
+
"format": "uuid"
|
|
3036
|
+
},
|
|
3037
|
+
"code_expires_at": {
|
|
3038
|
+
"type": "integer",
|
|
3039
|
+
"description": "Unix seconds"
|
|
3040
|
+
},
|
|
3041
|
+
"resend_after": {
|
|
3042
|
+
"type": "integer",
|
|
3043
|
+
"description": "Unix seconds"
|
|
3044
|
+
},
|
|
3045
|
+
"email": {
|
|
3046
|
+
"type": "string",
|
|
3047
|
+
"format": "email",
|
|
3048
|
+
"maxLength": 254
|
|
3049
|
+
},
|
|
3050
|
+
"contact_resolution": {
|
|
3051
|
+
"type": "string",
|
|
3052
|
+
"enum": [
|
|
3053
|
+
"matched",
|
|
3054
|
+
"ambiguous",
|
|
3055
|
+
"not_found"
|
|
3056
|
+
]
|
|
3057
|
+
}
|
|
3058
|
+
}
|
|
3059
|
+
},
|
|
3060
|
+
"PublicWebsiteChat": {
|
|
2462
3061
|
"type": "object",
|
|
2463
3062
|
"required": [
|
|
2464
3063
|
"key",
|
|
@@ -2484,6 +3083,18 @@
|
|
|
2484
3083
|
"de"
|
|
2485
3084
|
]
|
|
2486
3085
|
},
|
|
3086
|
+
"authentication": {
|
|
3087
|
+
"type": "object",
|
|
3088
|
+
"additionalProperties": false,
|
|
3089
|
+
"required": [
|
|
3090
|
+
"email_code"
|
|
3091
|
+
],
|
|
3092
|
+
"properties": {
|
|
3093
|
+
"email_code": {
|
|
3094
|
+
"type": "boolean"
|
|
3095
|
+
}
|
|
3096
|
+
}
|
|
3097
|
+
},
|
|
2487
3098
|
"design": {
|
|
2488
3099
|
"type": "object",
|
|
2489
3100
|
"additionalProperties": false,
|
|
@@ -2629,7 +3240,7 @@
|
|
|
2629
3240
|
}
|
|
2630
3241
|
}
|
|
2631
3242
|
},
|
|
2632
|
-
"
|
|
3243
|
+
"WebsiteChatDesign": {
|
|
2633
3244
|
"type": "object",
|
|
2634
3245
|
"additionalProperties": false,
|
|
2635
3246
|
"properties": {
|
|
@@ -2854,6 +3465,12 @@
|
|
|
2854
3465
|
"code": {
|
|
2855
3466
|
"type": "string",
|
|
2856
3467
|
"enum": [
|
|
3468
|
+
"INVALID_VERIFICATION_CODE",
|
|
3469
|
+
"VERIFICATION_EXPIRED",
|
|
3470
|
+
"VERIFICATION_CONFLICT",
|
|
3471
|
+
"VERIFICATION_DISABLED",
|
|
3472
|
+
"VERIFICATION_UNAVAILABLE",
|
|
3473
|
+
"IDENTITY_CHANGED",
|
|
2857
3474
|
"INVALID_REQUEST",
|
|
2858
3475
|
"ORIGIN_DENIED",
|
|
2859
3476
|
"NOT_FOUND",
|
|
@@ -2873,7 +3490,7 @@
|
|
|
2873
3490
|
},
|
|
2874
3491
|
"responses": {
|
|
2875
3492
|
"Error": {
|
|
2876
|
-
"description": "400 invalid input, 401 expired capability, 403 origin denied, 404 unpublished
|
|
3493
|
+
"description": "400 invalid input, 401 expired capability, 403 origin denied, 404 unpublished Website Chat, 409 conflict, 413 too large, 429 rate limit, or 503 unavailable.",
|
|
2877
3494
|
"content": {
|
|
2878
3495
|
"application/json": {
|
|
2879
3496
|
"schema": {
|
|
@@ -2885,6 +3502,12 @@
|
|
|
2885
3502
|
"code": {
|
|
2886
3503
|
"type": "string",
|
|
2887
3504
|
"enum": [
|
|
3505
|
+
"INVALID_VERIFICATION_CODE",
|
|
3506
|
+
"VERIFICATION_EXPIRED",
|
|
3507
|
+
"VERIFICATION_CONFLICT",
|
|
3508
|
+
"VERIFICATION_DISABLED",
|
|
3509
|
+
"VERIFICATION_UNAVAILABLE",
|
|
3510
|
+
"IDENTITY_CHANGED",
|
|
2888
3511
|
"INVALID_REQUEST",
|
|
2889
3512
|
"ORIGIN_DENIED",
|
|
2890
3513
|
"NOT_FOUND",
|