crisp-api 10.9.2 → 10.10.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/CHANGELOG.md +6 -0
- package/EXAMPLES.md +8 -0
- package/README.md +449 -310
- package/dist/crisp.d.ts +2 -2
- package/dist/crisp.js +5 -1
- package/dist/resources/WebsiteBatch.d.ts +43 -0
- package/dist/resources/WebsiteBatch.js +42 -0
- package/dist/resources/WebsiteCampaign.d.ts +1 -0
- package/dist/resources/WebsiteConnect.d.ts +34 -0
- package/dist/resources/WebsiteConnect.js +37 -0
- package/dist/resources/WebsiteConversation.d.ts +1 -1
- package/dist/resources/WebsiteConversation.js +1 -1
- package/dist/resources/index.d.ts +1 -0
- package/dist/resources/index.js +1 -0
- package/dist/services/website.d.ts +2 -1
- package/dist/services/website.js +2 -0
- package/lib/crisp.ts +8 -2
- package/lib/resources/WebsiteBatch.ts +102 -0
- package/lib/resources/WebsiteCampaign.ts +1 -0
- package/lib/resources/WebsiteConnect.ts +57 -0
- package/lib/resources/WebsiteConversation.ts +2 -2
- package/lib/resources/index.ts +1 -0
- package/lib/services/website.ts +3 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -25,9 +25,9 @@ Then, add authentication parameters to your `client` instance right after you cr
|
|
|
25
25
|
var { Crisp } = require("crisp-api");
|
|
26
26
|
var CrispClient = new Crisp();
|
|
27
27
|
|
|
28
|
-
// Authenticate to API with your
|
|
28
|
+
// Authenticate to API with your token (identifier, key)
|
|
29
29
|
// eg. CrispClient.authenticate("7c3ef21c-1e04-41ce-8c06-5605c346f73e", "cc29e1a5086e428fcc6a697d5837a66d82808e65c5cce006fbf2191ceea80a0a");
|
|
30
|
-
CrispClient.authenticateTier(
|
|
30
|
+
CrispClient.authenticateTier(tier, identifier, key);
|
|
31
31
|
|
|
32
32
|
// Now, you can use authenticated API sections.
|
|
33
33
|
```
|
|
@@ -94,7 +94,7 @@ All the available Crisp API resources are fully implemented. **Programmatic meth
|
|
|
94
94
|
|
|
95
95
|
All methods that you will most likely need when building a Crisp integration are prefixed with a star symbol (⭐).
|
|
96
96
|
|
|
97
|
-
**⚠️ Note that, depending on your authentication token tier, which is either `user` or `plugin`, you may not be allowed to use all methods from the library. When in doubt, refer to the library method descriptions below. Most likely, you are using a `plugin` token.**
|
|
97
|
+
**⚠️ Note that, depending on your authentication token tier, which is either `user`, `website` or `plugin`, you may not be allowed to use all methods from the library. When in doubt, refer to the library method descriptions below. Most likely, you are using a `plugin` token.**
|
|
98
98
|
|
|
99
99
|
---
|
|
100
100
|
|
|
@@ -115,6 +115,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
115
115
|
<li><a href="#website-verify">Website Verify</a></li>
|
|
116
116
|
<li><a href="#website-campaigns">Website Campaigns</a></li>
|
|
117
117
|
<li><a href="#website-campaign">Website Campaign</a></li>
|
|
118
|
+
<li><a href="#website-connect">Website Connect</a></li>
|
|
118
119
|
</ul>
|
|
119
120
|
</details>
|
|
120
121
|
<details>
|
|
@@ -176,7 +177,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
176
177
|
### Website
|
|
177
178
|
|
|
178
179
|
* #### **Website Conversations**
|
|
179
|
-
* **⭐ List Conversations
|
|
180
|
+
* **⭐ List Conversations**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-conversations)
|
|
180
181
|
* `CrispClient.website.listConversations(websiteID, pageNumber, options)`
|
|
181
182
|
* <details>
|
|
182
183
|
<summary>See Example</summary>
|
|
@@ -193,7 +194,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
193
194
|
```
|
|
194
195
|
</details>
|
|
195
196
|
|
|
196
|
-
* **List Suggested Conversation Segments
|
|
197
|
+
* **List Suggested Conversation Segments**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-conversation-segments)
|
|
197
198
|
* `CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber)`
|
|
198
199
|
* <details>
|
|
199
200
|
<summary>See Example</summary>
|
|
@@ -206,7 +207,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
206
207
|
```
|
|
207
208
|
</details>
|
|
208
209
|
|
|
209
|
-
* **Delete Suggested Conversation Segment
|
|
210
|
+
* **Delete Suggested Conversation Segment**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-conversation-segment)
|
|
210
211
|
* `CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment)`
|
|
211
212
|
* <details>
|
|
212
213
|
<summary>See Example</summary>
|
|
@@ -220,7 +221,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
220
221
|
```
|
|
221
222
|
</details>
|
|
222
223
|
|
|
223
|
-
* **List Suggested Conversation Data Keys
|
|
224
|
+
* **List Suggested Conversation Data Keys**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-conversation-data-keys)
|
|
224
225
|
* `CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber)`
|
|
225
226
|
* <details>
|
|
226
227
|
<summary>See Example</summary>
|
|
@@ -233,7 +234,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
233
234
|
```
|
|
234
235
|
</details>
|
|
235
236
|
|
|
236
|
-
* **Delete Suggested Conversation Data Key
|
|
237
|
+
* **Delete Suggested Conversation Data Key**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-conversation-data-key)
|
|
237
238
|
* `CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key)`
|
|
238
239
|
* <details>
|
|
239
240
|
<summary>See Example</summary>
|
|
@@ -247,7 +248,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
247
248
|
```
|
|
248
249
|
</details>
|
|
249
250
|
|
|
250
|
-
* **List Spam Conversations
|
|
251
|
+
* **List Spam Conversations**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-spam-conversations)
|
|
251
252
|
* `CrispClient.website.listSpamConversations(websiteID, pageNumber)`
|
|
252
253
|
* <details>
|
|
253
254
|
<summary>See Example</summary>
|
|
@@ -260,7 +261,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
260
261
|
```
|
|
261
262
|
</details>
|
|
262
263
|
|
|
263
|
-
* **Resolve Spam Conversation Content
|
|
264
|
+
* **Resolve Spam Conversation Content**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-spam-conversation-content)
|
|
264
265
|
* `CrispClient.website.resolveSpamConversationContent(websiteID, spamID)`
|
|
265
266
|
* <details>
|
|
266
267
|
<summary>See Example</summary>
|
|
@@ -273,7 +274,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
273
274
|
```
|
|
274
275
|
</details>
|
|
275
276
|
|
|
276
|
-
* **Submit Spam Conversation Decision
|
|
277
|
+
* **Submit Spam Conversation Decision**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#submit-spam-conversation-decision)
|
|
277
278
|
* `CrispClient.website.submitSpamConversationDecision(websiteID, spamID, action)`
|
|
278
279
|
* <details>
|
|
279
280
|
<summary>See Example</summary>
|
|
@@ -290,7 +291,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
290
291
|
|
|
291
292
|
|
|
292
293
|
* #### **Website Conversation**
|
|
293
|
-
* **⭐ Create A New Conversation
|
|
294
|
+
* **⭐ Create A New Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-a-new-conversation)
|
|
294
295
|
* `CrispClient.website.createNewConversation(websiteID)`
|
|
295
296
|
* <details>
|
|
296
297
|
<summary>See Example</summary>
|
|
@@ -302,7 +303,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
302
303
|
```
|
|
303
304
|
</details>
|
|
304
305
|
|
|
305
|
-
* **Check If Conversation Exists
|
|
306
|
+
* **Check If Conversation Exists**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-conversation-exists)
|
|
306
307
|
* `CrispClient.website.checkConversationExists(websiteID, sessionID)`
|
|
307
308
|
* <details>
|
|
308
309
|
<summary>See Example</summary>
|
|
@@ -315,7 +316,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
315
316
|
```
|
|
316
317
|
</details>
|
|
317
318
|
|
|
318
|
-
* **⭐ Get A Conversation
|
|
319
|
+
* **⭐ Get A Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-conversation)
|
|
319
320
|
* `CrispClient.website.getConversation(websiteID, sessionID)`
|
|
320
321
|
* <details>
|
|
321
322
|
<summary>See Example</summary>
|
|
@@ -328,7 +329,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
328
329
|
```
|
|
329
330
|
</details>
|
|
330
331
|
|
|
331
|
-
* **Remove A Conversation
|
|
332
|
+
* **Remove A Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-a-conversation)
|
|
332
333
|
* `CrispClient.website.removeConversation(websiteID, sessionID)`
|
|
333
334
|
* <details>
|
|
334
335
|
<summary>See Example</summary>
|
|
@@ -341,7 +342,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
341
342
|
```
|
|
342
343
|
</details>
|
|
343
344
|
|
|
344
|
-
* **Initiate A Conversation With Existing Session
|
|
345
|
+
* **Initiate A Conversation With Existing Session**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#initiate-a-conversation-with-existing-session)
|
|
345
346
|
* `CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID)`
|
|
346
347
|
* <details>
|
|
347
348
|
<summary>See Example</summary>
|
|
@@ -354,7 +355,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
354
355
|
```
|
|
355
356
|
</details>
|
|
356
357
|
|
|
357
|
-
* **⭐ Get Messages In Conversation
|
|
358
|
+
* **⭐ Get Messages In Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-messages-in-conversation)
|
|
358
359
|
* `CrispClient.website.getMessagesInConversation(websiteID, sessionID, timestampBefore)`
|
|
359
360
|
* <details>
|
|
360
361
|
<summary>See Example</summary>
|
|
@@ -368,7 +369,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
368
369
|
```
|
|
369
370
|
</details>
|
|
370
371
|
|
|
371
|
-
* **⭐ Send A Message In Conversation
|
|
372
|
+
* **⭐ Send A Message In Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#send-a-message-in-conversation)
|
|
372
373
|
* `CrispClient.website.sendMessageInConversation(websiteID, sessionID, message)`
|
|
373
374
|
* <details>
|
|
374
375
|
<summary>See Example</summary>
|
|
@@ -388,7 +389,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
388
389
|
```
|
|
389
390
|
</details>
|
|
390
391
|
|
|
391
|
-
* **Get A Message In Conversation
|
|
392
|
+
* **Get A Message In Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-message-in-conversation)
|
|
392
393
|
* `CrispClient.website.getMessageInConversation(websiteID, sessionID, fingerprint)`
|
|
393
394
|
* <details>
|
|
394
395
|
<summary>See Example</summary>
|
|
@@ -402,7 +403,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
402
403
|
```
|
|
403
404
|
</details>
|
|
404
405
|
|
|
405
|
-
* **Update A Message In Conversation
|
|
406
|
+
* **Update A Message In Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-a-message-in-conversation)
|
|
406
407
|
* `CrispClient.website.updateMessageInConversation(websiteID, sessionID, fingerprint, content)`
|
|
407
408
|
* <details>
|
|
408
409
|
<summary>See Example</summary>
|
|
@@ -418,7 +419,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
418
419
|
```
|
|
419
420
|
</details>
|
|
420
421
|
|
|
421
|
-
* **Remove A Message In Conversation
|
|
422
|
+
* **Remove A Message In Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-a-message-in-conversation)
|
|
422
423
|
* `CrispClient.website.removeMessageInConversation(websiteID, sessionID, fingerprint)`
|
|
423
424
|
* <details>
|
|
424
425
|
<summary>See Example</summary>
|
|
@@ -432,7 +433,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
432
433
|
```
|
|
433
434
|
</details>
|
|
434
435
|
|
|
435
|
-
* **Compose A Message In Conversation
|
|
436
|
+
* **Compose A Message In Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#compose-a-message-in-conversation)
|
|
436
437
|
* `CrispClient.website.composeMessageInConversation(websiteID, sessionID, compose)`
|
|
437
438
|
* <details>
|
|
438
439
|
<summary>See Example</summary>
|
|
@@ -450,7 +451,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
450
451
|
```
|
|
451
452
|
</details>
|
|
452
453
|
|
|
453
|
-
* **⭐ Mark Messages As Read In Conversation
|
|
454
|
+
* **⭐ Mark Messages As Read In Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#mark-messages-as-read-in-conversation)
|
|
454
455
|
* `CrispClient.website.markMessagesReadInConversation(websiteID, sessionID, read)`
|
|
455
456
|
* <details>
|
|
456
457
|
<summary>See Example</summary>
|
|
@@ -471,7 +472,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
471
472
|
```
|
|
472
473
|
</details>
|
|
473
474
|
|
|
474
|
-
* **Mark Conversation As Unread
|
|
475
|
+
* **Mark Conversation As Unread**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#mark-conversation-as-unread)
|
|
475
476
|
* `CrispClient.website.markConversationAsUnread(websiteID, sessionID, unread)`
|
|
476
477
|
* <details>
|
|
477
478
|
<summary>See Example</summary>
|
|
@@ -488,7 +489,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
488
489
|
```
|
|
489
490
|
</details>
|
|
490
491
|
|
|
491
|
-
* **⭐ Mark Messages As Delivered In Conversation
|
|
492
|
+
* **⭐ Mark Messages As Delivered In Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#mark-messages-as-delivered-in-conversation)
|
|
492
493
|
* `CrispClient.website.markMessagesDeliveredInConversation(websiteID, sessionID, delivered)`
|
|
493
494
|
* <details>
|
|
494
495
|
<summary>See Example</summary>
|
|
@@ -509,7 +510,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
509
510
|
```
|
|
510
511
|
</details>
|
|
511
512
|
|
|
512
|
-
* **Update Conversation Open State
|
|
513
|
+
* **Update Conversation Open State**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-conversation-open-state)
|
|
513
514
|
* `CrispClient.website.updateConversationOpenState(websiteID, sessionID, opened)`
|
|
514
515
|
* <details>
|
|
515
516
|
<summary>See Example</summary>
|
|
@@ -524,7 +525,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
524
525
|
```
|
|
525
526
|
</details>
|
|
526
527
|
|
|
527
|
-
* **⭐ Get Conversation Routing Assign
|
|
528
|
+
* **⭐ Get Conversation Routing Assign**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-routing-assign)
|
|
528
529
|
* `CrispClient.website.getConversationRoutingAssign(websiteID, sessionID)`
|
|
529
530
|
* <details>
|
|
530
531
|
<summary>See Example</summary>
|
|
@@ -537,7 +538,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
537
538
|
```
|
|
538
539
|
</details>
|
|
539
540
|
|
|
540
|
-
* **⭐ Assign Conversation Routing
|
|
541
|
+
* **⭐ Assign Conversation Routing**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#assign-conversation-routing)
|
|
541
542
|
* `CrispClient.website.assignConversationRouting(websiteID, sessionID, assign)`
|
|
542
543
|
* <details>
|
|
543
544
|
<summary>See Example</summary>
|
|
@@ -556,7 +557,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
556
557
|
```
|
|
557
558
|
</details>
|
|
558
559
|
|
|
559
|
-
* **Update Conversation Inbox
|
|
560
|
+
* **Update Conversation Inbox**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-conversation-inbox)
|
|
560
561
|
* `CrispClient.website.updateConversationInbox(websiteID, sessionID, inboxID)`
|
|
561
562
|
* <details>
|
|
562
563
|
<summary>See Example</summary>
|
|
@@ -570,7 +571,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
570
571
|
```
|
|
571
572
|
</details>
|
|
572
573
|
|
|
573
|
-
* **⭐ Get Conversation Metas
|
|
574
|
+
* **⭐ Get Conversation Metas**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-metas)
|
|
574
575
|
* `CrispClient.website.getConversationMetas(websiteID, sessionID)`
|
|
575
576
|
* <details>
|
|
576
577
|
<summary>See Example</summary>
|
|
@@ -583,7 +584,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
583
584
|
```
|
|
584
585
|
</details>
|
|
585
586
|
|
|
586
|
-
* **⭐ Update Conversation Metas
|
|
587
|
+
* **⭐ Update Conversation Metas**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-conversation-metas)
|
|
587
588
|
* `CrispClient.website.updateConversationMetas(websiteID, sessionID, metas)`
|
|
588
589
|
* <details>
|
|
589
590
|
<summary>See Example</summary>
|
|
@@ -610,7 +611,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
610
611
|
```
|
|
611
612
|
</details>
|
|
612
613
|
|
|
613
|
-
* **Get An Original Message In Conversation
|
|
614
|
+
* **Get An Original Message In Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-an-original-message-in-conversation)
|
|
614
615
|
* `CrispClient.website.getOriginalMessageInConversation(websiteID, sessionID, originalID)`
|
|
615
616
|
* <details>
|
|
616
617
|
<summary>See Example</summary>
|
|
@@ -624,7 +625,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
624
625
|
```
|
|
625
626
|
</details>
|
|
626
627
|
|
|
627
|
-
* **List Conversation Pages
|
|
628
|
+
* **List Conversation Pages**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-conversation-pages)
|
|
628
629
|
* `CrispClient.website.listConversationPages(websiteID, sessionID, pageNumber)`
|
|
629
630
|
* <details>
|
|
630
631
|
<summary>See Example</summary>
|
|
@@ -638,7 +639,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
638
639
|
```
|
|
639
640
|
</details>
|
|
640
641
|
|
|
641
|
-
* **List Conversation Events
|
|
642
|
+
* **List Conversation Events**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-conversation-events)
|
|
642
643
|
* `CrispClient.website.listConversationEvents(websiteID, sessionID, pageNumber)`
|
|
643
644
|
* <details>
|
|
644
645
|
<summary>See Example</summary>
|
|
@@ -652,7 +653,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
652
653
|
```
|
|
653
654
|
</details>
|
|
654
655
|
|
|
655
|
-
* **List Conversation Files
|
|
656
|
+
* **List Conversation Files**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-conversation-files)
|
|
656
657
|
* `CrispClient.website.listConversationFiles(websiteID, sessionID, pageNumber)`
|
|
657
658
|
* <details>
|
|
658
659
|
<summary>See Example</summary>
|
|
@@ -666,7 +667,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
666
667
|
```
|
|
667
668
|
</details>
|
|
668
669
|
|
|
669
|
-
* **Get Conversation State
|
|
670
|
+
* **Get Conversation State**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-state)
|
|
670
671
|
* `CrispClient.website.getConversationState(websiteID, sessionID)`
|
|
671
672
|
* <details>
|
|
672
673
|
<summary>See Example</summary>
|
|
@@ -679,7 +680,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
679
680
|
```
|
|
680
681
|
</details>
|
|
681
682
|
|
|
682
|
-
* **⭐ Change Conversation State
|
|
683
|
+
* **⭐ Change Conversation State**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#change-conversation-state)
|
|
683
684
|
* `CrispClient.website.changeConversationState(websiteID, sessionID, state, user, origin)`
|
|
684
685
|
* <details>
|
|
685
686
|
<summary>See Example</summary>
|
|
@@ -694,7 +695,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
694
695
|
```
|
|
695
696
|
</details>
|
|
696
697
|
|
|
697
|
-
* **Get Conversation Relations
|
|
698
|
+
* **Get Conversation Relations**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-relations)
|
|
698
699
|
* `CrispClient.website.getConversationRelations(websiteID, sessionID)`
|
|
699
700
|
* <details>
|
|
700
701
|
<summary>See Example</summary>
|
|
@@ -707,7 +708,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
707
708
|
```
|
|
708
709
|
</details>
|
|
709
710
|
|
|
710
|
-
* **Get Conversation Participants
|
|
711
|
+
* **Get Conversation Participants**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-participants)
|
|
711
712
|
* `CrispClient.website.getConversationParticipants(websiteID, sessionID)`
|
|
712
713
|
* <details>
|
|
713
714
|
<summary>See Example</summary>
|
|
@@ -720,7 +721,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
720
721
|
```
|
|
721
722
|
</details>
|
|
722
723
|
|
|
723
|
-
* **Save Conversation Participants
|
|
724
|
+
* **Save Conversation Participants**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-conversation-participants)
|
|
724
725
|
* `CrispClient.website.saveConversationParticipants(websiteID, sessionID, participants)`
|
|
725
726
|
* <details>
|
|
726
727
|
<summary>See Example</summary>
|
|
@@ -742,7 +743,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
742
743
|
```
|
|
743
744
|
</details>
|
|
744
745
|
|
|
745
|
-
* **Get Block Status For Conversation
|
|
746
|
+
* **Get Block Status For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-block-status-for-conversation)
|
|
746
747
|
* `CrispClient.website.getBlockStatusForConversation(websiteID, sessionID)`
|
|
747
748
|
* <details>
|
|
748
749
|
<summary>See Example</summary>
|
|
@@ -755,7 +756,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
755
756
|
```
|
|
756
757
|
</details>
|
|
757
758
|
|
|
758
|
-
* **Block Incoming Messages For Conversation
|
|
759
|
+
* **Block Incoming Messages For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#block-incoming-messages-for-conversation)
|
|
759
760
|
* `CrispClient.website.blockIncomingMessagesForConversation(websiteID, sessionID, blocked, user, origin)`
|
|
760
761
|
* <details>
|
|
761
762
|
<summary>See Example</summary>
|
|
@@ -770,7 +771,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
770
771
|
```
|
|
771
772
|
</details>
|
|
772
773
|
|
|
773
|
-
* **Get Verify Status For Conversation
|
|
774
|
+
* **Get Verify Status For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-verify-status-for-conversation)
|
|
774
775
|
* `CrispClient.website.getVerifyStatusForConversation(websiteID, sessionID)`
|
|
775
776
|
* <details>
|
|
776
777
|
<summary>See Example</summary>
|
|
@@ -783,7 +784,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
783
784
|
```
|
|
784
785
|
</details>
|
|
785
786
|
|
|
786
|
-
* **Update Verify Status For Conversation
|
|
787
|
+
* **Update Verify Status For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-verify-status-for-conversation)
|
|
787
788
|
* `CrispClient.website.updateVerifyStatusForConversation(websiteID, sessionID, verified)`
|
|
788
789
|
* <details>
|
|
789
790
|
<summary>See Example</summary>
|
|
@@ -798,7 +799,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
798
799
|
```
|
|
799
800
|
</details>
|
|
800
801
|
|
|
801
|
-
* **Request Identity Verification For Conversation
|
|
802
|
+
* **Request Identity Verification For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-identity-verification-for-conversation)
|
|
802
803
|
* `CrispClient.website.requestIdentityVerificationForConversation(websiteID, sessionID, verification)`
|
|
803
804
|
* <details>
|
|
804
805
|
<summary>See Example</summary>
|
|
@@ -833,7 +834,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
833
834
|
```
|
|
834
835
|
</details>
|
|
835
836
|
|
|
836
|
-
* **Request Email Transcript For Conversation
|
|
837
|
+
* **Request Email Transcript For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-email-transcript-for-conversation)
|
|
837
838
|
* `CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email)`
|
|
838
839
|
* <details>
|
|
839
840
|
<summary>See Example</summary>
|
|
@@ -851,7 +852,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
851
852
|
```
|
|
852
853
|
</details>
|
|
853
854
|
|
|
854
|
-
* **Request Chatbox Binding Purge For Conversation
|
|
855
|
+
* **Request Chatbox Binding Purge For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-chatbox-binding-purge-for-conversation)
|
|
855
856
|
* `CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID)`
|
|
856
857
|
* <details>
|
|
857
858
|
<summary>See Example</summary>
|
|
@@ -864,7 +865,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
864
865
|
```
|
|
865
866
|
</details>
|
|
866
867
|
|
|
867
|
-
* **Request User Feedback For Conversation
|
|
868
|
+
* **Request User Feedback For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-user-feedback-for-conversation)
|
|
868
869
|
* `CrispClient.website.requestUserFeedbackForConversation(websiteID, sessionID)`
|
|
869
870
|
* <details>
|
|
870
871
|
<summary>See Example</summary>
|
|
@@ -877,7 +878,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
877
878
|
```
|
|
878
879
|
</details>
|
|
879
880
|
|
|
880
|
-
* **List Browsing Sessions For Conversation
|
|
881
|
+
* **List Browsing Sessions For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-browsing-sessions-for-conversation)
|
|
881
882
|
* `CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID)`
|
|
882
883
|
* <details>
|
|
883
884
|
<summary>See Example</summary>
|
|
@@ -890,7 +891,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
890
891
|
```
|
|
891
892
|
</details>
|
|
892
893
|
|
|
893
|
-
* **Initiate Browsing Session For Conversation
|
|
894
|
+
* **Initiate Browsing Session For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#initiate-browsing-session-for-conversation)
|
|
894
895
|
* `CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID)`
|
|
895
896
|
* <details>
|
|
896
897
|
<summary>See Example</summary>
|
|
@@ -903,7 +904,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
903
904
|
```
|
|
904
905
|
</details>
|
|
905
906
|
|
|
906
|
-
* **Send Action To An Existing Browsing Session
|
|
907
|
+
* **Send Action To An Existing Browsing Session**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#send-action-to-an-existing-browsing-session)
|
|
907
908
|
* `CrispClient.website.sendActionToExistingBrowsingSession(websiteID, sessionID, browsingID, action)`
|
|
908
909
|
* <details>
|
|
909
910
|
<summary>See Example</summary>
|
|
@@ -919,7 +920,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
919
920
|
```
|
|
920
921
|
</details>
|
|
921
922
|
|
|
922
|
-
* **Assist Existing Browsing Session
|
|
923
|
+
* **Assist Existing Browsing Session**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#assist-an-existing-browsing-session)
|
|
923
924
|
* `CrispClient.website.assistExistingBrowsingSession(websiteID, sessionID, browsingID, assist)`
|
|
924
925
|
* <details>
|
|
925
926
|
<summary>See Example</summary>
|
|
@@ -941,7 +942,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
941
942
|
```
|
|
942
943
|
</details>
|
|
943
944
|
|
|
944
|
-
* **Initiate New Call Session For Conversation
|
|
945
|
+
* **Initiate New Call Session For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#initiate-new-call-session-for-conversation)
|
|
945
946
|
* `CrispClient.website.initiateNewCallSessionForConversation(websiteID, sessionID, mode, user, origin)`
|
|
946
947
|
* <details>
|
|
947
948
|
<summary>See Example</summary>
|
|
@@ -956,7 +957,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
956
957
|
```
|
|
957
958
|
</details>
|
|
958
959
|
|
|
959
|
-
* **Get Ongoing Call Session For Conversation
|
|
960
|
+
* **Get Ongoing Call Session For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-ongoing-call-session-for-conversation)
|
|
960
961
|
* `CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID)`
|
|
961
962
|
* <details>
|
|
962
963
|
<summary>See Example</summary>
|
|
@@ -969,7 +970,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
969
970
|
```
|
|
970
971
|
</details>
|
|
971
972
|
|
|
972
|
-
* **Abort Ongoing Call Session For Conversation
|
|
973
|
+
* **Abort Ongoing Call Session For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#abort-ongoing-call-session-for-conversation)
|
|
973
974
|
* `CrispClient.website.abortOngoingCallSessionForConversation(websiteID, sessionID, callID, user, origin)`
|
|
974
975
|
* <details>
|
|
975
976
|
<summary>See Example</summary>
|
|
@@ -983,7 +984,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
983
984
|
```
|
|
984
985
|
</details>
|
|
985
986
|
|
|
986
|
-
* **Transmit Signaling On Ongoing Call Session
|
|
987
|
+
* **Transmit Signaling On Ongoing Call Session**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#transmit-signaling-on-ongoing-call-session)
|
|
987
988
|
* `CrispClient.website.transmitSignalingOnOngoingCallSession(websiteID, sessionID, callID, payload)`
|
|
988
989
|
* <details>
|
|
989
990
|
<summary>See Example</summary>
|
|
@@ -1002,7 +1003,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1002
1003
|
```
|
|
1003
1004
|
</details>
|
|
1004
1005
|
|
|
1005
|
-
* **Deliver Widget Button Action For Conversation
|
|
1006
|
+
* **Deliver Widget Button Action For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#deliver-widget-button-action-for-conversation)
|
|
1006
1007
|
* `CrispClient.website.deliverWidgetButtonActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data, value)`
|
|
1007
1008
|
* <details>
|
|
1008
1009
|
<summary>See Example</summary>
|
|
@@ -1026,7 +1027,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1026
1027
|
```
|
|
1027
1028
|
</details>
|
|
1028
1029
|
|
|
1029
|
-
* **Deliver Widget Data Fetch Action For Conversation
|
|
1030
|
+
* **Deliver Widget Data Fetch Action For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#deliver-widget-data-action-for-conversation)
|
|
1030
1031
|
* `CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data)`
|
|
1031
1032
|
* <details>
|
|
1032
1033
|
<summary>See Example</summary>
|
|
@@ -1049,7 +1050,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1049
1050
|
```
|
|
1050
1051
|
</details>
|
|
1051
1052
|
|
|
1052
|
-
* **Deliver Widget Data Edit Action For Conversation
|
|
1053
|
+
* **Deliver Widget Data Edit Action For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#deliver-widget-data-action-for-conversation)
|
|
1053
1054
|
* `CrispClient.website.deliverWidgetDataEditActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, value)`
|
|
1054
1055
|
* <details>
|
|
1055
1056
|
<summary>See Example</summary>
|
|
@@ -1072,7 +1073,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1072
1073
|
```
|
|
1073
1074
|
</details>
|
|
1074
1075
|
|
|
1075
|
-
* **Schedule A Reminder For Conversation
|
|
1076
|
+
* **Schedule A Reminder For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#schedule-a-reminder-for-conversation)
|
|
1076
1077
|
* `CrispClient.website.scheduleReminderForConversation(websiteID, sessionID, date, note, user, origin)`
|
|
1077
1078
|
* <details>
|
|
1078
1079
|
<summary>See Example</summary>
|
|
@@ -1090,7 +1091,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1090
1091
|
```
|
|
1091
1092
|
</details>
|
|
1092
1093
|
|
|
1093
|
-
* **Report Conversation
|
|
1094
|
+
* **Report Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#report-conversation)
|
|
1094
1095
|
* `CrispClient.website.reportConversation(websiteID, sessionID, flag)`
|
|
1095
1096
|
* <details>
|
|
1096
1097
|
<summary>See Example</summary>
|
|
@@ -1107,7 +1108,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1107
1108
|
|
|
1108
1109
|
|
|
1109
1110
|
* ### **Website People** _(these are your end-users)_
|
|
1110
|
-
* **Get People Statistics
|
|
1111
|
+
* **Get People Statistics**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-statistics)
|
|
1111
1112
|
* `CrispClient.website.getPeopleStatistics(websiteID)`
|
|
1112
1113
|
* <details>
|
|
1113
1114
|
<summary>See Example</summary>
|
|
@@ -1119,7 +1120,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1119
1120
|
```
|
|
1120
1121
|
</details>
|
|
1121
1122
|
|
|
1122
|
-
* **List Suggested People Segments
|
|
1123
|
+
* **List Suggested People Segments**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-people-segments)
|
|
1123
1124
|
* `CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber)`
|
|
1124
1125
|
* <details>
|
|
1125
1126
|
<summary>See Example</summary>
|
|
@@ -1132,7 +1133,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1132
1133
|
```
|
|
1133
1134
|
</details>
|
|
1134
1135
|
|
|
1135
|
-
* **Delete Suggested People Segment
|
|
1136
|
+
* **Delete Suggested People Segment**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-people-segment)
|
|
1136
1137
|
* `CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment)`
|
|
1137
1138
|
* <details>
|
|
1138
1139
|
<summary>See Example</summary>
|
|
@@ -1146,7 +1147,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1146
1147
|
```
|
|
1147
1148
|
</details>
|
|
1148
1149
|
|
|
1149
|
-
* **List Suggested People Data Keys
|
|
1150
|
+
* **List Suggested People Data Keys**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-people-data-keys)
|
|
1150
1151
|
* `CrispClient.website.listSuggestedPeopleDataKeys(websiteID, pageNumber)`
|
|
1151
1152
|
* <details>
|
|
1152
1153
|
<summary>See Example</summary>
|
|
@@ -1159,7 +1160,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1159
1160
|
```
|
|
1160
1161
|
</details>
|
|
1161
1162
|
|
|
1162
|
-
* **Delete Suggested People Data Key
|
|
1163
|
+
* **Delete Suggested People Data Key**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-people-data-key)
|
|
1163
1164
|
* `CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key)`
|
|
1164
1165
|
* <details>
|
|
1165
1166
|
<summary>See Example</summary>
|
|
@@ -1173,7 +1174,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1173
1174
|
```
|
|
1174
1175
|
</details>
|
|
1175
1176
|
|
|
1176
|
-
* **List Suggested People Events
|
|
1177
|
+
* **List Suggested People Events**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-people-events)
|
|
1177
1178
|
* `CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber)`
|
|
1178
1179
|
* <details>
|
|
1179
1180
|
<summary>See Example</summary>
|
|
@@ -1186,7 +1187,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1186
1187
|
```
|
|
1187
1188
|
</details>
|
|
1188
1189
|
|
|
1189
|
-
* **Delete Suggested People Event
|
|
1190
|
+
* **Delete Suggested People Event**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-people-event)
|
|
1190
1191
|
* `CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text)`
|
|
1191
1192
|
* <details>
|
|
1192
1193
|
<summary>See Example</summary>
|
|
@@ -1200,7 +1201,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1200
1201
|
```
|
|
1201
1202
|
</details>
|
|
1202
1203
|
|
|
1203
|
-
* **⭐ List People Profiles
|
|
1204
|
+
* **⭐ List People Profiles**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-profiles)
|
|
1204
1205
|
* `CrispClient.website.listPeopleProfiles(websiteID, pageNumber, searchField, searchOrder, searchOperator, searchFilter, searchText)`
|
|
1205
1206
|
* <details>
|
|
1206
1207
|
<summary>See Example</summary>
|
|
@@ -1213,7 +1214,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1213
1214
|
```
|
|
1214
1215
|
</details>
|
|
1215
1216
|
|
|
1216
|
-
* **⭐ Add New People Profile
|
|
1217
|
+
* **⭐ Add New People Profile**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-new-people-profile)
|
|
1217
1218
|
* `CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile)`
|
|
1218
1219
|
* <details>
|
|
1219
1220
|
<summary>See Example</summary>
|
|
@@ -1232,7 +1233,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1232
1233
|
```
|
|
1233
1234
|
</details>
|
|
1234
1235
|
|
|
1235
|
-
* **⭐ Check If People Profile Exists
|
|
1236
|
+
* **⭐ Check If People Profile Exists**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-people-profile-exists)
|
|
1236
1237
|
* `CrispClient.website.checkPeopleProfileExists(websiteID, peopleID)`
|
|
1237
1238
|
* <details>
|
|
1238
1239
|
<summary>See Example</summary>
|
|
@@ -1245,7 +1246,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1245
1246
|
```
|
|
1246
1247
|
</details>
|
|
1247
1248
|
|
|
1248
|
-
* **⭐ Get People Profile
|
|
1249
|
+
* **⭐ Get People Profile**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-profile)
|
|
1249
1250
|
* `CrispClient.website.getPeopleProfile(websiteID, peopleID)`
|
|
1250
1251
|
* <details>
|
|
1251
1252
|
<summary>See Example</summary>
|
|
@@ -1258,7 +1259,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1258
1259
|
```
|
|
1259
1260
|
</details>
|
|
1260
1261
|
|
|
1261
|
-
* **⭐ Save People Profile
|
|
1262
|
+
* **⭐ Save People Profile**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-people-profile)
|
|
1262
1263
|
* `CrispClient.website.savePeopleProfile(websiteID, peopleID, peopleProfile)`
|
|
1263
1264
|
* <details>
|
|
1264
1265
|
<summary>See Example</summary>
|
|
@@ -1278,7 +1279,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1278
1279
|
```
|
|
1279
1280
|
</details>
|
|
1280
1281
|
|
|
1281
|
-
* **⭐ Update People Profile
|
|
1282
|
+
* **⭐ Update People Profile**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-people-profile)
|
|
1282
1283
|
* `CrispClient.website.updatePeopleProfile(websiteID, peopleID, peopleProfile)`
|
|
1283
1284
|
* <details>
|
|
1284
1285
|
<summary>See Example</summary>
|
|
@@ -1298,7 +1299,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1298
1299
|
```
|
|
1299
1300
|
</details>
|
|
1300
1301
|
|
|
1301
|
-
* **⭐ Remove People Profile
|
|
1302
|
+
* **⭐ Remove People Profile**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-people-profile)
|
|
1302
1303
|
* `CrispClient.website.removePeopleProfile(websiteID, peopleID)`
|
|
1303
1304
|
* <details>
|
|
1304
1305
|
<summary>See Example</summary>
|
|
@@ -1311,7 +1312,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1311
1312
|
```
|
|
1312
1313
|
</details>
|
|
1313
1314
|
|
|
1314
|
-
* **List People Conversations
|
|
1315
|
+
* **List People Conversations**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-conversations)
|
|
1315
1316
|
* `CrispClient.website.listPeopleConversations(websiteID, peopleID, pageNumber)`
|
|
1316
1317
|
* <details>
|
|
1317
1318
|
<summary>See Example</summary>
|
|
@@ -1325,7 +1326,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1325
1326
|
```
|
|
1326
1327
|
</details>
|
|
1327
1328
|
|
|
1328
|
-
* **List People Campaigns
|
|
1329
|
+
* **List People Campaigns**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-campaigns)
|
|
1329
1330
|
* `CrispClient.website.listPeopleCampaigns(websiteID, peopleID, pageNumber)`
|
|
1330
1331
|
* <details>
|
|
1331
1332
|
<summary>See Example</summary>
|
|
@@ -1339,7 +1340,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1339
1340
|
```
|
|
1340
1341
|
</details>
|
|
1341
1342
|
|
|
1342
|
-
* **Add A People Event
|
|
1343
|
+
* **Add A People Event**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-a-people-event)
|
|
1343
1344
|
* `CrispClient.website.addPeopleEvent(websiteID, peopleID, peopleEvent)`
|
|
1344
1345
|
* <details>
|
|
1345
1346
|
<summary>See Example</summary>
|
|
@@ -1361,7 +1362,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1361
1362
|
```
|
|
1362
1363
|
</details>
|
|
1363
1364
|
|
|
1364
|
-
* **List People Events
|
|
1365
|
+
* **List People Events**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-events)
|
|
1365
1366
|
* `CrispClient.website.listPeopleEvents(websiteID, peopleID, pageNumber)`
|
|
1366
1367
|
* <details>
|
|
1367
1368
|
<summary>See Example</summary>
|
|
@@ -1375,7 +1376,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1375
1376
|
```
|
|
1376
1377
|
</details>
|
|
1377
1378
|
|
|
1378
|
-
* **Get People Data
|
|
1379
|
+
* **Get People Data**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-data)
|
|
1379
1380
|
* `CrispClient.website.getPeopleData(websiteID, peopleID)`
|
|
1380
1381
|
* <details>
|
|
1381
1382
|
<summary>See Example</summary>
|
|
@@ -1388,7 +1389,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1388
1389
|
```
|
|
1389
1390
|
</details>
|
|
1390
1391
|
|
|
1391
|
-
* **Save People Data
|
|
1392
|
+
* **Save People Data**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-people-data)
|
|
1392
1393
|
* `CrispClient.website.savePeopleData(websiteID, peopleID, peopleData)`
|
|
1393
1394
|
* <details>
|
|
1394
1395
|
<summary>See Example</summary>
|
|
@@ -1408,7 +1409,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1408
1409
|
```
|
|
1409
1410
|
</details>
|
|
1410
1411
|
|
|
1411
|
-
* **Update People Data
|
|
1412
|
+
* **Update People Data**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-people-data)
|
|
1412
1413
|
* `CrispClient.website.updatePeopleData(websiteID, peopleID, peopleData)`
|
|
1413
1414
|
* <details>
|
|
1414
1415
|
<summary>See Example</summary>
|
|
@@ -1427,7 +1428,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1427
1428
|
```
|
|
1428
1429
|
</details>
|
|
1429
1430
|
|
|
1430
|
-
* **Get People Subscription Status
|
|
1431
|
+
* **Get People Subscription Status**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-subscription-status)
|
|
1431
1432
|
* `CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID)`
|
|
1432
1433
|
* <details>
|
|
1433
1434
|
<summary>See Example</summary>
|
|
@@ -1440,7 +1441,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1440
1441
|
```
|
|
1441
1442
|
</details>
|
|
1442
1443
|
|
|
1443
|
-
* **Update People Subscription Status
|
|
1444
|
+
* **Update People Subscription Status**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-people-subscription-status)
|
|
1444
1445
|
* `CrispClient.website.updatePeopleSubscriptionStatus(websiteID, peopleID, peopleSubscription)`
|
|
1445
1446
|
* <details>
|
|
1446
1447
|
<summary>See Example</summary>
|
|
@@ -1457,7 +1458,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1457
1458
|
```
|
|
1458
1459
|
</details>
|
|
1459
1460
|
|
|
1460
|
-
* **Export People Profiles
|
|
1461
|
+
* **Export People Profiles**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#export-people-profiles)
|
|
1461
1462
|
* `CrispClient.website.exportPeopleProfiles(websiteID)`
|
|
1462
1463
|
* <details>
|
|
1463
1464
|
<summary>See Example</summary>
|
|
@@ -1469,7 +1470,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1469
1470
|
```
|
|
1470
1471
|
</details>
|
|
1471
1472
|
|
|
1472
|
-
* **Import People Profiles
|
|
1473
|
+
* **Import People Profiles**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#import-people-profiles)
|
|
1473
1474
|
* `CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup)`
|
|
1474
1475
|
* <details>
|
|
1475
1476
|
<summary>See Example</summary>
|
|
@@ -1503,7 +1504,7 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
1503
1504
|
_👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
1504
1505
|
|
|
1505
1506
|
* #### **Website Helpdesk**
|
|
1506
|
-
* **Check If Helpdesk Exists
|
|
1507
|
+
* **Check If Helpdesk Exists**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-helpdesk-exists)
|
|
1507
1508
|
* `CrispClient.website.checkHelpdeskExists(websiteID)`
|
|
1508
1509
|
* <details>
|
|
1509
1510
|
<summary>See Example</summary>
|
|
@@ -1515,7 +1516,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1515
1516
|
```
|
|
1516
1517
|
</details>
|
|
1517
1518
|
|
|
1518
|
-
* **Resolve Helpdesk
|
|
1519
|
+
* **Resolve Helpdesk**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk)
|
|
1519
1520
|
* `CrispClient.website.resolveHelpdesk(websiteID)`
|
|
1520
1521
|
* <details>
|
|
1521
1522
|
<summary>See Example</summary>
|
|
@@ -1527,7 +1528,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1527
1528
|
```
|
|
1528
1529
|
</details>
|
|
1529
1530
|
|
|
1530
|
-
* **Initialize Helpdesk
|
|
1531
|
+
* **Initialize Helpdesk**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#initialize-helpdesk)
|
|
1531
1532
|
* `CrispClient.website.initializeHelpdesk(websiteID, name, domainBasic)`
|
|
1532
1533
|
* <details>
|
|
1533
1534
|
<summary>See Example</summary>
|
|
@@ -1542,7 +1543,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1542
1543
|
```
|
|
1543
1544
|
</details>
|
|
1544
1545
|
|
|
1545
|
-
* **Delete Helpdesk
|
|
1546
|
+
* **Delete Helpdesk**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-helpdesk)
|
|
1546
1547
|
* `CrispClient.website.deleteHelpdesk(websiteID, verify)`
|
|
1547
1548
|
* <details>
|
|
1548
1549
|
<summary>See Example</summary>
|
|
@@ -1559,7 +1560,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1559
1560
|
```
|
|
1560
1561
|
</details>
|
|
1561
1562
|
|
|
1562
|
-
* **List Helpdesk Locales
|
|
1563
|
+
* **List Helpdesk Locales**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-helpdesk-locales)
|
|
1563
1564
|
* `CrispClient.website.listHelpdeskLocales(websiteID, pageNumber, options={})`
|
|
1564
1565
|
* <details>
|
|
1565
1566
|
<summary>See Example</summary>
|
|
@@ -1574,7 +1575,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1574
1575
|
```
|
|
1575
1576
|
</details>
|
|
1576
1577
|
|
|
1577
|
-
* **Add Helpdesk Locale
|
|
1578
|
+
* **Add Helpdesk Locale**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-helpdesk-locale)
|
|
1578
1579
|
* `CrispClient.website.addHelpdeskLocale(websiteID, locale)`
|
|
1579
1580
|
* <details>
|
|
1580
1581
|
<summary>See Example</summary>
|
|
@@ -1588,7 +1589,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1588
1589
|
```
|
|
1589
1590
|
</details>
|
|
1590
1591
|
|
|
1591
|
-
* **Check If Helpdesk Locale Exists
|
|
1592
|
+
* **Check If Helpdesk Locale Exists**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-helpdesk-locale-exists)
|
|
1592
1593
|
* `CrispClient.website.checkHelpdeskLocaleExists(websiteID, locale)`
|
|
1593
1594
|
* <details>
|
|
1594
1595
|
<summary>See Example</summary>
|
|
@@ -1602,7 +1603,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1602
1603
|
```
|
|
1603
1604
|
</details>
|
|
1604
1605
|
|
|
1605
|
-
* **Resolve Helpdesk Locale
|
|
1606
|
+
* **Resolve Helpdesk Locale**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale)
|
|
1606
1607
|
* `CrispClient.website.resolveHelpdeskLocale(websiteID, locale)`
|
|
1607
1608
|
* <details>
|
|
1608
1609
|
<summary>See Example</summary>
|
|
@@ -1616,7 +1617,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1616
1617
|
```
|
|
1617
1618
|
</details>
|
|
1618
1619
|
|
|
1619
|
-
* **Delete Helpdesk Locale
|
|
1620
|
+
* **Delete Helpdesk Locale**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-helpdesk-locale)
|
|
1620
1621
|
* `CrispClient.website.deleteHelpdeskLocale(websiteID, locale)`
|
|
1621
1622
|
* <details>
|
|
1622
1623
|
<summary>See Example</summary>
|
|
@@ -1630,7 +1631,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1630
1631
|
```
|
|
1631
1632
|
</details>
|
|
1632
1633
|
|
|
1633
|
-
* **List Helpdesk Locale Articles
|
|
1634
|
+
* **List Helpdesk Locale Articles**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-helpdesk-locale-articles)
|
|
1634
1635
|
* `CrispClient.website.listHelpdeskLocaleArticles(websiteID, locale, pageNumber)`
|
|
1635
1636
|
* <details>
|
|
1636
1637
|
<summary>See Example</summary>
|
|
@@ -1645,7 +1646,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1645
1646
|
```
|
|
1646
1647
|
</details>
|
|
1647
1648
|
|
|
1648
|
-
* **Add A New Helpdesk Locale Article
|
|
1649
|
+
* **Add A New Helpdesk Locale Article**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-a-new-helpdesk-locale-article)
|
|
1649
1650
|
* `CrispClient.website.addNewHelpdeskLocaleArticle(websiteID, locale, title)`
|
|
1650
1651
|
* <details>
|
|
1651
1652
|
<summary>See Example</summary>
|
|
@@ -1660,7 +1661,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1660
1661
|
```
|
|
1661
1662
|
</details>
|
|
1662
1663
|
|
|
1663
|
-
* **Check If Helpdesk Locale Article Exists
|
|
1664
|
+
* **Check If Helpdesk Locale Article Exists**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-helpdesk-locale-article-exists)
|
|
1664
1665
|
* `CrispClient.website.checkHelpdeskLocaleArticleExists(websiteID, locale, articleId)`
|
|
1665
1666
|
* <details>
|
|
1666
1667
|
<summary>See Example</summary>
|
|
@@ -1675,7 +1676,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1675
1676
|
```
|
|
1676
1677
|
</details>
|
|
1677
1678
|
|
|
1678
|
-
* **Resolve Helpdesk Locale Article
|
|
1679
|
+
* **Resolve Helpdesk Locale Article**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale-article)
|
|
1679
1680
|
* `CrispClient.website.resolveHelpdeskLocaleArticle(websiteID, locale, articleId)`
|
|
1680
1681
|
* <details>
|
|
1681
1682
|
<summary>See Example</summary>
|
|
@@ -1690,7 +1691,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1690
1691
|
```
|
|
1691
1692
|
</details>
|
|
1692
1693
|
|
|
1693
|
-
* **Save Helpdesk Locale Article
|
|
1694
|
+
* **Save Helpdesk Locale Article**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-helpdesk-locale-article)
|
|
1694
1695
|
* `CrispClient.website.saveHelpdeskLocaleArticle(websiteID, locale, articleId, article)`
|
|
1695
1696
|
* <details>
|
|
1696
1697
|
<summary>See Example</summary>
|
|
@@ -1713,7 +1714,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1713
1714
|
```
|
|
1714
1715
|
</details>
|
|
1715
1716
|
|
|
1716
|
-
* **Update Helpdesk Locale Article
|
|
1717
|
+
* **Update Helpdesk Locale Article**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-helpdesk-locale-article)
|
|
1717
1718
|
* `CrispClient.website.updateHelpdeskLocaleArticle(websiteID, locale, articleId, article)`
|
|
1718
1719
|
* <details>
|
|
1719
1720
|
<summary>See Example</summary>
|
|
@@ -1732,7 +1733,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1732
1733
|
```
|
|
1733
1734
|
</details>
|
|
1734
1735
|
|
|
1735
|
-
* **Delete Helpdesk Locale Article
|
|
1736
|
+
* **Delete Helpdesk Locale Article**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-helpdesk-locale-article)
|
|
1736
1737
|
* `CrispClient.website.deleteHelpdeskLocaleArticle(websiteID, locale, articleId)`
|
|
1737
1738
|
* <details>
|
|
1738
1739
|
<summary>See Example</summary>
|
|
@@ -1747,7 +1748,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1747
1748
|
```
|
|
1748
1749
|
</details>
|
|
1749
1750
|
|
|
1750
|
-
* **Resolve Helpdesk Locale Article Page
|
|
1751
|
+
* **Resolve Helpdesk Locale Article Page**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale-article-page)
|
|
1751
1752
|
* `CrispClient.website.resolveHelpdeskLocaleArticlePage(websiteID, locale, articleId)`
|
|
1752
1753
|
* <details>
|
|
1753
1754
|
<summary>See Example</summary>
|
|
@@ -1762,7 +1763,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1762
1763
|
```
|
|
1763
1764
|
</details>
|
|
1764
1765
|
|
|
1765
|
-
* **Resolve Helpdesk Locale Article Category
|
|
1766
|
+
* **Resolve Helpdesk Locale Article Category**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale-article-category)
|
|
1766
1767
|
* `CrispClient.website.resolveHelpdeskLocaleArticleCategory(websiteID, locale, articleId)`
|
|
1767
1768
|
* <details>
|
|
1768
1769
|
<summary>See Example</summary>
|
|
@@ -1777,7 +1778,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1777
1778
|
```
|
|
1778
1779
|
</details>
|
|
1779
1780
|
|
|
1780
|
-
* **Update Helpdesk Locale Article Category
|
|
1781
|
+
* **Update Helpdesk Locale Article Category**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-helpdesk-locale-article-category)
|
|
1781
1782
|
* `CrispClient.website.updateHelpdeskLocaleArticleCategory(websiteID, locale, articleId, categoryId, sectionId)`
|
|
1782
1783
|
* <details>
|
|
1783
1784
|
<summary>See Example</summary>
|
|
@@ -1793,7 +1794,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1793
1794
|
```
|
|
1794
1795
|
</details>
|
|
1795
1796
|
|
|
1796
|
-
* **List Helpdesk Locale Article Alternates
|
|
1797
|
+
* **List Helpdesk Locale Article Alternates**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-helpdesk-locale-article-alternates)
|
|
1797
1798
|
* `CrispClient.website.listHelpdeskLocaleArticleAlternates(websiteID, locale, articleId)`
|
|
1798
1799
|
* <details>
|
|
1799
1800
|
<summary>See Example</summary>
|
|
@@ -1808,7 +1809,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1808
1809
|
```
|
|
1809
1810
|
</details>
|
|
1810
1811
|
|
|
1811
|
-
* **Check If Helpdesk Locale Article Alternate Exists
|
|
1812
|
+
* **Check If Helpdesk Locale Article Alternate Exists**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-helpdesk-locale-article-alternate-exists)
|
|
1812
1813
|
* `CrispClient.website.checkHelpdeskLocaleArticleAlternateExists(websiteID, locale, articleId, localeLinked)`
|
|
1813
1814
|
* <details>
|
|
1814
1815
|
<summary>See Example</summary>
|
|
@@ -1824,7 +1825,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1824
1825
|
```
|
|
1825
1826
|
</details>
|
|
1826
1827
|
|
|
1827
|
-
* **Resolve Helpdesk Locale Article Alternate
|
|
1828
|
+
* **Resolve Helpdesk Locale Article Alternate**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale-article-alternate)
|
|
1828
1829
|
* `CrispClient.website.resolveHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked)`
|
|
1829
1830
|
* <details>
|
|
1830
1831
|
<summary>See Example</summary>
|
|
@@ -1840,7 +1841,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1840
1841
|
```
|
|
1841
1842
|
</details>
|
|
1842
1843
|
|
|
1843
|
-
* **Save Helpdesk Locale Article Alternate
|
|
1844
|
+
* **Save Helpdesk Locale Article Alternate**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-helpdesk-locale-article-alternate)
|
|
1844
1845
|
* `CrispClient.website.saveHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked, articleIdLinked)`
|
|
1845
1846
|
* <details>
|
|
1846
1847
|
<summary>See Example</summary>
|
|
@@ -1857,7 +1858,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1857
1858
|
```
|
|
1858
1859
|
</details>
|
|
1859
1860
|
|
|
1860
|
-
* **Delete Helpdesk Locale Article Alternate
|
|
1861
|
+
* **Delete Helpdesk Locale Article Alternate**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-helpdesk-locale-article-alternate)
|
|
1861
1862
|
* `CrispClient.website.deleteHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked)`
|
|
1862
1863
|
* <details>
|
|
1863
1864
|
<summary>See Example</summary>
|
|
@@ -1873,7 +1874,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1873
1874
|
```
|
|
1874
1875
|
</details>
|
|
1875
1876
|
|
|
1876
|
-
* **Publish Helpdesk Locale Article
|
|
1877
|
+
* **Publish Helpdesk Locale Article**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#publish-helpdesk-locale-article)
|
|
1877
1878
|
* `CrispClient.website.publishHelpdeskLocaleArticle(websiteID, locale, articleId)`
|
|
1878
1879
|
* <details>
|
|
1879
1880
|
<summary>See Example</summary>
|
|
@@ -1888,7 +1889,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1888
1889
|
```
|
|
1889
1890
|
</details>
|
|
1890
1891
|
|
|
1891
|
-
* **Unpublish Helpdesk Locale Article
|
|
1892
|
+
* **Unpublish Helpdesk Locale Article**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#unpublish-helpdesk-locale-article)
|
|
1892
1893
|
* `CrispClient.website.unpublishHelpdeskLocaleArticle(websiteID, locale, articleId)`
|
|
1893
1894
|
* <details>
|
|
1894
1895
|
<summary>See Example</summary>
|
|
@@ -1903,7 +1904,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1903
1904
|
```
|
|
1904
1905
|
</details>
|
|
1905
1906
|
|
|
1906
|
-
* **List Helpdesk Locale Categories
|
|
1907
|
+
* **List Helpdesk Locale Categories**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-helpdesk-locale-categories)
|
|
1907
1908
|
* `CrispClient.website.listHelpdeskLocaleCategories(websiteID, locale, pageNumber)`
|
|
1908
1909
|
* <details>
|
|
1909
1910
|
<summary>See Example</summary>
|
|
@@ -1918,7 +1919,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1918
1919
|
```
|
|
1919
1920
|
</details>
|
|
1920
1921
|
|
|
1921
|
-
* **Add Helpdesk Locale Category
|
|
1922
|
+
* **Add Helpdesk Locale Category**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-helpdesk-locale-category)
|
|
1922
1923
|
* `CrispClient.website.addHelpdeskLocaleCategory(websiteID, locale, name)`
|
|
1923
1924
|
* <details>
|
|
1924
1925
|
<summary>See Example</summary>
|
|
@@ -1933,7 +1934,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1933
1934
|
```
|
|
1934
1935
|
</details>
|
|
1935
1936
|
|
|
1936
|
-
* **Check If Helpdesk Locale Category Exists
|
|
1937
|
+
* **Check If Helpdesk Locale Category Exists**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-helpdesk-locale-category-exists)
|
|
1937
1938
|
* `CrispClient.website.checkHelpdeskLocaleCategoryExists(websiteID, locale, categoryId)`
|
|
1938
1939
|
* <details>
|
|
1939
1940
|
<summary>See Example</summary>
|
|
@@ -1948,7 +1949,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1948
1949
|
```
|
|
1949
1950
|
</details>
|
|
1950
1951
|
|
|
1951
|
-
* **Resolve Helpdesk Locale Category
|
|
1952
|
+
* **Resolve Helpdesk Locale Category**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale-category)
|
|
1952
1953
|
* `CrispClient.website.resolveHelpdeskLocaleCategory(websiteID, locale, categoryId)`
|
|
1953
1954
|
* <details>
|
|
1954
1955
|
<summary>See Example</summary>
|
|
@@ -1963,7 +1964,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1963
1964
|
```
|
|
1964
1965
|
</details>
|
|
1965
1966
|
|
|
1966
|
-
* **Save Helpdesk Locale Category
|
|
1967
|
+
* **Save Helpdesk Locale Category**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-helpdesk-locale-category)
|
|
1967
1968
|
* `CrispClient.website.saveHelpdeskLocaleCategory(websiteID, locale, categoryId, category)`
|
|
1968
1969
|
* <details>
|
|
1969
1970
|
<summary>See Example</summary>
|
|
@@ -1986,7 +1987,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
1986
1987
|
```
|
|
1987
1988
|
</details>
|
|
1988
1989
|
|
|
1989
|
-
* **Update Helpdesk Locale Category
|
|
1990
|
+
* **Update Helpdesk Locale Category**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-helpdesk-locale-category)
|
|
1990
1991
|
* `CrispClient.website.updateHelpdeskLocaleCategory(websiteID, locale, categoryId, category)`
|
|
1991
1992
|
* <details>
|
|
1992
1993
|
<summary>See Example</summary>
|
|
@@ -2005,7 +2006,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2005
2006
|
```
|
|
2006
2007
|
</details>
|
|
2007
2008
|
|
|
2008
|
-
* **Delete Helpdesk Locale Category
|
|
2009
|
+
* **Delete Helpdesk Locale Category**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-helpdesk-locale-category)
|
|
2009
2010
|
* `CrispClient.website.deleteHelpdeskLocaleCategory(websiteID, locale, categoryId)`
|
|
2010
2011
|
* <details>
|
|
2011
2012
|
<summary>See Example</summary>
|
|
@@ -2020,7 +2021,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2020
2021
|
```
|
|
2021
2022
|
</details>
|
|
2022
2023
|
|
|
2023
|
-
* **List Helpdesk Locale Sections
|
|
2024
|
+
* **List Helpdesk Locale Sections**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-helpdesk-locale-sections)
|
|
2024
2025
|
* `CrispClient.website.listHelpdeskLocaleSections(websiteID, locale, categoryId, pageNumber)`
|
|
2025
2026
|
* <details>
|
|
2026
2027
|
<summary>See Example</summary>
|
|
@@ -2036,7 +2037,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2036
2037
|
```
|
|
2037
2038
|
</details>
|
|
2038
2039
|
|
|
2039
|
-
* **Add Helpdesk Locale Section
|
|
2040
|
+
* **Add Helpdesk Locale Section**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-helpdesk-locale-section)
|
|
2040
2041
|
* `CrispClient.website.addHelpdeskLocaleSection(websiteID, locale, categoryId, name)`
|
|
2041
2042
|
* <details>
|
|
2042
2043
|
<summary>See Example</summary>
|
|
@@ -2052,7 +2053,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2052
2053
|
```
|
|
2053
2054
|
</details>
|
|
2054
2055
|
|
|
2055
|
-
* **Check If Helpdesk Locale Section Exists
|
|
2056
|
+
* **Check If Helpdesk Locale Section Exists**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-helpdesk-locale-section-exists)
|
|
2056
2057
|
* `CrispClient.website.checkHelpdeskLocaleSectionExists(websiteID, locale, categoryId, sectionId)`
|
|
2057
2058
|
* <details>
|
|
2058
2059
|
<summary>See Example</summary>
|
|
@@ -2068,7 +2069,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2068
2069
|
```
|
|
2069
2070
|
</details>
|
|
2070
2071
|
|
|
2071
|
-
* **Resolve Helpdesk Locale Section
|
|
2072
|
+
* **Resolve Helpdesk Locale Section**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale-section)
|
|
2072
2073
|
* `CrispClient.website.resolveHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId)`
|
|
2073
2074
|
* <details>
|
|
2074
2075
|
<summary>See Example</summary>
|
|
@@ -2084,7 +2085,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2084
2085
|
```
|
|
2085
2086
|
</details>
|
|
2086
2087
|
|
|
2087
|
-
* **Save Helpdesk Locale Section
|
|
2088
|
+
* **Save Helpdesk Locale Section**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-helpdesk-locale-section)
|
|
2088
2089
|
* `CrispClient.website.saveHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId, section)`
|
|
2089
2090
|
* <details>
|
|
2090
2091
|
<summary>See Example</summary>
|
|
@@ -2105,7 +2106,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2105
2106
|
```
|
|
2106
2107
|
</details>
|
|
2107
2108
|
|
|
2108
|
-
* **Update Helpdesk Locale Section
|
|
2109
|
+
* **Update Helpdesk Locale Section**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-helpdesk-locale-section)
|
|
2109
2110
|
* `CrispClient.website.updateHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId, section)`
|
|
2110
2111
|
* <details>
|
|
2111
2112
|
<summary>See Example</summary>
|
|
@@ -2126,7 +2127,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2126
2127
|
```
|
|
2127
2128
|
</details>
|
|
2128
2129
|
|
|
2129
|
-
* **Delete Helpdesk Locale Section
|
|
2130
|
+
* **Delete Helpdesk Locale Section**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-helpdesk-locale-section)
|
|
2130
2131
|
* `CrispClient.website.deleteHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId)`
|
|
2131
2132
|
* <details>
|
|
2132
2133
|
<summary>See Example</summary>
|
|
@@ -2142,7 +2143,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2142
2143
|
```
|
|
2143
2144
|
</details>
|
|
2144
2145
|
|
|
2145
|
-
* **Map Helpdesk Locale Feedback Ratings
|
|
2146
|
+
* **Map Helpdesk Locale Feedback Ratings**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#map-helpdesk-locale-feedback-ratings)
|
|
2146
2147
|
* `CrispClient.website.mapHelpdeskLocaleFeedbackRatings(websiteID, locale, filterDateStart, filterDateEnd)`
|
|
2147
2148
|
* <details>
|
|
2148
2149
|
<summary>See Example</summary>
|
|
@@ -2156,7 +2157,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2156
2157
|
```
|
|
2157
2158
|
</details>
|
|
2158
2159
|
|
|
2159
|
-
* **List Helpdesk Locale Feedbacks
|
|
2160
|
+
* **List Helpdesk Locale Feedbacks**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-helpdesk-locale-feedbacks)
|
|
2160
2161
|
* `CrispClient.website.listHelpdeskLocaleFeedbacks(websiteID, locale, pageNumber, filterDateStart, filterDateEnd)`
|
|
2161
2162
|
* <details>
|
|
2162
2163
|
<summary>See Example</summary>
|
|
@@ -2171,7 +2172,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2171
2172
|
```
|
|
2172
2173
|
</details>
|
|
2173
2174
|
|
|
2174
|
-
* **Import External Helpdesk To Locale
|
|
2175
|
+
* **Import External Helpdesk To Locale**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#import-external-helpdesk-to-locale)
|
|
2175
2176
|
* `CrispClient.website.importExternalHelpdeskToLocale(websiteID, locale, helpdeskUrl)`
|
|
2176
2177
|
* <details>
|
|
2177
2178
|
<summary>See Example</summary>
|
|
@@ -2186,7 +2187,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2186
2187
|
```
|
|
2187
2188
|
</details>
|
|
2188
2189
|
|
|
2189
|
-
* **Export Helpdesk Locale Articles
|
|
2190
|
+
* **Export Helpdesk Locale Articles**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#export-helpdesk-locale-articles)
|
|
2190
2191
|
* `CrispClient.website.exportHelpdeskLocaleArticles(websiteID, locale)`
|
|
2191
2192
|
* <details>
|
|
2192
2193
|
<summary>See Example</summary>
|
|
@@ -2200,7 +2201,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2200
2201
|
```
|
|
2201
2202
|
</details>
|
|
2202
2203
|
|
|
2203
|
-
* **List Helpdesk Redirections
|
|
2204
|
+
* **List Helpdesk Redirections**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-helpdesk-redirections)
|
|
2204
2205
|
* `CrispClient.website.listHelpdeskRedirections(websiteID, pageNumber)`
|
|
2205
2206
|
* <details>
|
|
2206
2207
|
<summary>See Example</summary>
|
|
@@ -2213,7 +2214,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2213
2214
|
```
|
|
2214
2215
|
</details>
|
|
2215
2216
|
|
|
2216
|
-
* **Add Helpdesk Redirection
|
|
2217
|
+
* **Add Helpdesk Redirection**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-helpdesk-redirection)
|
|
2217
2218
|
* `CrispClient.website.addHelpdeskRedirection(websiteID, redirectionPath, redirectionTarget)`
|
|
2218
2219
|
* <details>
|
|
2219
2220
|
<summary>See Example</summary>
|
|
@@ -2228,7 +2229,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2228
2229
|
```
|
|
2229
2230
|
</details>
|
|
2230
2231
|
|
|
2231
|
-
* **Check If Helpdesk Redirection Exists
|
|
2232
|
+
* **Check If Helpdesk Redirection Exists**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-helpdesk-redirection-exists)
|
|
2232
2233
|
* `CrispClient.website.checkHelpdeskRedirectionExists(websiteID, redirectionId)`
|
|
2233
2234
|
* <details>
|
|
2234
2235
|
<summary>See Example</summary>
|
|
@@ -2241,7 +2242,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2241
2242
|
```
|
|
2242
2243
|
</details>
|
|
2243
2244
|
|
|
2244
|
-
* **Resolve Helpdesk Redirection
|
|
2245
|
+
* **Resolve Helpdesk Redirection**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-redirection)
|
|
2245
2246
|
* `CrispClient.website.resolveHelpdeskRedirection(websiteID, redirectionId)`
|
|
2246
2247
|
* <details>
|
|
2247
2248
|
<summary>See Example</summary>
|
|
@@ -2254,7 +2255,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2254
2255
|
```
|
|
2255
2256
|
</details>
|
|
2256
2257
|
|
|
2257
|
-
* **Delete Helpdesk Redirection
|
|
2258
|
+
* **Delete Helpdesk Redirection**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-helpdesk-redirection)
|
|
2258
2259
|
* `CrispClient.website.deleteHelpdeskRedirection(websiteID, redirectionId)`
|
|
2259
2260
|
* <details>
|
|
2260
2261
|
<summary>See Example</summary>
|
|
@@ -2267,7 +2268,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2267
2268
|
```
|
|
2268
2269
|
</details>
|
|
2269
2270
|
|
|
2270
|
-
* **Resolve Helpdesk Settings
|
|
2271
|
+
* **Resolve Helpdesk Settings**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-settings)
|
|
2271
2272
|
* `CrispClient.website.resolveHelpdeskSettings(websiteID)`
|
|
2272
2273
|
* <details>
|
|
2273
2274
|
<summary>See Example</summary>
|
|
@@ -2279,7 +2280,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2279
2280
|
```
|
|
2280
2281
|
</details>
|
|
2281
2282
|
|
|
2282
|
-
* **Save Helpdesk Settings
|
|
2283
|
+
* **Save Helpdesk Settings**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-helpdesk-settings)
|
|
2283
2284
|
* `CrispClient.website.saveHelpdeskSettings(websiteID, settings)`
|
|
2284
2285
|
* <details>
|
|
2285
2286
|
<summary>See Example</summary>
|
|
@@ -2323,7 +2324,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2323
2324
|
```
|
|
2324
2325
|
</details>
|
|
2325
2326
|
|
|
2326
|
-
* **Resolve Helpdesk Domain
|
|
2327
|
+
* **Resolve Helpdesk Domain**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-domain)
|
|
2327
2328
|
* `CrispClient.website.resolveHelpdeskDomain(websiteID)`
|
|
2328
2329
|
* <details>
|
|
2329
2330
|
<summary>See Example</summary>
|
|
@@ -2335,7 +2336,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2335
2336
|
```
|
|
2336
2337
|
</details>
|
|
2337
2338
|
|
|
2338
|
-
* **Request Helpdesk Domain Change
|
|
2339
|
+
* **Request Helpdesk Domain Change**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-helpdesk-domain-change)
|
|
2339
2340
|
* `CrispClient.website.requestHelpdeskDomainChange(websiteID, basic, custom)`
|
|
2340
2341
|
* <details>
|
|
2341
2342
|
<summary>See Example</summary>
|
|
@@ -2350,7 +2351,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2350
2351
|
```
|
|
2351
2352
|
</details>
|
|
2352
2353
|
|
|
2353
|
-
* **Generate Helpdesk Domain Setup Flow
|
|
2354
|
+
* **Generate Helpdesk Domain Setup Flow**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#generate-helpdesk-domain-setup-flow)
|
|
2354
2355
|
* `CrispClient.website.generateHelpdeskDomainSetupFlow(websiteID, custom)`
|
|
2355
2356
|
* <details>
|
|
2356
2357
|
<summary>See Example</summary>
|
|
@@ -2365,7 +2366,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2365
2366
|
</details>
|
|
2366
2367
|
|
|
2367
2368
|
* #### **Website Base**
|
|
2368
|
-
* **Check If Website Exists
|
|
2369
|
+
* **Check If Website Exists**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-website-exists)
|
|
2369
2370
|
* `CrispClient.website.checkWebsiteExists(domain)`
|
|
2370
2371
|
* <details>
|
|
2371
2372
|
<summary>See Example</summary>
|
|
@@ -2375,7 +2376,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2375
2376
|
```
|
|
2376
2377
|
</details>
|
|
2377
2378
|
|
|
2378
|
-
* **Create Website
|
|
2379
|
+
* **Create Website**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-website)
|
|
2379
2380
|
* `CrispClient.website.createWebsite(websiteData)`
|
|
2380
2381
|
* <details>
|
|
2381
2382
|
<summary>See Example</summary>
|
|
@@ -2385,7 +2386,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2385
2386
|
```
|
|
2386
2387
|
</details>
|
|
2387
2388
|
|
|
2388
|
-
* **Get A Website
|
|
2389
|
+
* **Get A Website**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-website)
|
|
2389
2390
|
* `CrispClient.website.getWebsite(websiteID)`
|
|
2390
2391
|
* <details>
|
|
2391
2392
|
<summary>See Example</summary>
|
|
@@ -2397,7 +2398,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2397
2398
|
```
|
|
2398
2399
|
</details>
|
|
2399
2400
|
|
|
2400
|
-
* **Delete A Website
|
|
2401
|
+
* **Delete A Website**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-a-website)
|
|
2401
2402
|
* `CrispClient.website.deleteWebsite(websiteID, verify)`
|
|
2402
2403
|
* <details>
|
|
2403
2404
|
<summary>See Example</summary>
|
|
@@ -2414,7 +2415,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2414
2415
|
```
|
|
2415
2416
|
</details>
|
|
2416
2417
|
|
|
2417
|
-
* **Abort Website Deletion
|
|
2418
|
+
* **Abort Website Deletion**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#abort-website-deletion)
|
|
2418
2419
|
* `CrispClient.website.abortWebsiteDeletion(websiteID)`
|
|
2419
2420
|
* <details>
|
|
2420
2421
|
<summary>See Example</summary>
|
|
@@ -2428,7 +2429,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2428
2429
|
|
|
2429
2430
|
|
|
2430
2431
|
* #### **Website Settings**
|
|
2431
|
-
* **Get Website Settings
|
|
2432
|
+
* **Get Website Settings**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-website-settings)
|
|
2432
2433
|
* `CrispClient.website.getWebsiteSettings(websiteID)`
|
|
2433
2434
|
* <details>
|
|
2434
2435
|
<summary>See Example</summary>
|
|
@@ -2440,7 +2441,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2440
2441
|
```
|
|
2441
2442
|
</details>
|
|
2442
2443
|
|
|
2443
|
-
* **Update Website Settings
|
|
2444
|
+
* **Update Website Settings**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-website-settings)
|
|
2444
2445
|
* `CrispClient.website.updateWebsiteSettings(websiteID, settings)`
|
|
2445
2446
|
* <details>
|
|
2446
2447
|
<summary>See Example</summary>
|
|
@@ -2535,7 +2536,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2535
2536
|
|
|
2536
2537
|
|
|
2537
2538
|
* #### **Website Operator**
|
|
2538
|
-
* **List Website Operators
|
|
2539
|
+
* **List Website Operators**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-website-operators)
|
|
2539
2540
|
* `CrispClient.website.listWebsiteOperators(websiteID)`
|
|
2540
2541
|
* <details>
|
|
2541
2542
|
<summary>See Example</summary>
|
|
@@ -2547,7 +2548,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2547
2548
|
```
|
|
2548
2549
|
</details>
|
|
2549
2550
|
|
|
2550
|
-
* **List Last Active Website Operators
|
|
2551
|
+
* **List Last Active Website Operators**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-last-active-website-operators)
|
|
2551
2552
|
* `CrispClient.website.listLastActiveWebsiteOperators(websiteID)`
|
|
2552
2553
|
* <details>
|
|
2553
2554
|
<summary>See Example</summary>
|
|
@@ -2559,7 +2560,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2559
2560
|
```
|
|
2560
2561
|
</details>
|
|
2561
2562
|
|
|
2562
|
-
* **Flush Last Active Website Operators
|
|
2563
|
+
* **Flush Last Active Website Operators**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#flush-last-active-website-operators)
|
|
2563
2564
|
* `CrispClient.website.flushLastActiveWebsiteOperators(websiteID)`
|
|
2564
2565
|
* <details>
|
|
2565
2566
|
<summary>See Example</summary>
|
|
@@ -2571,7 +2572,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2571
2572
|
```
|
|
2572
2573
|
</details>
|
|
2573
2574
|
|
|
2574
|
-
* **Send Email To Website Operators
|
|
2575
|
+
* **Send Email To Website Operators**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#send-email-to-website-operators)
|
|
2575
2576
|
* `CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData)`
|
|
2576
2577
|
* <details>
|
|
2577
2578
|
<summary>See Example</summary>
|
|
@@ -2589,7 +2590,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2589
2590
|
```
|
|
2590
2591
|
</details>
|
|
2591
2592
|
|
|
2592
|
-
* **Get A Website Operator
|
|
2593
|
+
* **Get A Website Operator**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-website-operator)
|
|
2593
2594
|
* `CrispClient.website.getWebsiteOperator(websiteID, userID)`
|
|
2594
2595
|
* <details>
|
|
2595
2596
|
<summary>See Example</summary>
|
|
@@ -2602,7 +2603,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2602
2603
|
```
|
|
2603
2604
|
</details>
|
|
2604
2605
|
|
|
2605
|
-
* **Invite A Website Operator
|
|
2606
|
+
* **Invite A Website Operator**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#invite-a-website-operator)
|
|
2606
2607
|
* `CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify)`
|
|
2607
2608
|
* <details>
|
|
2608
2609
|
<summary>See Example</summary>
|
|
@@ -2622,7 +2623,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2622
2623
|
```
|
|
2623
2624
|
</details>
|
|
2624
2625
|
|
|
2625
|
-
* **Change Operator Membership
|
|
2626
|
+
* **Change Operator Membership**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#change-operator-membership)
|
|
2626
2627
|
* `CrispClient.website.changeOperatorMembership(websiteID, userID, role, title)`
|
|
2627
2628
|
* <details>
|
|
2628
2629
|
<summary>See Example</summary>
|
|
@@ -2640,7 +2641,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2640
2641
|
```
|
|
2641
2642
|
</details>
|
|
2642
2643
|
|
|
2643
|
-
* **Unlink Operator From Website
|
|
2644
|
+
* **Unlink Operator From Website**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#unlink-operator-from-website)
|
|
2644
2645
|
* `CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID)`
|
|
2645
2646
|
* <details>
|
|
2646
2647
|
<summary>See Example</summary>
|
|
@@ -2655,7 +2656,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2655
2656
|
|
|
2656
2657
|
|
|
2657
2658
|
* #### **Website Visitors**
|
|
2658
|
-
* **Count Visitors
|
|
2659
|
+
* **Count Visitors**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#count-visitors)
|
|
2659
2660
|
* `CrispClient.website.countVisitors(websiteID)`
|
|
2660
2661
|
* <details>
|
|
2661
2662
|
<summary>See Example</summary>
|
|
@@ -2667,7 +2668,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2667
2668
|
```
|
|
2668
2669
|
</details>
|
|
2669
2670
|
|
|
2670
|
-
* **List Visitors
|
|
2671
|
+
* **List Visitors**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-visitors)
|
|
2671
2672
|
* `CrispClient.website.listVisitors(websiteID, pageNumber)`
|
|
2672
2673
|
* <details>
|
|
2673
2674
|
<summary>See Example</summary>
|
|
@@ -2680,7 +2681,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2680
2681
|
```
|
|
2681
2682
|
</details>
|
|
2682
2683
|
|
|
2683
|
-
* **Pinpoint Visitors On A Map
|
|
2684
|
+
* **Pinpoint Visitors On A Map**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#pinpoint-visitors-on-a-map)
|
|
2684
2685
|
* `CrispClient.website.pinpointVisitorsOnMap(websiteID, centerLongitude, centerLatitude, centerRadius)`
|
|
2685
2686
|
* <details>
|
|
2686
2687
|
<summary>See Example</summary>
|
|
@@ -2692,7 +2693,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2692
2693
|
```
|
|
2693
2694
|
</details>
|
|
2694
2695
|
|
|
2695
|
-
* **Get Session Identifier From Token
|
|
2696
|
+
* **Get Session Identifier From Token**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-session-identifier-from-token)
|
|
2696
2697
|
* `CrispClient.website.getSessionIdentifierFromToken(websiteID, tokenID)`
|
|
2697
2698
|
* <details>
|
|
2698
2699
|
<summary>See Example</summary>
|
|
@@ -2705,9 +2706,9 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2705
2706
|
```
|
|
2706
2707
|
</details>
|
|
2707
2708
|
|
|
2708
|
-
* **Count Blocked Visitors
|
|
2709
|
+
* **Count Blocked Visitors**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#count-blocked-visitors/)
|
|
2709
2710
|
* `CrispClient.website.countBlockedVisitors(websiteID)`
|
|
2710
|
-
* **Count Blocked Visitors In Rule
|
|
2711
|
+
* **Count Blocked Visitors In Rule**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#count-blocked-visitors-in-rule)
|
|
2711
2712
|
* `CrispClient.website.countBlockedVisitorsInRule(websiteID, rule)`
|
|
2712
2713
|
* <details>
|
|
2713
2714
|
<summary>See Example</summary>
|
|
@@ -2719,7 +2720,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2719
2720
|
```
|
|
2720
2721
|
</details>
|
|
2721
2722
|
|
|
2722
|
-
* **Clear Blocked Visitors In Rule
|
|
2723
|
+
* **Clear Blocked Visitors In Rule**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#clear-blocked-visitors-in-rule)
|
|
2723
2724
|
* `CrispClient.website.clearBlockedVisitorsInRule(websiteID, rule)`
|
|
2724
2725
|
* <details>
|
|
2725
2726
|
<summary>See Example</summary>
|
|
@@ -2733,7 +2734,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2733
2734
|
|
|
2734
2735
|
|
|
2735
2736
|
* #### **Website Availability**
|
|
2736
|
-
* **Get Website Availability Status
|
|
2737
|
+
* **Get Website Availability Status**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-website-availability-status)
|
|
2737
2738
|
* `CrispClient.website.getWebsiteAvailabilityStatus(websiteID)`
|
|
2738
2739
|
* <details>
|
|
2739
2740
|
<summary>See Example</summary>
|
|
@@ -2745,7 +2746,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2745
2746
|
```
|
|
2746
2747
|
</details>
|
|
2747
2748
|
|
|
2748
|
-
* **List Website Operator Availabilities
|
|
2749
|
+
* **List Website Operator Availabilities**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-website-operator-availabilities)
|
|
2749
2750
|
* `CrispClient.website.listWebsiteOperatorAvailabilities(websiteID)`
|
|
2750
2751
|
* <details>
|
|
2751
2752
|
<summary>See Example</summary>
|
|
@@ -2759,7 +2760,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2759
2760
|
|
|
2760
2761
|
|
|
2761
2762
|
* #### **Website Analytics**
|
|
2762
|
-
* **Generate Analytics
|
|
2763
|
+
* **Generate Analytics**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#generate-analytics)
|
|
2763
2764
|
* `CrispClient.website.generateAnalytics(websiteID, query)`
|
|
2764
2765
|
* <details>
|
|
2765
2766
|
<summary>See Example</summary>
|
|
@@ -2773,7 +2774,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2773
2774
|
|
|
2774
2775
|
|
|
2775
2776
|
* #### **Website Batch**
|
|
2776
|
-
* **Batch Resolve Conversations
|
|
2777
|
+
* **Batch Resolve Conversations**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-resolve-items)
|
|
2777
2778
|
* `CrispClient.website.batchResolveConversations(websiteID, operation)`
|
|
2778
2779
|
* <details>
|
|
2779
2780
|
<summary>See Example</summary>
|
|
@@ -2794,7 +2795,26 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2794
2795
|
```
|
|
2795
2796
|
</details>
|
|
2796
2797
|
|
|
2797
|
-
* **Batch
|
|
2798
|
+
* **Batch Unresolve Conversations**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-unresolve-items)
|
|
2799
|
+
* `CrispClient.website.batchUnresolveConversations(websiteID, operation)`
|
|
2800
|
+
* <details>
|
|
2801
|
+
<summary>See Example</summary>
|
|
2802
|
+
|
|
2803
|
+
```javascript
|
|
2804
|
+
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
|
|
2805
|
+
|
|
2806
|
+
var operation = {
|
|
2807
|
+
"sessions": [
|
|
2808
|
+
"session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
|
|
2809
|
+
"session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
|
|
2810
|
+
]
|
|
2811
|
+
};
|
|
2812
|
+
|
|
2813
|
+
CrispClient.website.batchUnresolveConversations(websiteID, operation);
|
|
2814
|
+
```
|
|
2815
|
+
</details>
|
|
2816
|
+
|
|
2817
|
+
* **Batch Read Conversations**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-read-items)
|
|
2798
2818
|
* `CrispClient.website.batchReadConversations(websiteID, operation)`
|
|
2799
2819
|
* <details>
|
|
2800
2820
|
<summary>See Example</summary>
|
|
@@ -2815,7 +2835,26 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2815
2835
|
```
|
|
2816
2836
|
</details>
|
|
2817
2837
|
|
|
2818
|
-
* **Batch
|
|
2838
|
+
* **Batch Unread Conversations**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-unread-items)
|
|
2839
|
+
* `CrispClient.website.batchUnreadConversations(websiteID, operation)`
|
|
2840
|
+
* <details>
|
|
2841
|
+
<summary>See Example</summary>
|
|
2842
|
+
|
|
2843
|
+
```javascript
|
|
2844
|
+
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
|
|
2845
|
+
|
|
2846
|
+
var operation = {
|
|
2847
|
+
"sessions": [
|
|
2848
|
+
"session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
|
|
2849
|
+
"session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
|
|
2850
|
+
]
|
|
2851
|
+
};
|
|
2852
|
+
|
|
2853
|
+
CrispClient.website.batchUnreadConversations(websiteID, operation);
|
|
2854
|
+
```
|
|
2855
|
+
</details>
|
|
2856
|
+
|
|
2857
|
+
* **Batch Remove Conversations**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-remove-items)
|
|
2819
2858
|
* `CrispClient.website.batchRemoveConversations(websiteID, operation)`
|
|
2820
2859
|
* <details>
|
|
2821
2860
|
<summary>See Example</summary>
|
|
@@ -2836,7 +2875,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2836
2875
|
```
|
|
2837
2876
|
</details>
|
|
2838
2877
|
|
|
2839
|
-
* **Batch Remove People
|
|
2878
|
+
* **Batch Remove People**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-remove-items)
|
|
2840
2879
|
* `CrispClient.website.batchRemovePeople(websiteID, people)`
|
|
2841
2880
|
* <details>
|
|
2842
2881
|
<summary>See Example</summary>
|
|
@@ -2853,9 +2892,95 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2853
2892
|
```
|
|
2854
2893
|
</details>
|
|
2855
2894
|
|
|
2895
|
+
* **Batch Report Conversations**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-report-items)
|
|
2896
|
+
* `CrispClient.website.batchReportConversations(websiteID, operation)`
|
|
2897
|
+
* <details>
|
|
2898
|
+
<summary>See Example</summary>
|
|
2899
|
+
|
|
2900
|
+
```javascript
|
|
2901
|
+
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
|
|
2902
|
+
|
|
2903
|
+
var operation = {
|
|
2904
|
+
"sessions": [
|
|
2905
|
+
"session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
|
|
2906
|
+
"session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
|
|
2907
|
+
],
|
|
2908
|
+
|
|
2909
|
+
"flag": "spam"
|
|
2910
|
+
};
|
|
2911
|
+
|
|
2912
|
+
CrispClient.website.batchReportConversations(websiteID, operation);
|
|
2913
|
+
```
|
|
2914
|
+
</details>
|
|
2915
|
+
|
|
2916
|
+
* **Batch Block Conversations**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-block-items)
|
|
2917
|
+
* `CrispClient.website.batchBlockConversations(websiteID, operation)`
|
|
2918
|
+
* <details>
|
|
2919
|
+
<summary>See Example</summary>
|
|
2920
|
+
|
|
2921
|
+
```javascript
|
|
2922
|
+
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
|
|
2923
|
+
|
|
2924
|
+
var operation = {
|
|
2925
|
+
"sessions": [
|
|
2926
|
+
"session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
|
|
2927
|
+
"session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
|
|
2928
|
+
],
|
|
2929
|
+
|
|
2930
|
+
"blocked": true
|
|
2931
|
+
};
|
|
2932
|
+
|
|
2933
|
+
CrispClient.website.batchBlockConversations(websiteID, operation);
|
|
2934
|
+
```
|
|
2935
|
+
</details>
|
|
2936
|
+
|
|
2937
|
+
* **Batch Routing Conversations**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-routing-items)
|
|
2938
|
+
* `CrispClient.website.batchRoutingConversations(websiteID, operation)`
|
|
2939
|
+
* <details>
|
|
2940
|
+
<summary>See Example</summary>
|
|
2941
|
+
|
|
2942
|
+
```javascript
|
|
2943
|
+
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
|
|
2944
|
+
|
|
2945
|
+
var operation = {
|
|
2946
|
+
"sessions": [
|
|
2947
|
+
"session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
|
|
2948
|
+
"session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
|
|
2949
|
+
],
|
|
2950
|
+
|
|
2951
|
+
"assigned": {
|
|
2952
|
+
"user_id": "a4c32c68-be91-4e29-b97e-b3b6af886eaa"
|
|
2953
|
+
}
|
|
2954
|
+
};
|
|
2955
|
+
|
|
2956
|
+
CrispClient.website.batchRoutingConversations(websiteID, operation);
|
|
2957
|
+
```
|
|
2958
|
+
</details>
|
|
2959
|
+
|
|
2960
|
+
* **Batch Inbox Conversations**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-inbox-items)
|
|
2961
|
+
* `CrispClient.website.batchInboxConversations(websiteID, operation)`
|
|
2962
|
+
* <details>
|
|
2963
|
+
<summary>See Example</summary>
|
|
2964
|
+
|
|
2965
|
+
```javascript
|
|
2966
|
+
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
|
|
2967
|
+
|
|
2968
|
+
var operation = {
|
|
2969
|
+
"sessions": [
|
|
2970
|
+
"session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
|
|
2971
|
+
"session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
|
|
2972
|
+
],
|
|
2973
|
+
|
|
2974
|
+
"inbox_id": "d42e8b3b-ea8f-4e79-a9f8-d0e467fc1c31"
|
|
2975
|
+
};
|
|
2976
|
+
|
|
2977
|
+
CrispClient.website.batchInboxConversations(websiteID, operation);
|
|
2978
|
+
```
|
|
2979
|
+
</details>
|
|
2980
|
+
|
|
2856
2981
|
|
|
2857
2982
|
* #### **Website Inbox**
|
|
2858
|
-
* **List Inboxes
|
|
2983
|
+
* **List Inboxes**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-website-inboxes)
|
|
2859
2984
|
* `CrispClient.website.listInboxes(websiteID, pageNumber)`
|
|
2860
2985
|
* <details>
|
|
2861
2986
|
<summary>See Example</summary>
|
|
@@ -2868,7 +2993,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2868
2993
|
```
|
|
2869
2994
|
</details>
|
|
2870
2995
|
|
|
2871
|
-
* **Batch Order Inboxes
|
|
2996
|
+
* **Batch Order Inboxes**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-order-website-inboxes)
|
|
2872
2997
|
* `CrispClient.website.batchOrderInboxes(websiteID, orders)`
|
|
2873
2998
|
* <details>
|
|
2874
2999
|
<summary>See Example</summary>
|
|
@@ -2892,7 +3017,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2892
3017
|
```
|
|
2893
3018
|
</details>
|
|
2894
3019
|
|
|
2895
|
-
* **Create A New Inbox
|
|
3020
|
+
* **Create A New Inbox**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-a-new-website-inbox)
|
|
2896
3021
|
* `CrispClient.website.createNewInbox(websiteID, inbox)`
|
|
2897
3022
|
* <details>
|
|
2898
3023
|
<summary>See Example</summary>
|
|
@@ -2929,7 +3054,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2929
3054
|
```
|
|
2930
3055
|
</details>
|
|
2931
3056
|
|
|
2932
|
-
* **Check If Inbox Exists
|
|
3057
|
+
* **Check If Inbox Exists**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-website-inbox-exists)
|
|
2933
3058
|
* `CrispClient.website.checkInboxExists(websiteID, inboxID)`
|
|
2934
3059
|
* <details>
|
|
2935
3060
|
<summary>See Example</summary>
|
|
@@ -2942,7 +3067,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2942
3067
|
```
|
|
2943
3068
|
</details>
|
|
2944
3069
|
|
|
2945
|
-
* **Get Inbox
|
|
3070
|
+
* **Get Inbox**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-website-inbox)
|
|
2946
3071
|
* `CrispClient.website.getInbox(websiteID, inboxID)`
|
|
2947
3072
|
* <details>
|
|
2948
3073
|
<summary>See Example</summary>
|
|
@@ -2955,7 +3080,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2955
3080
|
```
|
|
2956
3081
|
</details>
|
|
2957
3082
|
|
|
2958
|
-
* **Save Inbox
|
|
3083
|
+
* **Save Inbox**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-website-inbox)
|
|
2959
3084
|
* `CrispClient.website.saveInbox(websiteID, inboxID, inbox)`
|
|
2960
3085
|
* <details>
|
|
2961
3086
|
<summary>See Example</summary>
|
|
@@ -2993,7 +3118,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2993
3118
|
```
|
|
2994
3119
|
</details>
|
|
2995
3120
|
|
|
2996
|
-
* **Delete Inbox
|
|
3121
|
+
* **Delete Inbox**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-website-inbox)
|
|
2997
3122
|
* `CrispClient.website.deleteInbox(websiteID, inboxID)`
|
|
2998
3123
|
* <details>
|
|
2999
3124
|
<summary>See Example</summary>
|
|
@@ -3008,7 +3133,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3008
3133
|
|
|
3009
3134
|
|
|
3010
3135
|
* #### **Website Verify**
|
|
3011
|
-
* **Get Verify Settings
|
|
3136
|
+
* **Get Verify Settings**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-verify-settings)
|
|
3012
3137
|
* `CrispClient.website.getVerifySettings(websiteID)`
|
|
3013
3138
|
* <details>
|
|
3014
3139
|
<summary>See Example</summary>
|
|
@@ -3020,7 +3145,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3020
3145
|
```
|
|
3021
3146
|
</details>
|
|
3022
3147
|
|
|
3023
|
-
* **Update Verify Settings
|
|
3148
|
+
* **Update Verify Settings**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-verify-settings)
|
|
3024
3149
|
* `CrispClient.website.updateVerifySettings(websiteID, settings)`
|
|
3025
3150
|
* <details>
|
|
3026
3151
|
<summary>See Example</summary>
|
|
@@ -3036,7 +3161,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3036
3161
|
```
|
|
3037
3162
|
</details>
|
|
3038
3163
|
|
|
3039
|
-
* **Get Verify Key
|
|
3164
|
+
* **Get Verify Key**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-verify-key)
|
|
3040
3165
|
* `CrispClient.website.getVerifyKey(websiteID)`
|
|
3041
3166
|
* <details>
|
|
3042
3167
|
<summary>See Example</summary>
|
|
@@ -3048,7 +3173,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3048
3173
|
```
|
|
3049
3174
|
</details>
|
|
3050
3175
|
|
|
3051
|
-
* **Roll Verify Key
|
|
3176
|
+
* **Roll Verify Key**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#roll-verify-key)
|
|
3052
3177
|
* `CrispClient.website.rollVerifyKey(websiteID)`
|
|
3053
3178
|
* <details>
|
|
3054
3179
|
<summary>See Example</summary>
|
|
@@ -3062,7 +3187,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3062
3187
|
|
|
3063
3188
|
|
|
3064
3189
|
* #### **Website Campaigns**
|
|
3065
|
-
* **List Campaigns
|
|
3190
|
+
* **List Campaigns**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-campaigns)
|
|
3066
3191
|
* `CrispClient.website.listCampaigns(websiteID, pageNumber)`
|
|
3067
3192
|
* <details>
|
|
3068
3193
|
<summary>See Example</summary>
|
|
@@ -3075,7 +3200,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3075
3200
|
```
|
|
3076
3201
|
</details>
|
|
3077
3202
|
|
|
3078
|
-
* **List Campaign Tags
|
|
3203
|
+
* **List Campaign Tags**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-campaign-tags)
|
|
3079
3204
|
* `CrispClient.website.listCampaignTags(websiteID)`
|
|
3080
3205
|
* <details>
|
|
3081
3206
|
<summary>See Example</summary>
|
|
@@ -3087,7 +3212,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3087
3212
|
```
|
|
3088
3213
|
</details>
|
|
3089
3214
|
|
|
3090
|
-
* **List Campaign Templates
|
|
3215
|
+
* **List Campaign Templates**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-campaign-templates)
|
|
3091
3216
|
* `CrispClient.website.listCampaignTemplates(websiteID, pageNumber)`
|
|
3092
3217
|
* <details>
|
|
3093
3218
|
<summary>See Example</summary>
|
|
@@ -3100,7 +3225,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3100
3225
|
```
|
|
3101
3226
|
</details>
|
|
3102
3227
|
|
|
3103
|
-
* **Create A New Campaign Template
|
|
3228
|
+
* **Create A New Campaign Template**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-a-new-campaign-template)
|
|
3104
3229
|
* `CrispClient.website.createNewCampaignTemplate(websiteID, templateFormat, templateName)`
|
|
3105
3230
|
* <details>
|
|
3106
3231
|
<summary>See Example</summary>
|
|
@@ -3117,7 +3242,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3117
3242
|
```
|
|
3118
3243
|
</details>
|
|
3119
3244
|
|
|
3120
|
-
* **Check If Campaign Template Exists
|
|
3245
|
+
* **Check If Campaign Template Exists**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-campaign-template-exists)
|
|
3121
3246
|
* `CrispClient.website.checkCampaignTemplateExists(websiteID, templateID)`
|
|
3122
3247
|
* <details>
|
|
3123
3248
|
<summary>See Example</summary>
|
|
@@ -3130,7 +3255,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3130
3255
|
```
|
|
3131
3256
|
</details>
|
|
3132
3257
|
|
|
3133
|
-
* **Get A Campaign Template
|
|
3258
|
+
* **Get A Campaign Template**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-campaign-template)
|
|
3134
3259
|
* `CrispClient.website.getCampaignTemplate(websiteID, templateID)`
|
|
3135
3260
|
* <details>
|
|
3136
3261
|
<summary>See Example</summary>
|
|
@@ -3143,7 +3268,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3143
3268
|
```
|
|
3144
3269
|
</details>
|
|
3145
3270
|
|
|
3146
|
-
* **Save A Campaign Template
|
|
3271
|
+
* **Save A Campaign Template**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-a-campaign-template)
|
|
3147
3272
|
* `CrispClient.website.saveCampaignTemplate(websiteID, templateID, template)`
|
|
3148
3273
|
* <details>
|
|
3149
3274
|
<summary>See Example</summary>
|
|
@@ -3162,7 +3287,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3162
3287
|
```
|
|
3163
3288
|
</details>
|
|
3164
3289
|
|
|
3165
|
-
* **Update A Campaign Template
|
|
3290
|
+
* **Update A Campaign Template**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-a-campaign-template)
|
|
3166
3291
|
* `CrispClient.website.updateCampaignTemplate(websiteID, templateID, template)`
|
|
3167
3292
|
* <details>
|
|
3168
3293
|
<summary>See Example</summary>
|
|
@@ -3177,7 +3302,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3177
3302
|
```
|
|
3178
3303
|
</details>
|
|
3179
3304
|
|
|
3180
|
-
* **Remove A Campaign Template
|
|
3305
|
+
* **Remove A Campaign Template**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-a-campaign-template)
|
|
3181
3306
|
* `CrispClient.website.removeCampaignTemplate(websiteID, templateID)`
|
|
3182
3307
|
* <details>
|
|
3183
3308
|
<summary>See Example</summary>
|
|
@@ -3192,7 +3317,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3192
3317
|
|
|
3193
3318
|
|
|
3194
3319
|
* #### **Website Campaign**
|
|
3195
|
-
* **Create A New Campaign
|
|
3320
|
+
* **Create A New Campaign**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-a-new-campaign)
|
|
3196
3321
|
* `CrispClient.website.createNewCampaign(websiteID, campaignType, campaignName)`
|
|
3197
3322
|
* <details>
|
|
3198
3323
|
<summary>See Example</summary>
|
|
@@ -3209,7 +3334,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3209
3334
|
```
|
|
3210
3335
|
</details>
|
|
3211
3336
|
|
|
3212
|
-
* **Check If Campaign Exists
|
|
3337
|
+
* **Check If Campaign Exists**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-campaign-exists)
|
|
3213
3338
|
* `CrispClient.website.checkCampaignExists(websiteID, campaignID)`
|
|
3214
3339
|
* <details>
|
|
3215
3340
|
<summary>See Example</summary>
|
|
@@ -3222,7 +3347,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3222
3347
|
```
|
|
3223
3348
|
</details>
|
|
3224
3349
|
|
|
3225
|
-
* **Get A Campaign
|
|
3350
|
+
* **Get A Campaign**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-campaign)
|
|
3226
3351
|
* `CrispClient.website.getCampaign(websiteID, campaignID)`
|
|
3227
3352
|
* <details>
|
|
3228
3353
|
<summary>See Example</summary>
|
|
@@ -3235,7 +3360,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3235
3360
|
```
|
|
3236
3361
|
</details>
|
|
3237
3362
|
|
|
3238
|
-
* **Save A Campaign
|
|
3363
|
+
* **Save A Campaign**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-a-campaign)
|
|
3239
3364
|
* `CrispClient.website.saveCampaign(websiteID, campaignID, campaign)`
|
|
3240
3365
|
* <details>
|
|
3241
3366
|
<summary>See Example</summary>
|
|
@@ -3268,7 +3393,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3268
3393
|
```
|
|
3269
3394
|
</details>
|
|
3270
3395
|
|
|
3271
|
-
* **Update A Campaign
|
|
3396
|
+
* **Update A Campaign**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-a-campaign)
|
|
3272
3397
|
* `CrispClient.website.updateCampaign(websiteID, campaignID, campaign)`
|
|
3273
3398
|
* <details>
|
|
3274
3399
|
<summary>See Example</summary>
|
|
@@ -3285,7 +3410,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3285
3410
|
```
|
|
3286
3411
|
</details>
|
|
3287
3412
|
|
|
3288
|
-
* **Remove A Campaign
|
|
3413
|
+
* **Remove A Campaign**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-a-campaign)
|
|
3289
3414
|
* `CrispClient.website.removeCampaign(websiteID, campaignID)`
|
|
3290
3415
|
* <details>
|
|
3291
3416
|
<summary>See Example</summary>
|
|
@@ -3298,7 +3423,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3298
3423
|
```
|
|
3299
3424
|
</details>
|
|
3300
3425
|
|
|
3301
|
-
* **Dispatch A Campaign
|
|
3426
|
+
* **Dispatch A Campaign**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#dispatch-a-campaign)
|
|
3302
3427
|
* `CrispClient.website.dispatchCampaign(websiteID, campaignID)`
|
|
3303
3428
|
* <details>
|
|
3304
3429
|
<summary>See Example</summary>
|
|
@@ -3311,7 +3436,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3311
3436
|
```
|
|
3312
3437
|
</details>
|
|
3313
3438
|
|
|
3314
|
-
* **Resume A Campaign
|
|
3439
|
+
* **Resume A Campaign**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resume-a-campaign)
|
|
3315
3440
|
* `CrispClient.website.resumeCampaign(websiteID, campaignID)`
|
|
3316
3441
|
* <details>
|
|
3317
3442
|
<summary>See Example</summary>
|
|
@@ -3324,7 +3449,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3324
3449
|
```
|
|
3325
3450
|
</details>
|
|
3326
3451
|
|
|
3327
|
-
* **Pause A Campaign
|
|
3452
|
+
* **Pause A Campaign**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#pause-a-campaign)
|
|
3328
3453
|
* `CrispClient.website.pauseCampaign(websiteID, campaignID)`
|
|
3329
3454
|
* <details>
|
|
3330
3455
|
<summary>See Example</summary>
|
|
@@ -3337,7 +3462,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3337
3462
|
```
|
|
3338
3463
|
</details>
|
|
3339
3464
|
|
|
3340
|
-
* **Test A Campaign
|
|
3465
|
+
* **Test A Campaign**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#test-a-campaign)
|
|
3341
3466
|
* `CrispClient.website.testCampaign(websiteID, campaignID)`
|
|
3342
3467
|
* <details>
|
|
3343
3468
|
<summary>See Example</summary>
|
|
@@ -3350,7 +3475,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3350
3475
|
```
|
|
3351
3476
|
</details>
|
|
3352
3477
|
|
|
3353
|
-
* **List Campaign Recipients
|
|
3478
|
+
* **List Campaign Recipients**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-campaign-recipients)
|
|
3354
3479
|
* `CrispClient.website.listCampaignRecipients(websiteID, campaignID, pageNumber)`
|
|
3355
3480
|
* <details>
|
|
3356
3481
|
<summary>See Example</summary>
|
|
@@ -3364,7 +3489,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3364
3489
|
```
|
|
3365
3490
|
</details>
|
|
3366
3491
|
|
|
3367
|
-
* **List Campaign Statistics
|
|
3492
|
+
* **List Campaign Statistics**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-campaign-statistics)
|
|
3368
3493
|
* `CrispClient.website.listCampaignStatistics(websiteID, campaignID, action, pageNumber)`
|
|
3369
3494
|
* <details>
|
|
3370
3495
|
<summary>See Example</summary>
|
|
@@ -3379,10 +3504,24 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3379
3504
|
</details>
|
|
3380
3505
|
|
|
3381
3506
|
|
|
3507
|
+
* #### **Website Connect**
|
|
3508
|
+
* **Get Connect Endpoints**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-website-connect-endpoints)
|
|
3509
|
+
* `CrispClient.website.getConnectEndpoints(websiteID)`
|
|
3510
|
+
* <details>
|
|
3511
|
+
<summary>See Example</summary>
|
|
3512
|
+
|
|
3513
|
+
```javascript
|
|
3514
|
+
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
|
|
3515
|
+
|
|
3516
|
+
CrispClient.website.getConnectEndpoints(websiteID);
|
|
3517
|
+
```
|
|
3518
|
+
</details>
|
|
3519
|
+
|
|
3520
|
+
|
|
3382
3521
|
### Plugin
|
|
3383
3522
|
|
|
3384
3523
|
* #### **Plugin Connect**
|
|
3385
|
-
* **⭐ Get Connect Account
|
|
3524
|
+
* **⭐ Get Connect Account**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-connect-account)
|
|
3386
3525
|
* `CrispClient.plugin.getConnectAccount()`
|
|
3387
3526
|
* <details>
|
|
3388
3527
|
<summary>See Example</summary>
|
|
@@ -3392,7 +3531,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3392
3531
|
```
|
|
3393
3532
|
</details>
|
|
3394
3533
|
|
|
3395
|
-
* **⭐ Check Connect Session Validity
|
|
3534
|
+
* **⭐ Check Connect Session Validity**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-connect-session-validity)
|
|
3396
3535
|
* `CrispClient.plugin.checkConnectSessionValidity()`
|
|
3397
3536
|
* <details>
|
|
3398
3537
|
<summary>See Example</summary>
|
|
@@ -3402,7 +3541,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3402
3541
|
```
|
|
3403
3542
|
</details>
|
|
3404
3543
|
|
|
3405
|
-
* **⭐ List All Connect Websites
|
|
3544
|
+
* **⭐ List All Connect Websites**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-all-connect-websites)
|
|
3406
3545
|
* `CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured, includePlan)`
|
|
3407
3546
|
* <details>
|
|
3408
3547
|
<summary>See Example</summary>
|
|
@@ -3414,7 +3553,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3414
3553
|
```
|
|
3415
3554
|
</details>
|
|
3416
3555
|
|
|
3417
|
-
* **⭐ List Connect Websites Since
|
|
3556
|
+
* **⭐ List Connect Websites Since**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-connect-websites-since)
|
|
3418
3557
|
* `CrispClient.plugin.listConnectWebsitesSince(dateSince, filterConfigured, includePlan)`
|
|
3419
3558
|
* <details>
|
|
3420
3559
|
<summary>See Example</summary>
|
|
@@ -3426,7 +3565,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3426
3565
|
```
|
|
3427
3566
|
</details>
|
|
3428
3567
|
|
|
3429
|
-
* **⭐ Get Connect Endpoints
|
|
3568
|
+
* **⭐ Get Connect Endpoints**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-connect-endpoints)
|
|
3430
3569
|
* `CrispClient.plugin.getConnectEndpoints()`
|
|
3431
3570
|
* <details>
|
|
3432
3571
|
<summary>See Example</summary>
|
|
@@ -3438,7 +3577,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3438
3577
|
|
|
3439
3578
|
|
|
3440
3579
|
* #### **Plugin Subscription**
|
|
3441
|
-
* **List All Active Subscriptions
|
|
3580
|
+
* **List All Active Subscriptions**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-all-active-subscriptions)
|
|
3442
3581
|
* `CrispClient.plugin.listAllActiveSubscriptions()`
|
|
3443
3582
|
* <details>
|
|
3444
3583
|
<summary>See Example</summary>
|
|
@@ -3448,7 +3587,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3448
3587
|
```
|
|
3449
3588
|
</details>
|
|
3450
3589
|
|
|
3451
|
-
* **List Subscriptions For A Website
|
|
3590
|
+
* **List Subscriptions For A Website**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-subscriptions-for-a-website)
|
|
3452
3591
|
* `CrispClient.plugin.listSubscriptionsForWebsite(websiteID)`
|
|
3453
3592
|
* <details>
|
|
3454
3593
|
<summary>See Example</summary>
|
|
@@ -3460,7 +3599,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3460
3599
|
```
|
|
3461
3600
|
</details>
|
|
3462
3601
|
|
|
3463
|
-
* **Get Subscription Details
|
|
3602
|
+
* **Get Subscription Details**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-subscription-details)
|
|
3464
3603
|
* `CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID)`
|
|
3465
3604
|
* <details>
|
|
3466
3605
|
<summary>See Example</summary>
|
|
@@ -3473,7 +3612,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3473
3612
|
```
|
|
3474
3613
|
</details>
|
|
3475
3614
|
|
|
3476
|
-
* **Subscribe Website To Plugin
|
|
3615
|
+
* **Subscribe Website To Plugin**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#subscribe-website-to-plugin)
|
|
3477
3616
|
* `CrispClient.plugin.subscribeWebsiteToPlugin(websiteID, pluginID)`
|
|
3478
3617
|
* <details>
|
|
3479
3618
|
<summary>See Example</summary>
|
|
@@ -3488,7 +3627,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3488
3627
|
```
|
|
3489
3628
|
</details>
|
|
3490
3629
|
|
|
3491
|
-
* **Unsubscribe Plugin From Website
|
|
3630
|
+
* **Unsubscribe Plugin From Website**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#unsubscribe-plugin-from-website)
|
|
3492
3631
|
* `CrispClient.plugin.unsubscribePluginFromWebsite(websiteID, pluginID)`
|
|
3493
3632
|
* <details>
|
|
3494
3633
|
<summary>See Example</summary>
|
|
@@ -3501,7 +3640,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3501
3640
|
```
|
|
3502
3641
|
</details>
|
|
3503
3642
|
|
|
3504
|
-
* **Get Subscription Settings
|
|
3643
|
+
* **Get Subscription Settings**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-subscription-settings)
|
|
3505
3644
|
* `CrispClient.plugin.getSubscriptionSettings(websiteID, pluginID)`
|
|
3506
3645
|
* <details>
|
|
3507
3646
|
<summary>See Example</summary>
|
|
@@ -3514,7 +3653,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3514
3653
|
```
|
|
3515
3654
|
</details>
|
|
3516
3655
|
|
|
3517
|
-
* **Save Subscription Settings
|
|
3656
|
+
* **Save Subscription Settings**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-subscription-settings)
|
|
3518
3657
|
* `CrispClient.plugin.saveSubscriptionSettings(websiteID, pluginID, settings)`
|
|
3519
3658
|
* <details>
|
|
3520
3659
|
<summary>See Example</summary>
|
|
@@ -3533,7 +3672,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3533
3672
|
```
|
|
3534
3673
|
</details>
|
|
3535
3674
|
|
|
3536
|
-
* **Update Subscription Settings
|
|
3675
|
+
* **Update Subscription Settings**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-subscription-settings)
|
|
3537
3676
|
* `CrispClient.plugin.updateSubscriptionSettings(websiteID, pluginID, settings)`
|
|
3538
3677
|
* <details>
|
|
3539
3678
|
<summary>See Example</summary>
|
|
@@ -3552,7 +3691,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3552
3691
|
```
|
|
3553
3692
|
</details>
|
|
3554
3693
|
|
|
3555
|
-
* **Get Plugin Usage Bills
|
|
3694
|
+
* **Get Plugin Usage Bills**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-plugin-usage-bills)
|
|
3556
3695
|
* `CrispClient.plugin.getPluginUsageBills(websiteID, pluginID)`
|
|
3557
3696
|
* <details>
|
|
3558
3697
|
<summary>See Example</summary>
|
|
@@ -3565,7 +3704,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3565
3704
|
```
|
|
3566
3705
|
</details>
|
|
3567
3706
|
|
|
3568
|
-
* **Report Plugin Usage To Bill
|
|
3707
|
+
* **Report Plugin Usage To Bill**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#report-plugin-usage-to-bill)
|
|
3569
3708
|
* `CrispClient.plugin.reportPluginUsageToBill(websiteID, pluginID, usage)`
|
|
3570
3709
|
* <details>
|
|
3571
3710
|
<summary>See Example</summary>
|
|
@@ -3584,7 +3723,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3584
3723
|
```
|
|
3585
3724
|
</details>
|
|
3586
3725
|
|
|
3587
|
-
* **Get Plugin Attest Provenance
|
|
3726
|
+
* **Get Plugin Attest Provenance**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-plugin-attest-provenance)
|
|
3588
3727
|
* `CrispClient.plugin.getPluginAttestProvenance(websiteID, pluginID)`
|
|
3589
3728
|
* <details>
|
|
3590
3729
|
<summary>See Example</summary>
|
|
@@ -3597,7 +3736,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3597
3736
|
```
|
|
3598
3737
|
</details>
|
|
3599
3738
|
|
|
3600
|
-
* **Forward Plugin Payload To Channel
|
|
3739
|
+
* **Forward Plugin Payload To Channel**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#forward-plugin-payload-to-channel)
|
|
3601
3740
|
* `CrispClient.plugin.forwardPluginPayloadToChannel(websiteID, pluginID, payload)`
|
|
3602
3741
|
* <details>
|
|
3603
3742
|
<summary>See Example</summary>
|
|
@@ -3617,7 +3756,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3617
3756
|
```
|
|
3618
3757
|
</details>
|
|
3619
3758
|
|
|
3620
|
-
* **Dispatch Plugin Event
|
|
3759
|
+
* **Dispatch Plugin Event**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#dispatch-plugin-event)
|
|
3621
3760
|
* `CrispClient.plugin.dispatchPluginEvent(websiteID, pluginID, payload)`
|
|
3622
3761
|
* <details>
|
|
3623
3762
|
<summary>See Example</summary>
|
|
@@ -3642,7 +3781,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3642
3781
|
### Plan
|
|
3643
3782
|
|
|
3644
3783
|
* #### **Plan Subscription**
|
|
3645
|
-
* **List All Active Plan Subscriptions
|
|
3784
|
+
* **List All Active Plan Subscriptions**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-all-active-plan-subscriptions)
|
|
3646
3785
|
* `CrispClient.plan.listAllActiveSubscriptions()`
|
|
3647
3786
|
* <details>
|
|
3648
3787
|
<summary>See Example</summary>
|
|
@@ -3652,7 +3791,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3652
3791
|
```
|
|
3653
3792
|
</details>
|
|
3654
3793
|
|
|
3655
|
-
* **Get Plan Subscription For A Website
|
|
3794
|
+
* **Get Plan Subscription For A Website**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-plan-subscription-for-a-website)
|
|
3656
3795
|
* `CrispClient.plan.getPlanSubscriptionForWebsite(websiteID)`
|
|
3657
3796
|
* <details>
|
|
3658
3797
|
<summary>See Example</summary>
|
|
@@ -3664,7 +3803,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3664
3803
|
```
|
|
3665
3804
|
</details>
|
|
3666
3805
|
|
|
3667
|
-
* **Subscribe Website To Plan
|
|
3806
|
+
* **Subscribe Website To Plan**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#subscribe-website-to-plan)
|
|
3668
3807
|
* `CrispClient.plan.subscribeWebsiteToPlan(websiteID, planID)`
|
|
3669
3808
|
* <details>
|
|
3670
3809
|
<summary>See Example</summary>
|
|
@@ -3677,7 +3816,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3677
3816
|
```
|
|
3678
3817
|
</details>
|
|
3679
3818
|
|
|
3680
|
-
* **Unsubscribe Plan From Website
|
|
3819
|
+
* **Unsubscribe Plan From Website**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#unsubscribe-plan-from-website)
|
|
3681
3820
|
* `CrispClient.plan.unsubscribePlanFromWebsite(websiteID)`
|
|
3682
3821
|
* <details>
|
|
3683
3822
|
<summary>See Example</summary>
|
|
@@ -3689,7 +3828,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3689
3828
|
```
|
|
3690
3829
|
</details>
|
|
3691
3830
|
|
|
3692
|
-
* **Change Bill Period For Website Plan Subscription
|
|
3831
|
+
* **Change Bill Period For Website Plan Subscription**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#change-bill-period-for-website-plan-subscription)
|
|
3693
3832
|
* `CrispClient.plan.changeBillPeriodForWebsitePlanSubscription(websiteID, period)`
|
|
3694
3833
|
* <details>
|
|
3695
3834
|
<summary>See Example</summary>
|
|
@@ -3702,7 +3841,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3702
3841
|
```
|
|
3703
3842
|
</details>
|
|
3704
3843
|
|
|
3705
|
-
* **Check Coupon Availability For Website Plan Subscription
|
|
3844
|
+
* **Check Coupon Availability For Website Plan Subscription**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-coupon-availability-for-website-plan-subscription)
|
|
3706
3845
|
* `CrispClient.plan.checkCouponAvailabilityForWebsitePlanSubscription(websiteID, code)`
|
|
3707
3846
|
* <details>
|
|
3708
3847
|
<summary>See Example</summary>
|
|
@@ -3715,7 +3854,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3715
3854
|
```
|
|
3716
3855
|
</details>
|
|
3717
3856
|
|
|
3718
|
-
* **Redeem Coupon For Website Plan Subscription
|
|
3857
|
+
* **Redeem Coupon For Website Plan Subscription**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#redeem-coupon-for-website-plan-subscription)
|
|
3719
3858
|
* `CrispClient.plan.redeemCouponForWebsitePlanSubscription(websiteID, code)`
|
|
3720
3859
|
* <details>
|
|
3721
3860
|
<summary>See Example</summary>
|
|
@@ -3732,7 +3871,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3732
3871
|
### Media
|
|
3733
3872
|
|
|
3734
3873
|
* #### **Media Animation**
|
|
3735
|
-
* **List Animation Medias
|
|
3874
|
+
* **List Animation Medias**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-animation-medias)
|
|
3736
3875
|
* `CrispClient.media.listAnimationMedias(pageNumber, listID, searchQuery)`
|
|
3737
3876
|
* <details>
|
|
3738
3877
|
<summary>See Example</summary>
|
|
@@ -3749,7 +3888,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
3749
3888
|
### Bucket
|
|
3750
3889
|
|
|
3751
3890
|
* #### **Bucket URL**
|
|
3752
|
-
* **Generate Bucket URL
|
|
3891
|
+
* **Generate Bucket URL**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#bucket-url)
|
|
3753
3892
|
* `CrispClient.bucket.generateBucketURL(data)`
|
|
3754
3893
|
* <details>
|
|
3755
3894
|
<summary>See Example</summary>
|
|
@@ -3804,197 +3943,197 @@ You will need to adjust your code so that:
|
|
|
3804
3943
|
Available events are listed below:
|
|
3805
3944
|
|
|
3806
3945
|
* #### **Session Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#session-events)
|
|
3807
|
-
* **Session Update Availability
|
|
3946
|
+
* **Session Update Availability**:
|
|
3808
3947
|
* `session:update_availability`
|
|
3809
|
-
* **Session Update Verify
|
|
3948
|
+
* **Session Update Verify**:
|
|
3810
3949
|
* `session:update_verify`
|
|
3811
|
-
* **Session Request Initiated
|
|
3950
|
+
* **Session Request Initiated**:
|
|
3812
3951
|
* `session:request:initiated`
|
|
3813
|
-
* **Session Set Email
|
|
3952
|
+
* **Session Set Email**:
|
|
3814
3953
|
* `session:set_email`
|
|
3815
|
-
* **Session Set Phone
|
|
3954
|
+
* **Session Set Phone**:
|
|
3816
3955
|
* `session:set_phone`
|
|
3817
|
-
* **Session Set Address
|
|
3956
|
+
* **Session Set Address**:
|
|
3818
3957
|
* `session:set_address`
|
|
3819
|
-
* **Session Set Subject
|
|
3958
|
+
* **Session Set Subject**:
|
|
3820
3959
|
* `session:set_subject`
|
|
3821
|
-
* **Session Set Avatar
|
|
3960
|
+
* **Session Set Avatar**:
|
|
3822
3961
|
* `session:set_avatar`
|
|
3823
|
-
* **Session Set Nickname
|
|
3962
|
+
* **Session Set Nickname**:
|
|
3824
3963
|
* `session:set_nickname`
|
|
3825
|
-
* **Session Set Origin
|
|
3964
|
+
* **Session Set Origin**:
|
|
3826
3965
|
* `session:set_origin`
|
|
3827
|
-
* **Session Set Data
|
|
3966
|
+
* **Session Set Data**:
|
|
3828
3967
|
* `session:set_data`
|
|
3829
|
-
* **Session Sync Pages
|
|
3968
|
+
* **Session Sync Pages**:
|
|
3830
3969
|
* `session:sync:pages`
|
|
3831
|
-
* **Session Sync Events
|
|
3970
|
+
* **Session Sync Events**:
|
|
3832
3971
|
* `session:sync:events`
|
|
3833
|
-
* **Session Sync Capabilities
|
|
3972
|
+
* **Session Sync Capabilities**:
|
|
3834
3973
|
* `session:sync:capabilities`
|
|
3835
|
-
* **Session Sync Geolocation
|
|
3974
|
+
* **Session Sync Geolocation**:
|
|
3836
3975
|
* `session:sync:geolocation`
|
|
3837
|
-
* **Session Sync System
|
|
3976
|
+
* **Session Sync System**:
|
|
3838
3977
|
* `session:sync:system`
|
|
3839
|
-
* **Session Sync Network
|
|
3978
|
+
* **Session Sync Network**:
|
|
3840
3979
|
* `session:sync:network`
|
|
3841
|
-
* **Session Sync Timezone
|
|
3980
|
+
* **Session Sync Timezone**:
|
|
3842
3981
|
* `session:sync:timezone`
|
|
3843
|
-
* **Session Sync Locales
|
|
3982
|
+
* **Session Sync Locales**:
|
|
3844
3983
|
* `session:sync:locales`
|
|
3845
|
-
* **Session Sync Rating
|
|
3984
|
+
* **Session Sync Rating**:
|
|
3846
3985
|
* `session:sync:rating`
|
|
3847
|
-
* **Session Sync Topic
|
|
3986
|
+
* **Session Sync Topic**:
|
|
3848
3987
|
* `session:sync:topic`
|
|
3849
|
-
* **Session Set State
|
|
3988
|
+
* **Session Set State**:
|
|
3850
3989
|
* `session:set_state`
|
|
3851
|
-
* **Session Set Block
|
|
3990
|
+
* **Session Set Block**:
|
|
3852
3991
|
* `session:set_block`
|
|
3853
|
-
* **Session Set Segments
|
|
3992
|
+
* **Session Set Segments**:
|
|
3854
3993
|
* `session:set_segments`
|
|
3855
|
-
* **Session Set Opened
|
|
3994
|
+
* **Session Set Opened**:
|
|
3856
3995
|
* `session:set_opened`
|
|
3857
|
-
* **Session Set Closed
|
|
3996
|
+
* **Session Set Closed**:
|
|
3858
3997
|
* `session:set_closed`
|
|
3859
|
-
* **Session Set Participants
|
|
3998
|
+
* **Session Set Participants**:
|
|
3860
3999
|
* `session:set_participants`
|
|
3861
|
-
* **Session Set Mentions
|
|
4000
|
+
* **Session Set Mentions**:
|
|
3862
4001
|
* `session:set_mentions`
|
|
3863
|
-
* **Session Set Routing
|
|
4002
|
+
* **Session Set Routing**:
|
|
3864
4003
|
* `session:set_routing`
|
|
3865
|
-
* **Session Set Inbox
|
|
4004
|
+
* **Session Set Inbox**:
|
|
3866
4005
|
* `session:set_inbox`
|
|
3867
|
-
* **Session Removed
|
|
4006
|
+
* **Session Removed**:
|
|
3868
4007
|
* `session:removed`
|
|
3869
|
-
* **Session Error
|
|
4008
|
+
* **Session Error**:
|
|
3870
4009
|
* `session:error`
|
|
3871
4010
|
|
|
3872
4011
|
* #### **Message Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#message-events)
|
|
3873
|
-
* **Message Updated
|
|
4012
|
+
* **Message Updated**:
|
|
3874
4013
|
* `message:updated`
|
|
3875
|
-
* **Message Send
|
|
4014
|
+
* **Message Send**:
|
|
3876
4015
|
* `message:send`
|
|
3877
|
-
* **Message Received
|
|
4016
|
+
* **Message Received**:
|
|
3878
4017
|
* `message:received`
|
|
3879
|
-
* **Message Removed
|
|
4018
|
+
* **Message Removed**:
|
|
3880
4019
|
* `message:removed`
|
|
3881
|
-
* **Message Compose Send
|
|
4020
|
+
* **Message Compose Send**:
|
|
3882
4021
|
* `message:compose:send`
|
|
3883
|
-
* **Message Compose Receive
|
|
4022
|
+
* **Message Compose Receive**:
|
|
3884
4023
|
* `message:compose:receive`
|
|
3885
|
-
* **Message Acknowledge Read Send
|
|
4024
|
+
* **Message Acknowledge Read Send**:
|
|
3886
4025
|
* `message:acknowledge:read:send`
|
|
3887
|
-
* **Message Acknowledge Read Received
|
|
4026
|
+
* **Message Acknowledge Read Received**:
|
|
3888
4027
|
* `message:acknowledge:read:received`
|
|
3889
|
-
* **Message Acknowledge Unread Send
|
|
4028
|
+
* **Message Acknowledge Unread Send**:
|
|
3890
4029
|
* `message:acknowledge:unread:send`
|
|
3891
|
-
* **Message Acknowledge Delivered
|
|
4030
|
+
* **Message Acknowledge Delivered**:
|
|
3892
4031
|
* `message:acknowledge:delivered`
|
|
3893
|
-
* **Message Acknowledge Ignored
|
|
4032
|
+
* **Message Acknowledge Ignored**:
|
|
3894
4033
|
* `message:acknowledge:ignored`
|
|
3895
|
-
* **Message Notify Unread Send
|
|
4034
|
+
* **Message Notify Unread Send**:
|
|
3896
4035
|
* `message:notify:unread:send`
|
|
3897
|
-
* **Message Notify Unread Received
|
|
4036
|
+
* **Message Notify Unread Received**:
|
|
3898
4037
|
* `message:notify:unread:received`
|
|
3899
4038
|
|
|
3900
4039
|
* #### **Spam Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#spam-events)
|
|
3901
|
-
* **Spam Message
|
|
4040
|
+
* **Spam Message**:
|
|
3902
4041
|
* `spam:message`
|
|
3903
|
-
* **Spam Decision
|
|
4042
|
+
* **Spam Decision**:
|
|
3904
4043
|
* `spam:decision`
|
|
3905
4044
|
|
|
3906
4045
|
* #### **People Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#people-events)
|
|
3907
|
-
* **People Profile Created
|
|
4046
|
+
* **People Profile Created**:
|
|
3908
4047
|
* `people:profile:created`
|
|
3909
|
-
* **People Profile Updated
|
|
4048
|
+
* **People Profile Updated**:
|
|
3910
4049
|
* `people:profile:updated`
|
|
3911
|
-
* **People Profile Removed
|
|
4050
|
+
* **People Profile Removed**:
|
|
3912
4051
|
* `people:profile:removed`
|
|
3913
|
-
* **People Bind Session
|
|
4052
|
+
* **People Bind Session**:
|
|
3914
4053
|
* `people:bind:session`
|
|
3915
|
-
* **People Sync Profile
|
|
4054
|
+
* **People Sync Profile**:
|
|
3916
4055
|
* `people:sync:profile`
|
|
3917
|
-
* **People Import Progress
|
|
4056
|
+
* **People Import Progress**:
|
|
3918
4057
|
* `people:import:progress`
|
|
3919
|
-
* **People Import Done
|
|
4058
|
+
* **People Import Done**:
|
|
3920
4059
|
* `people:import:done`
|
|
3921
4060
|
|
|
3922
4061
|
* #### **Campaign Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#campaign-events)
|
|
3923
|
-
* **Campaign Progress
|
|
4062
|
+
* **Campaign Progress**:
|
|
3924
4063
|
* `campaign:progress`
|
|
3925
|
-
* **Campaign Dispatched
|
|
4064
|
+
* **Campaign Dispatched**:
|
|
3926
4065
|
* `campaign:dispatched`
|
|
3927
|
-
* **Campaign Running
|
|
4066
|
+
* **Campaign Running**:
|
|
3928
4067
|
* `campaign:running`
|
|
3929
4068
|
|
|
3930
4069
|
* #### **Browsing Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#browsing-events)
|
|
3931
|
-
* **Browsing Request Initiated
|
|
4070
|
+
* **Browsing Request Initiated**:
|
|
3932
4071
|
* `browsing:request:initiated`
|
|
3933
|
-
* **Browsing Request Rejected
|
|
4072
|
+
* **Browsing Request Rejected**:
|
|
3934
4073
|
* `browsing:request:rejected`
|
|
3935
4074
|
|
|
3936
4075
|
* #### **Call Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#call-events)
|
|
3937
|
-
* **Call Request Initiated
|
|
4076
|
+
* **Call Request Initiated**:
|
|
3938
4077
|
* `call:request:initiated`
|
|
3939
|
-
* **Call Request Rejected
|
|
4078
|
+
* **Call Request Rejected**:
|
|
3940
4079
|
* `call:request:rejected`
|
|
3941
4080
|
|
|
3942
4081
|
* #### **Identity Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#identity-events)
|
|
3943
|
-
* **Identity Verify Request
|
|
4082
|
+
* **Identity Verify Request**:
|
|
3944
4083
|
* `identity:verify:request`
|
|
3945
4084
|
|
|
3946
4085
|
* #### **Widget Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#widget-events)
|
|
3947
|
-
* **Widget Action Processed
|
|
4086
|
+
* **Widget Action Processed**:
|
|
3948
4087
|
* `widget:action:processed`
|
|
3949
4088
|
|
|
3950
4089
|
* #### **Status Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#status-events)
|
|
3951
|
-
* **Status Health Changed
|
|
4090
|
+
* **Status Health Changed**:
|
|
3952
4091
|
* `status:health:changed`
|
|
3953
4092
|
|
|
3954
4093
|
* #### **Website Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#website-events)
|
|
3955
|
-
* **Website Update Visitors Count
|
|
4094
|
+
* **Website Update Visitors Count**:
|
|
3956
4095
|
* `website:update_visitors_count`
|
|
3957
|
-
* **Website Update Operators Availability
|
|
4096
|
+
* **Website Update Operators Availability**:
|
|
3958
4097
|
* `website:update_operators_availability`
|
|
3959
|
-
* **Website Users Available
|
|
4098
|
+
* **Website Users Available**:
|
|
3960
4099
|
* `website:users:available`
|
|
3961
4100
|
|
|
3962
4101
|
* #### **Bucket Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#bucket-events)
|
|
3963
|
-
* **Bucket URL Upload Generated
|
|
4102
|
+
* **Bucket URL Upload Generated**:
|
|
3964
4103
|
* `bucket:url:upload:generated`
|
|
3965
|
-
* **Bucket URL Avatar Generated
|
|
4104
|
+
* **Bucket URL Avatar Generated**:
|
|
3966
4105
|
* `bucket:url:avatar:generated`
|
|
3967
|
-
* **Bucket URL Website Generated
|
|
4106
|
+
* **Bucket URL Website Generated**:
|
|
3968
4107
|
* `bucket:url:website:generated`
|
|
3969
|
-
* **Bucket URL Campaign Generated
|
|
4108
|
+
* **Bucket URL Campaign Generated**:
|
|
3970
4109
|
* `bucket:url:campaign:generated`
|
|
3971
|
-
* **Bucket URL Helpdesk Generated
|
|
4110
|
+
* **Bucket URL Helpdesk Generated**:
|
|
3972
4111
|
* `bucket:url:helpdesk:generated`
|
|
3973
|
-
* **Bucket URL Status Generated
|
|
4112
|
+
* **Bucket URL Status Generated**:
|
|
3974
4113
|
* `bucket:url:status:generated`
|
|
3975
|
-
* **Bucket URL Processing Generated
|
|
4114
|
+
* **Bucket URL Processing Generated**:
|
|
3976
4115
|
* `bucket:url:processing:generated`
|
|
3977
4116
|
|
|
3978
4117
|
* #### **Media Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#media-events)
|
|
3979
|
-
* **Media Animation Listed
|
|
4118
|
+
* **Media Animation Listed**:
|
|
3980
4119
|
* `media:animation:listed`
|
|
3981
4120
|
|
|
3982
4121
|
* #### **Email Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#email-events)
|
|
3983
|
-
* **Email Subscribe
|
|
4122
|
+
* **Email Subscribe**:
|
|
3984
4123
|
* `email:subscribe`
|
|
3985
|
-
* **Email Track View
|
|
4124
|
+
* **Email Track View**:
|
|
3986
4125
|
* `email:track:view`
|
|
3987
4126
|
|
|
3988
4127
|
* #### **Plugin Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#plugin-events)
|
|
3989
|
-
* **Plugin Channel
|
|
4128
|
+
* **Plugin Channel**:
|
|
3990
4129
|
* `plugin:channel`
|
|
3991
|
-
* **Plugin Event
|
|
4130
|
+
* **Plugin Event**:
|
|
3992
4131
|
* `plugin:event`
|
|
3993
|
-
* **Plugin Subscription Updated
|
|
4132
|
+
* **Plugin Subscription Updated**:
|
|
3994
4133
|
* `plugin:subscription:updated`
|
|
3995
|
-
* **Plugin Settings Saved
|
|
4134
|
+
* **Plugin Settings Saved**:
|
|
3996
4135
|
* `plugin:settings:saved`
|
|
3997
4136
|
|
|
3998
4137
|
* #### **Plan Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#plan-events)
|
|
3999
|
-
* **Plan Subscription Updated
|
|
4138
|
+
* **Plan Subscription Updated**:
|
|
4000
4139
|
* `plan:subscription:updated`
|