crisp-api 6.0.0 → 6.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,7 +6,7 @@ The Crisp API Node wrapper. Authenticate, send messages, fetch conversations, ac
6
6
 
7
7
  Copyright 2022 Crisp IM SAS. See LICENSE for copying information.
8
8
 
9
- * **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 22/04/2022
9
+ * **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 29/07/2022
10
10
  * **😘 Maintainers**: [@baptistejamin](https://github.com/baptistejamin), [@eliottvincent](https://github.com/eliottvincent), [@valeriansaliou](https://github.com/valeriansaliou)
11
11
 
12
12
  ## Installation
@@ -105,7 +105,7 @@ All methods that you will most likely need when building a Crisp integration are
105
105
  <ul>
106
106
  <li><a href="#website-conversations">Website Conversations</a></li>
107
107
  <li><a href="#website-conversation">Website Conversation</a></li>
108
- <li><a href="#website-people">Website People</a></li>
108
+ <li><a href="#website-people-these-are-your-end-users">Website People</a></li>
109
109
  <li><a href="#website-operator">Website Operator</a></li>
110
110
  <li><a href="#website-availability">Website Availability</a></li>
111
111
  <li><a href="#website-analytics">Website Analytics</a></li>
@@ -174,7 +174,7 @@ All methods that you will most likely need when building a Crisp integration are
174
174
  ```javascript
175
175
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
176
176
  var pageNumber = 1;
177
-
177
+
178
178
  CrispClient.website.listConversations(websiteID, pageNumber);
179
179
  ```
180
180
  </details>
@@ -187,7 +187,7 @@ All methods that you will most likely need when building a Crisp integration are
187
187
  ```javascript
188
188
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
189
189
  var pageNumber = 1;
190
-
190
+
191
191
  CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber);
192
192
  ```
193
193
  </details>
@@ -199,9 +199,9 @@ All methods that you will most likely need when building a Crisp integration are
199
199
 
200
200
  ```javascript
201
201
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
202
-
202
+
203
203
  var segment = "bug";
204
-
204
+
205
205
  CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment);
206
206
  ```
207
207
  </details>
@@ -214,7 +214,7 @@ All methods that you will most likely need when building a Crisp integration are
214
214
  ```javascript
215
215
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
216
216
  var pageNumber = 1;
217
-
217
+
218
218
  CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber);
219
219
  ```
220
220
  </details>
@@ -226,9 +226,9 @@ All methods that you will most likely need when building a Crisp integration are
226
226
 
227
227
  ```javascript
228
228
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
229
-
229
+
230
230
  var key = "price";
231
-
231
+
232
232
  CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key);
233
233
  ```
234
234
  </details>
@@ -242,7 +242,7 @@ All methods that you will most likely need when building a Crisp integration are
242
242
 
243
243
  ```javascript
244
244
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
245
-
245
+
246
246
  CrispClient.website.createNewConversation(websiteID);
247
247
  ```
248
248
  </details>
@@ -255,7 +255,7 @@ All methods that you will most likely need when building a Crisp integration are
255
255
  ```javascript
256
256
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
257
257
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
258
-
258
+
259
259
  CrispClient.website.checkConversationExists(websiteID, sessionID);
260
260
  ```
261
261
  </details>
@@ -268,7 +268,7 @@ All methods that you will most likely need when building a Crisp integration are
268
268
  ```javascript
269
269
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
270
270
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
271
-
271
+
272
272
  CrispClient.website.getConversation(websiteID, sessionID);
273
273
  ```
274
274
  </details>
@@ -281,7 +281,7 @@ All methods that you will most likely need when building a Crisp integration are
281
281
  ```javascript
282
282
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
283
283
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
284
-
284
+
285
285
  CrispClient.website.removeConversation(websiteID, sessionID);
286
286
  ```
287
287
  </details>
@@ -294,7 +294,7 @@ All methods that you will most likely need when building a Crisp integration are
294
294
  ```javascript
295
295
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
296
296
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
297
-
297
+
298
298
  CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID);
299
299
  ```
300
300
  </details>
@@ -308,7 +308,7 @@ All methods that you will most likely need when building a Crisp integration are
308
308
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
309
309
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
310
310
  var timestampBefore = 1641206011000;
311
-
311
+
312
312
  CrispClient.website.getMessagesInConversation(websiteID, sessionID, timestampBefore);
313
313
  ```
314
314
  </details>
@@ -321,14 +321,14 @@ All methods that you will most likely need when building a Crisp integration are
321
321
  ```javascript
322
322
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
323
323
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
324
-
324
+
325
325
  var message = {
326
326
  "type": "text",
327
327
  "from": "operator",
328
328
  "origin": "chat",
329
329
  "content": "Hey there! Need help?"
330
330
  };
331
-
331
+
332
332
  CrispClient.website.sendMessageInConversation(websiteID, sessionID, message);
333
333
  ```
334
334
  </details>
@@ -342,7 +342,7 @@ All methods that you will most likely need when building a Crisp integration are
342
342
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
343
343
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
344
344
  var fingerprint = 524653764345;
345
-
345
+
346
346
  CrispClient.website.getMessageInConversation(websiteID, sessionID, fingerprint);
347
347
  ```
348
348
  </details>
@@ -356,13 +356,27 @@ All methods that you will most likely need when building a Crisp integration are
356
356
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
357
357
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
358
358
  var fingerprint = 524653764345;
359
-
359
+
360
360
  var content = "Hey there! Need help?";
361
-
361
+
362
362
  CrispClient.website.updateMessageInConversation(websiteID, sessionID, fingerprint, content);
363
363
  ```
364
364
  </details>
365
365
 
366
+ * **Remove A Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-a-message-in-conversation)
367
+ * `CrispClient.website.removeMessageInConversation(websiteID, sessionID, fingerprint)`
368
+ * <details>
369
+ <summary>See Example</summary>
370
+
371
+ ```javascript
372
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
373
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
374
+ var fingerprint = 524653764345;
375
+
376
+ CrispClient.website.removeMessageInConversation(websiteID, sessionID, fingerprint);
377
+ ```
378
+ </details>
379
+
366
380
  * **Compose A Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#compose-a-message-in-conversation)
367
381
  * `CrispClient.website.composeMessageInConversation(websiteID, sessionID, compose)`
368
382
  * <details>
@@ -371,12 +385,12 @@ All methods that you will most likely need when building a Crisp integration are
371
385
  ```javascript
372
386
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
373
387
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
374
-
388
+
375
389
  var compose = {
376
390
  "type": "start",
377
391
  "from": "operator"
378
392
  };
379
-
393
+
380
394
  CrispClient.website.composeMessageInConversation(websiteID, sessionID, compose);
381
395
  ```
382
396
  </details>
@@ -389,7 +403,7 @@ All methods that you will most likely need when building a Crisp integration are
389
403
  ```javascript
390
404
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
391
405
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
392
-
406
+
393
407
  var read = {
394
408
  "from": "operator",
395
409
  "origin": "urn:crisp.im:slack:0",
@@ -397,7 +411,7 @@ All methods that you will most likely need when building a Crisp integration are
397
411
  "5719231201"
398
412
  ]
399
413
  };
400
-
414
+
401
415
  CrispClient.website.markMessagesReadInConversation(websiteID, sessionID, read);
402
416
  ```
403
417
  </details>
@@ -410,7 +424,7 @@ All methods that you will most likely need when building a Crisp integration are
410
424
  ```javascript
411
425
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
412
426
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
413
-
427
+
414
428
  var delivered = {
415
429
  "from": "operator",
416
430
  "origin": "urn:crisp.im:slack:0",
@@ -418,7 +432,7 @@ All methods that you will most likely need when building a Crisp integration are
418
432
  "5719231201"
419
433
  ]
420
434
  };
421
-
435
+
422
436
  CrispClient.website.markMessagesDeliveredInConversation(websiteID, sessionID, delivered);
423
437
  ```
424
438
  </details>
@@ -431,9 +445,9 @@ All methods that you will most likely need when building a Crisp integration are
431
445
  ```javascript
432
446
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
433
447
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
434
-
448
+
435
449
  var opened = true;
436
-
450
+
437
451
  CrispClient.website.updateConversationOpenState(websiteID, sessionID, opened);
438
452
  ```
439
453
  </details>
@@ -446,7 +460,7 @@ All methods that you will most likely need when building a Crisp integration are
446
460
  ```javascript
447
461
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
448
462
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
449
-
463
+
450
464
  CrispClient.website.getConversationRoutingAssign(websiteID, sessionID);
451
465
  ```
452
466
  </details>
@@ -459,13 +473,13 @@ All methods that you will most likely need when building a Crisp integration are
459
473
  ```javascript
460
474
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
461
475
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
462
-
476
+
463
477
  var assign = {
464
478
  "assigned": {
465
479
  "user_id": "a4c32c68-be91-4e29-8a05-976e93abbe3f"
466
480
  }
467
481
  };
468
-
482
+
469
483
  CrispClient.website.assignConversationRouting(websiteID, sessionID, assign);
470
484
  ```
471
485
  </details>
@@ -478,7 +492,7 @@ All methods that you will most likely need when building a Crisp integration are
478
492
  ```javascript
479
493
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
480
494
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
481
-
495
+
482
496
  CrispClient.website.getConversationMetas(websiteID, sessionID);
483
497
  ```
484
498
  </details>
@@ -491,7 +505,7 @@ All methods that you will most likely need when building a Crisp integration are
491
505
  ```javascript
492
506
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
493
507
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
494
-
508
+
495
509
  var metas = {
496
510
  "nickname": "John Doe",
497
511
  "email": "john.doe@acme-inc.com",
@@ -505,7 +519,7 @@ All methods that you will most likely need when building a Crisp integration are
505
519
  "signup": "finished"
506
520
  }
507
521
  };
508
-
522
+
509
523
  CrispClient.website.updateConversationMetas(websiteID, sessionID, metas);
510
524
  ```
511
525
  </details>
@@ -519,7 +533,7 @@ All methods that you will most likely need when building a Crisp integration are
519
533
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
520
534
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
521
535
  var originalID = "2325a3c0-9b47-4fc6-b00e-111b752e44cd";
522
-
536
+
523
537
  CrispClient.website.getOriginalMessageInConversation(websiteID, sessionID, originalID);
524
538
  ```
525
539
  </details>
@@ -533,7 +547,7 @@ All methods that you will most likely need when building a Crisp integration are
533
547
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
534
548
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
535
549
  var pageNumber = 1;
536
-
550
+
537
551
  CrispClient.website.listConversationPages(websiteID, sessionID, pageNumber);
538
552
  ```
539
553
  </details>
@@ -547,7 +561,7 @@ All methods that you will most likely need when building a Crisp integration are
547
561
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
548
562
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
549
563
  var pageNumber = 1;
550
-
564
+
551
565
  CrispClient.website.listConversationEvents(websiteID, sessionID, pageNumber);
552
566
  ```
553
567
  </details>
@@ -560,7 +574,7 @@ All methods that you will most likely need when building a Crisp integration are
560
574
  ```javascript
561
575
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
562
576
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
563
-
577
+
564
578
  CrispClient.website.getConversationState(websiteID, sessionID);
565
579
  ```
566
580
  </details>
@@ -573,9 +587,9 @@ All methods that you will most likely need when building a Crisp integration are
573
587
  ```javascript
574
588
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
575
589
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
576
-
590
+
577
591
  var state = "unresolved";
578
-
592
+
579
593
  CrispClient.website.changeConversationState(websiteID, sessionID, state);
580
594
  ```
581
595
  </details>
@@ -588,7 +602,7 @@ All methods that you will most likely need when building a Crisp integration are
588
602
  ```javascript
589
603
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
590
604
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
591
-
605
+
592
606
  CrispClient.website.getConversationParticipants(websiteID, sessionID);
593
607
  ```
594
608
  </details>
@@ -601,7 +615,7 @@ All methods that you will most likely need when building a Crisp integration are
601
615
  ```javascript
602
616
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
603
617
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
604
-
618
+
605
619
  var participants = {
606
620
  "participants": [
607
621
  {
@@ -610,7 +624,7 @@ All methods that you will most likely need when building a Crisp integration are
610
624
  }
611
625
  ]
612
626
  };
613
-
627
+
614
628
  CrispClient.website.saveConversationParticipants(websiteID, sessionID, participants);
615
629
  ```
616
630
  </details>
@@ -623,7 +637,7 @@ All methods that you will most likely need when building a Crisp integration are
623
637
  ```javascript
624
638
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
625
639
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
626
-
640
+
627
641
  CrispClient.website.getBlockStatusForConversation(websiteID, sessionID);
628
642
  ```
629
643
  </details>
@@ -636,13 +650,41 @@ All methods that you will most likely need when building a Crisp integration are
636
650
  ```javascript
637
651
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
638
652
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
639
-
653
+
640
654
  var blocked = true;
641
-
655
+
642
656
  CrispClient.website.blockIncomingMessagesForConversation(websiteID, sessionID, blocked);
643
657
  ```
644
658
  </details>
645
659
 
660
+ * **Get Verify Status For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-verify-status-for-conversation)
661
+ * `CrispClient.website.getVerifyStatusForConversation(websiteID, sessionID)`
662
+ * <details>
663
+ <summary>See Example</summary>
664
+
665
+ ```javascript
666
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
667
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
668
+
669
+ CrispClient.website.getVerifyStatusForConversation(websiteID, sessionID);
670
+ ```
671
+ </details>
672
+
673
+ * **Update Verify Status For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-verify-status-for-conversation)
674
+ * `CrispClient.website.updateVerifyStatusForConversation(websiteID, sessionID, verified)`
675
+ * <details>
676
+ <summary>See Example</summary>
677
+
678
+ ```javascript
679
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
680
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
681
+
682
+ var verified = true;
683
+
684
+ CrispClient.website.updateVerifyStatusForConversation(websiteID, sessionID, verified);
685
+ ```
686
+ </details>
687
+
646
688
  * **Request Email Transcript For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-email-transcript-for-conversation)
647
689
  * `CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email)`
648
690
  * <details>
@@ -651,12 +693,12 @@ All methods that you will most likely need when building a Crisp integration are
651
693
  ```javascript
652
694
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
653
695
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
654
-
696
+
655
697
  var email = {
656
698
  "to": "operator",
657
699
  "email": "valerian@crisp.chat"
658
700
  };
659
-
701
+
660
702
  CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email);
661
703
  ```
662
704
  </details>
@@ -669,7 +711,7 @@ All methods that you will most likely need when building a Crisp integration are
669
711
  ```javascript
670
712
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
671
713
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
672
-
714
+
673
715
  CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID);
674
716
  ```
675
717
  </details>
@@ -682,7 +724,7 @@ All methods that you will most likely need when building a Crisp integration are
682
724
  ```javascript
683
725
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
684
726
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
685
-
727
+
686
728
  CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID);
687
729
  ```
688
730
  </details>
@@ -695,7 +737,7 @@ All methods that you will most likely need when building a Crisp integration are
695
737
  ```javascript
696
738
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
697
739
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
698
-
740
+
699
741
  CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID);
700
742
  ```
701
743
  </details>
@@ -709,9 +751,9 @@ All methods that you will most likely need when building a Crisp integration are
709
751
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
710
752
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
711
753
  var browsingID = "browsing_05a9392d-ff3f-45e7-b021-1179c45668fa";
712
-
754
+
713
755
  var action = "start";
714
-
756
+
715
757
  CrispClient.website.sendActionToExistingBrowsingSession(websiteID, sessionID, browsingID, action);
716
758
  ```
717
759
  </details>
@@ -725,7 +767,7 @@ All methods that you will most likely need when building a Crisp integration are
725
767
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
726
768
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
727
769
  var browsingID = "browsing_05a9392d-ff3f-45e7-b021-1179c45668fa";
728
-
770
+
729
771
  var assist = {
730
772
  "action": "mouse",
731
773
  "mouse": {
@@ -733,7 +775,7 @@ All methods that you will most likely need when building a Crisp integration are
733
775
  "y": 784
734
776
  }
735
777
  };
736
-
778
+
737
779
  CrispClient.website.assistExistingBrowsingSession(websiteID, sessionID, browsingID, assist);
738
780
  ```
739
781
  </details>
@@ -746,9 +788,9 @@ All methods that you will most likely need when building a Crisp integration are
746
788
  ```javascript
747
789
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
748
790
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
749
-
791
+
750
792
  var mode = "audio";
751
-
793
+
752
794
  CrispClient.website.initiateNewCallSessionForConversation(websiteID, sessionID, mode);
753
795
  ```
754
796
  </details>
@@ -761,7 +803,7 @@ All methods that you will most likely need when building a Crisp integration are
761
803
  ```javascript
762
804
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
763
805
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
764
-
806
+
765
807
  CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID);
766
808
  ```
767
809
  </details>
@@ -775,7 +817,7 @@ All methods that you will most likely need when building a Crisp integration are
775
817
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
776
818
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
777
819
  var callID = "call_35a0c062-72fa-4095-a2a0-f9911d47ee56";
778
-
820
+
779
821
  CrispClient.website.abortOngoingCallSessionForConversation(websiteID, sessionID, callID);
780
822
  ```
781
823
  </details>
@@ -789,12 +831,12 @@ All methods that you will most likely need when building a Crisp integration are
789
831
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
790
832
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
791
833
  var callID = "call_35a0c062-72fa-4095-a2a0-f9911d47ee56";
792
-
834
+
793
835
  var payload = {
794
836
  "type": "sdp",
795
837
  "payload": {}
796
838
  };
797
-
839
+
798
840
  CrispClient.website.transmitSignalingOnOngoingCallSession(websiteID, sessionID, callID, payload);
799
841
  ```
800
842
  </details>
@@ -810,7 +852,7 @@ All methods that you will most likely need when building a Crisp integration are
810
852
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
811
853
  var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292";
812
854
  var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785";
813
-
855
+
814
856
  var value = {
815
857
  "section_id": "payments",
816
858
  "item_id": "refund_on_stripe",
@@ -818,7 +860,7 @@ All methods that you will most likely need when building a Crisp integration are
818
860
  "invoice": "D-1929-X"
819
861
  }
820
862
  };
821
-
863
+
822
864
  CrispClient.website.deliverWidgetButtonActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data, value);
823
865
  ```
824
866
  </details>
@@ -834,14 +876,14 @@ All methods that you will most likely need when building a Crisp integration are
834
876
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
835
877
  var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292";
836
878
  var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785";
837
-
879
+
838
880
  var data = {
839
881
  "section_id": "payments",
840
882
  "item_id": "unpaid_balance",
841
883
  "action": "fetch",
842
884
  "data": {}
843
885
  };
844
-
886
+
845
887
  CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data);
846
888
  ```
847
889
  </details>
@@ -857,14 +899,14 @@ All methods that you will most likely need when building a Crisp integration are
857
899
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
858
900
  var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292";
859
901
  var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785";
860
-
902
+
861
903
  var data = {
862
904
  "section_id": "payments",
863
905
  "item_id": "unpaid_balance",
864
906
  "action": "fetch",
865
907
  "data": {}
866
908
  };
867
-
909
+
868
910
  CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data);
869
911
  ```
870
912
  </details>
@@ -877,12 +919,12 @@ All methods that you will most likely need when building a Crisp integration are
877
919
  ```javascript
878
920
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
879
921
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
880
-
922
+
881
923
  var note = {
882
924
  "date": "2018-05-29T09:00:00Z",
883
925
  "note": "Call this customer."
884
926
  };
885
-
927
+
886
928
  CrispClient.website.scheduleReminderForConversation(websiteID, sessionID, date, note);
887
929
  ```
888
930
  </details>
@@ -896,7 +938,7 @@ All methods that you will most likely need when building a Crisp integration are
896
938
 
897
939
  ```javascript
898
940
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
899
-
941
+
900
942
  CrispClient.website.getPeopleStatistics(websiteID);
901
943
  ```
902
944
  </details>
@@ -909,7 +951,7 @@ All methods that you will most likely need when building a Crisp integration are
909
951
  ```javascript
910
952
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
911
953
  var pageNumber = 1;
912
-
954
+
913
955
  CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber);
914
956
  ```
915
957
  </details>
@@ -921,9 +963,9 @@ All methods that you will most likely need when building a Crisp integration are
921
963
 
922
964
  ```javascript
923
965
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
924
-
966
+
925
967
  var segment = "poweruser";
926
-
968
+
927
969
  CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment);
928
970
  ```
929
971
  </details>
@@ -937,9 +979,9 @@ All methods that you will most likely need when building a Crisp integration are
937
979
 
938
980
  ```javascript
939
981
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
940
-
982
+
941
983
  var key = "price";
942
-
984
+
943
985
  CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key);
944
986
  ```
945
987
  </details>
@@ -952,7 +994,7 @@ All methods that you will most likely need when building a Crisp integration are
952
994
  ```javascript
953
995
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
954
996
  var pageNumber = 1;
955
-
997
+
956
998
  CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber);
957
999
  ```
958
1000
  </details>
@@ -964,9 +1006,9 @@ All methods that you will most likely need when building a Crisp integration are
964
1006
 
965
1007
  ```javascript
966
1008
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
967
-
1009
+
968
1010
  var text = "Removed item from basket";
969
-
1011
+
970
1012
  CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text);
971
1013
  ```
972
1014
  </details>
@@ -979,7 +1021,7 @@ All methods that you will most likely need when building a Crisp integration are
979
1021
  ```javascript
980
1022
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
981
1023
  var pageNumber = 1;
982
-
1024
+
983
1025
  CrispClient.website.listPeopleProfiles(websiteID, pageNumber, searchField, searchOrder, searchOperator, searchFilter, searchText);
984
1026
  ```
985
1027
  </details>
@@ -991,14 +1033,14 @@ All methods that you will most likely need when building a Crisp integration are
991
1033
 
992
1034
  ```javascript
993
1035
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
994
-
1036
+
995
1037
  var peopleProfile = {
996
1038
  "email": "valerian@crisp.chat",
997
1039
  "person": {
998
1040
  "nickname": "Valerian Saliou"
999
1041
  }
1000
1042
  };
1001
-
1043
+
1002
1044
  CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile);
1003
1045
  ```
1004
1046
  </details>
@@ -1011,7 +1053,7 @@ All methods that you will most likely need when building a Crisp integration are
1011
1053
  ```javascript
1012
1054
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1013
1055
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1014
-
1056
+
1015
1057
  CrispClient.website.checkPeopleProfileExists(websiteID, peopleID);
1016
1058
  ```
1017
1059
  </details>
@@ -1024,7 +1066,7 @@ All methods that you will most likely need when building a Crisp integration are
1024
1066
  ```javascript
1025
1067
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1026
1068
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1027
-
1069
+
1028
1070
  CrispClient.website.getPeopleProfile(websiteID, peopleID);
1029
1071
  ```
1030
1072
  </details>
@@ -1037,14 +1079,14 @@ All methods that you will most likely need when building a Crisp integration are
1037
1079
  ```javascript
1038
1080
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1039
1081
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1040
-
1082
+
1041
1083
  var peopleProfile = {
1042
1084
  "email": "valerian@crisp.chat",
1043
1085
  "person": {
1044
1086
  "nickname": "Valerian Saliou"
1045
1087
  }
1046
1088
  };
1047
-
1089
+
1048
1090
  CrispClient.website.savePeopleProfile(websiteID, peopleID, peopleProfile);
1049
1091
  ```
1050
1092
  </details>
@@ -1057,14 +1099,14 @@ All methods that you will most likely need when building a Crisp integration are
1057
1099
  ```javascript
1058
1100
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1059
1101
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1060
-
1102
+
1061
1103
  var peopleProfile = {
1062
1104
  "email": "valerian@crisp.chat",
1063
1105
  "person": {
1064
1106
  "nickname": "Valerian Saliou"
1065
1107
  }
1066
1108
  };
1067
-
1109
+
1068
1110
  CrispClient.website.updatePeopleProfile(websiteID, peopleID, peopleProfile);
1069
1111
  ```
1070
1112
  </details>
@@ -1077,7 +1119,7 @@ All methods that you will most likely need when building a Crisp integration are
1077
1119
  ```javascript
1078
1120
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1079
1121
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1080
-
1122
+
1081
1123
  CrispClient.website.removePeopleProfile(websiteID, peopleID);
1082
1124
  ```
1083
1125
  </details>
@@ -1091,7 +1133,7 @@ All methods that you will most likely need when building a Crisp integration are
1091
1133
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1092
1134
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1093
1135
  var pageNumber = 1;
1094
-
1136
+
1095
1137
  CrispClient.website.listPeopleConversations(websiteID, peopleID, pageNumber);
1096
1138
  ```
1097
1139
  </details>
@@ -1105,7 +1147,7 @@ All methods that you will most likely need when building a Crisp integration are
1105
1147
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1106
1148
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1107
1149
  var pageNumber = 1;
1108
-
1150
+
1109
1151
  CrispClient.website.listPeopleCampaigns(websiteID, peopleID, pageNumber);
1110
1152
  ```
1111
1153
  </details>
@@ -1118,7 +1160,7 @@ All methods that you will most likely need when building a Crisp integration are
1118
1160
  ```javascript
1119
1161
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1120
1162
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1121
-
1163
+
1122
1164
  var peopleEvent = {
1123
1165
  "text": "Added item to basket",
1124
1166
  "data": {
@@ -1127,7 +1169,7 @@ All methods that you will most likely need when building a Crisp integration are
1127
1169
  },
1128
1170
  "color": "red"
1129
1171
  };
1130
-
1172
+
1131
1173
  CrispClient.website.addPeopleEvent(websiteID, peopleID, peopleEvent);
1132
1174
  ```
1133
1175
  </details>
@@ -1141,7 +1183,7 @@ All methods that you will most likely need when building a Crisp integration are
1141
1183
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1142
1184
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1143
1185
  var pageNumber = 1;
1144
-
1186
+
1145
1187
  CrispClient.website.listPeopleEvents(websiteID, peopleID, pageNumber);
1146
1188
  ```
1147
1189
  </details>
@@ -1154,7 +1196,7 @@ All methods that you will most likely need when building a Crisp integration are
1154
1196
  ```javascript
1155
1197
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1156
1198
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1157
-
1199
+
1158
1200
  CrispClient.website.getPeopleData(websiteID, peopleID);
1159
1201
  ```
1160
1202
  </details>
@@ -1167,14 +1209,14 @@ All methods that you will most likely need when building a Crisp integration are
1167
1209
  ```javascript
1168
1210
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1169
1211
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1170
-
1212
+
1171
1213
  var peopleData = {
1172
1214
  "data": {
1173
1215
  "type": "customer",
1174
1216
  "signup": "finished"
1175
1217
  }
1176
1218
  };
1177
-
1219
+
1178
1220
  CrispClient.website.savePeopleData(websiteID, peopleID, peopleData);
1179
1221
  ```
1180
1222
  </details>
@@ -1187,13 +1229,13 @@ All methods that you will most likely need when building a Crisp integration are
1187
1229
  ```javascript
1188
1230
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1189
1231
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1190
-
1232
+
1191
1233
  var peopleData = {
1192
1234
  "data": {
1193
1235
  "signup": "finished"
1194
1236
  }
1195
1237
  };
1196
-
1238
+
1197
1239
  CrispClient.website.updatePeopleData(websiteID, peopleID, peopleData);
1198
1240
  ```
1199
1241
  </details>
@@ -1206,7 +1248,7 @@ All methods that you will most likely need when building a Crisp integration are
1206
1248
  ```javascript
1207
1249
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1208
1250
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1209
-
1251
+
1210
1252
  CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID);
1211
1253
  ```
1212
1254
  </details>
@@ -1219,11 +1261,11 @@ All methods that you will most likely need when building a Crisp integration are
1219
1261
  ```javascript
1220
1262
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1221
1263
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1222
-
1264
+
1223
1265
  var peopleSubscription = {
1224
1266
  "email": true
1225
1267
  };
1226
-
1268
+
1227
1269
  CrispClient.website.updatePeopleSubscriptionStatus(websiteID, peopleID, peopleSubscription);
1228
1270
  ```
1229
1271
  </details>
@@ -1235,7 +1277,7 @@ All methods that you will most likely need when building a Crisp integration are
1235
1277
 
1236
1278
  ```javascript
1237
1279
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1238
-
1280
+
1239
1281
  CrispClient.website.exportPeopleProfiles(websiteID);
1240
1282
  ```
1241
1283
  </details>
@@ -1247,7 +1289,7 @@ All methods that you will most likely need when building a Crisp integration are
1247
1289
 
1248
1290
  ```javascript
1249
1291
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1250
-
1292
+
1251
1293
  var profileImportSetup = {
1252
1294
  "url": "https://storage.crisp.chat/users/processing/import/aa0b64dd-9fb4-4db9-80d6-5a49eb84087b/19d956c7-0294-45ad-89e1-58ce45e7008f.csv",
1253
1295
  "mapping": [
@@ -1265,7 +1307,7 @@ All methods that you will most likely need when building a Crisp integration are
1265
1307
  "skip_header": true
1266
1308
  }
1267
1309
  };
1268
-
1310
+
1269
1311
  CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup);
1270
1312
  ```
1271
1313
  </details>
@@ -1301,7 +1343,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1301
1343
 
1302
1344
  ```javascript
1303
1345
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1304
-
1346
+
1305
1347
  CrispClient.website.getWebsite(websiteID);
1306
1348
  ```
1307
1349
  </details>
@@ -1313,9 +1355,9 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1313
1355
 
1314
1356
  ```javascript
1315
1357
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1316
-
1358
+
1317
1359
  var verify = "MySuperSecurePassword";
1318
-
1360
+
1319
1361
  CrispClient.website.deleteWebsite(websiteID, verify);
1320
1362
  ```
1321
1363
  </details>
@@ -1329,7 +1371,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1329
1371
 
1330
1372
  ```javascript
1331
1373
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1332
-
1374
+
1333
1375
  CrispClient.website.getWebsiteSettings(websiteID);
1334
1376
  ```
1335
1377
  </details>
@@ -1341,7 +1383,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1341
1383
 
1342
1384
  ```javascript
1343
1385
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1344
-
1386
+
1345
1387
  var settings = {
1346
1388
  "name": "Crisp",
1347
1389
  "domain": "crisp.chat",
@@ -1406,7 +1448,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1406
1448
  ]
1407
1449
  }
1408
1450
  };
1409
-
1451
+
1410
1452
  CrispClient.website.updateWebsiteSettings(websiteID, settings);
1411
1453
  ```
1412
1454
  </details>
@@ -1420,7 +1462,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1420
1462
 
1421
1463
  ```javascript
1422
1464
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1423
-
1465
+
1424
1466
  CrispClient.website.listWebsiteOperators(websiteID);
1425
1467
  ```
1426
1468
  </details>
@@ -1432,7 +1474,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1432
1474
 
1433
1475
  ```javascript
1434
1476
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1435
-
1477
+
1436
1478
  CrispClient.website.listLastActiveWebsiteOperators(websiteID);
1437
1479
  ```
1438
1480
  </details>
@@ -1444,7 +1486,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1444
1486
 
1445
1487
  ```javascript
1446
1488
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1447
-
1489
+
1448
1490
  CrispClient.website.flushLastActiveWebsiteOperators(websiteID);
1449
1491
  ```
1450
1492
  </details>
@@ -1456,13 +1498,13 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1456
1498
 
1457
1499
  ```javascript
1458
1500
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1459
-
1501
+
1460
1502
  var emailData = {
1461
1503
  "recipient": "owners",
1462
1504
  "subject": "Plugin limits reached",
1463
1505
  "message": "Hi, you've reached the Slack plugin limits. Please contact our support team."
1464
1506
  };
1465
-
1507
+
1466
1508
  CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData);
1467
1509
  ```
1468
1510
  </details>
@@ -1475,7 +1517,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1475
1517
  ```javascript
1476
1518
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1477
1519
  var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
1478
-
1520
+
1479
1521
  CrispClient.website.getWebsiteOperator(websiteID, userID);
1480
1522
  ```
1481
1523
  </details>
@@ -1487,13 +1529,13 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1487
1529
 
1488
1530
  ```javascript
1489
1531
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1490
-
1532
+
1491
1533
  var verify = {
1492
1534
  "email": "julien@crisp.chat",
1493
1535
  "role": "member",
1494
1536
  "verify": "MySuperSecurePassword"
1495
1537
  };
1496
-
1538
+
1497
1539
  CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify);
1498
1540
  ```
1499
1541
  </details>
@@ -1506,12 +1548,12 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1506
1548
  ```javascript
1507
1549
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1508
1550
  var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
1509
-
1551
+
1510
1552
  var title = {
1511
1553
  "role": "owner",
1512
1554
  "title": "CTO"
1513
1555
  };
1514
-
1556
+
1515
1557
  CrispClient.website.changeOperatorMembership(websiteID, userID, role, title);
1516
1558
  ```
1517
1559
  </details>
@@ -1524,7 +1566,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1524
1566
  ```javascript
1525
1567
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1526
1568
  var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
1527
-
1569
+
1528
1570
  CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID);
1529
1571
  ```
1530
1572
  </details>
@@ -1538,7 +1580,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1538
1580
 
1539
1581
  ```javascript
1540
1582
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1541
-
1583
+
1542
1584
  CrispClient.website.countVisitors(websiteID);
1543
1585
  ```
1544
1586
  </details>
@@ -1551,7 +1593,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1551
1593
  ```javascript
1552
1594
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1553
1595
  var pageNumber = 1;
1554
-
1596
+
1555
1597
  CrispClient.website.listVisitors(websiteID, pageNumber);
1556
1598
  ```
1557
1599
  </details>
@@ -1563,7 +1605,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1563
1605
 
1564
1606
  ```javascript
1565
1607
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1566
-
1608
+
1567
1609
  CrispClient.website.pinpointVisitorsOnMap(websiteID, centerLongitude, centerLatitude, centerRadius);
1568
1610
  ```
1569
1611
  </details>
@@ -1576,7 +1618,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1576
1618
  ```javascript
1577
1619
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1578
1620
  var tokenID = "d3c17241-1327-47d7-9d8e-b89ff7bd2904";
1579
-
1621
+
1580
1622
  CrispClient.website.getSessionIdentifierFromToken(websiteID, tokenID);
1581
1623
  ```
1582
1624
  </details>
@@ -1590,7 +1632,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1590
1632
 
1591
1633
  ```javascript
1592
1634
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1593
-
1635
+
1594
1636
  CrispClient.website.countBlockedVisitorsInRule(websiteID, rule);
1595
1637
  ```
1596
1638
  </details>
@@ -1602,7 +1644,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1602
1644
 
1603
1645
  ```javascript
1604
1646
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1605
-
1647
+
1606
1648
  CrispClient.website.clearBlockedVisitorsInRule(websiteID, rule);
1607
1649
  ```
1608
1650
  </details>
@@ -1616,7 +1658,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1616
1658
 
1617
1659
  ```javascript
1618
1660
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1619
-
1661
+
1620
1662
  CrispClient.website.getWebsiteAvailabilityStatus(websiteID);
1621
1663
  ```
1622
1664
  </details>
@@ -1628,7 +1670,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1628
1670
 
1629
1671
  ```javascript
1630
1672
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1631
-
1673
+
1632
1674
  CrispClient.website.listWebsiteOperatorAvailabilities(websiteID);
1633
1675
  ```
1634
1676
  </details>
@@ -1642,7 +1684,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1642
1684
 
1643
1685
  ```javascript
1644
1686
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1645
-
1687
+
1646
1688
  CrispClient.website.acquireAnalyticsPoints(websiteID, pointType, pointMetric, dateFrom, dateTo, dateSplit, classifier, filterPrimary, filterSecondary, filterTertiary);
1647
1689
  ```
1648
1690
  </details>
@@ -1655,7 +1697,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1655
1697
  ```javascript
1656
1698
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1657
1699
  var pageNumber = 1;
1658
-
1700
+
1659
1701
  CrispClient.website.listAnalyticsFilters(websiteID, pageNumber, pointType, pointMetric, dateFrom, dateTo);
1660
1702
  ```
1661
1703
  </details>
@@ -1668,7 +1710,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1668
1710
  ```javascript
1669
1711
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1670
1712
  var pageNumber = 1;
1671
-
1713
+
1672
1714
  CrispClient.website.listAnalyticsClassifiers(websiteID, pageNumber, pointType, pointMetric, dateFrom, dateTo);
1673
1715
  ```
1674
1716
  </details>
@@ -1682,7 +1724,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1682
1724
 
1683
1725
  ```javascript
1684
1726
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1685
-
1727
+
1686
1728
  CrispClient.website.batchResolveConversations(websiteID, sessions);
1687
1729
  ```
1688
1730
  </details>
@@ -1694,7 +1736,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1694
1736
 
1695
1737
  ```javascript
1696
1738
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1697
-
1739
+
1698
1740
  CrispClient.website.batchReadConversations(websiteID, sessions);
1699
1741
  ```
1700
1742
  </details>
@@ -1706,12 +1748,12 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1706
1748
 
1707
1749
  ```javascript
1708
1750
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1709
-
1751
+
1710
1752
  var sessions = [
1711
1753
  "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
1712
1754
  "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
1713
1755
  ];
1714
-
1756
+
1715
1757
  CrispClient.website.batchRemoveConversations(websiteID, sessions);
1716
1758
  ```
1717
1759
  </details>
@@ -1723,12 +1765,12 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1723
1765
 
1724
1766
  ```javascript
1725
1767
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1726
-
1768
+
1727
1769
  var sessions = [
1728
1770
  "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
1729
1771
  "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
1730
1772
  ];
1731
-
1773
+
1732
1774
  CrispClient.website.batchRemoveConversations(websiteID, sessions);
1733
1775
  ```
1734
1776
  </details>
@@ -1742,7 +1784,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1742
1784
 
1743
1785
  ```javascript
1744
1786
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1745
-
1787
+
1746
1788
  CrispClient.website.getVerifySettings(websiteID);
1747
1789
  ```
1748
1790
  </details>
@@ -1754,11 +1796,11 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1754
1796
 
1755
1797
  ```javascript
1756
1798
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1757
-
1799
+
1758
1800
  var settings = {
1759
1801
  "enabled": true
1760
1802
  };
1761
-
1803
+
1762
1804
  CrispClient.website.updateVerifySettings(websiteID, settings);
1763
1805
  ```
1764
1806
  </details>
@@ -1770,7 +1812,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1770
1812
 
1771
1813
  ```javascript
1772
1814
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1773
-
1815
+
1774
1816
  CrispClient.website.getVerifyKey(websiteID);
1775
1817
  ```
1776
1818
  </details>
@@ -1782,7 +1824,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1782
1824
 
1783
1825
  ```javascript
1784
1826
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1785
-
1827
+
1786
1828
  CrispClient.website.rollVerifyKey(websiteID);
1787
1829
  ```
1788
1830
  </details>
@@ -1797,7 +1839,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1797
1839
  ```javascript
1798
1840
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1799
1841
  var pageNumber = 1;
1800
-
1842
+
1801
1843
  CrispClient.website.listCampaigns(websiteID, pageNumber);
1802
1844
  ```
1803
1845
  </details>
@@ -1809,7 +1851,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1809
1851
 
1810
1852
  ```javascript
1811
1853
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1812
-
1854
+
1813
1855
  CrispClient.website.listCampaignTags(websiteID);
1814
1856
  ```
1815
1857
  </details>
@@ -1822,7 +1864,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1822
1864
  ```javascript
1823
1865
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1824
1866
  var pageNumber = 1;
1825
-
1867
+
1826
1868
  CrispClient.website.listCampaignTemplates(websiteID, pageNumber);
1827
1869
  ```
1828
1870
  </details>
@@ -1834,12 +1876,12 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1834
1876
 
1835
1877
  ```javascript
1836
1878
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1837
-
1879
+
1838
1880
  var templateName = {
1839
1881
  "name": "HTML Template",
1840
1882
  "format": "html"
1841
1883
  };
1842
-
1884
+
1843
1885
  CrispClient.website.createNewCampaignTemplate(websiteID, templateFormat, templateName);
1844
1886
  ```
1845
1887
  </details>
@@ -1852,7 +1894,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1852
1894
  ```javascript
1853
1895
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1854
1896
  var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
1855
-
1897
+
1856
1898
  CrispClient.website.checkCampaignTemplateExists(websiteID, templateID);
1857
1899
  ```
1858
1900
  </details>
@@ -1865,7 +1907,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1865
1907
  ```javascript
1866
1908
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1867
1909
  var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
1868
-
1910
+
1869
1911
  CrispClient.website.getCampaignTemplate(websiteID, templateID);
1870
1912
  ```
1871
1913
  </details>
@@ -1878,13 +1920,13 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1878
1920
  ```javascript
1879
1921
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1880
1922
  var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
1881
-
1923
+
1882
1924
  var template = {
1883
1925
  "name": "HTML Template",
1884
1926
  "format": "html",
1885
1927
  "content": "<html><body><a href=\"{{url.unsubscribe}}\"></a></body></html>"
1886
1928
  };
1887
-
1929
+
1888
1930
  CrispClient.website.saveCampaignTemplate(websiteID, templateID, template);
1889
1931
  ```
1890
1932
  </details>
@@ -1897,9 +1939,9 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1897
1939
  ```javascript
1898
1940
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1899
1941
  var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
1900
-
1942
+
1901
1943
  var template = "<html><body><a href=\"{{url.unsubscribe}}\"></a></body></html>";
1902
-
1944
+
1903
1945
  CrispClient.website.updateCampaignTemplate(websiteID, templateID, template);
1904
1946
  ```
1905
1947
  </details>
@@ -1912,7 +1954,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1912
1954
  ```javascript
1913
1955
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1914
1956
  var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
1915
-
1957
+
1916
1958
  CrispClient.website.removeCampaignTemplate(websiteID, templateID);
1917
1959
  ```
1918
1960
  </details>
@@ -1926,12 +1968,12 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1926
1968
 
1927
1969
  ```javascript
1928
1970
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1929
-
1971
+
1930
1972
  var campaignName = {
1931
1973
  "type": "one-shot",
1932
1974
  "name": "Welcome!"
1933
1975
  };
1934
-
1976
+
1935
1977
  CrispClient.website.createNewCampaign(websiteID, campaignType, campaignName);
1936
1978
  ```
1937
1979
  </details>
@@ -1944,7 +1986,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1944
1986
  ```javascript
1945
1987
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1946
1988
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
1947
-
1989
+
1948
1990
  CrispClient.website.checkCampaignExists(websiteID, campaignID);
1949
1991
  ```
1950
1992
  </details>
@@ -1957,7 +1999,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1957
1999
  ```javascript
1958
2000
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1959
2001
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
1960
-
2002
+
1961
2003
  CrispClient.website.getCampaign(websiteID, campaignID);
1962
2004
  ```
1963
2005
  </details>
@@ -1970,7 +2012,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1970
2012
  ```javascript
1971
2013
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1972
2014
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
1973
-
2015
+
1974
2016
  var campaign = {
1975
2017
  "type": "one-shot",
1976
2018
  "format": "markdown",
@@ -1990,7 +2032,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1990
2032
  "tracking": true
1991
2033
  }
1992
2034
  };
1993
-
2035
+
1994
2036
  CrispClient.website.saveCampaign(websiteID, campaignID, campaign);
1995
2037
  ```
1996
2038
  </details>
@@ -2003,11 +2045,11 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2003
2045
  ```javascript
2004
2046
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2005
2047
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2006
-
2048
+
2007
2049
  var campaign = {
2008
2050
  "message": "*Hey there*, welcome on Crisp folks!"
2009
2051
  };
2010
-
2052
+
2011
2053
  CrispClient.website.updateCampaign(websiteID, campaignID, campaign);
2012
2054
  ```
2013
2055
  </details>
@@ -2020,7 +2062,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2020
2062
  ```javascript
2021
2063
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2022
2064
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2023
-
2065
+
2024
2066
  CrispClient.website.removeCampaign(websiteID, campaignID);
2025
2067
  ```
2026
2068
  </details>
@@ -2033,7 +2075,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2033
2075
  ```javascript
2034
2076
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2035
2077
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2036
-
2078
+
2037
2079
  CrispClient.website.dispatchCampaign(websiteID, campaignID);
2038
2080
  ```
2039
2081
  </details>
@@ -2046,7 +2088,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2046
2088
  ```javascript
2047
2089
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2048
2090
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2049
-
2091
+
2050
2092
  CrispClient.website.resumeCampaign(websiteID, campaignID);
2051
2093
  ```
2052
2094
  </details>
@@ -2059,7 +2101,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2059
2101
  ```javascript
2060
2102
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2061
2103
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2062
-
2104
+
2063
2105
  CrispClient.website.pauseCampaign(websiteID, campaignID);
2064
2106
  ```
2065
2107
  </details>
@@ -2072,7 +2114,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2072
2114
  ```javascript
2073
2115
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2074
2116
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2075
-
2117
+
2076
2118
  CrispClient.website.testCampaign(websiteID, campaignID);
2077
2119
  ```
2078
2120
  </details>
@@ -2086,7 +2128,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2086
2128
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2087
2129
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2088
2130
  var pageNumber = 1;
2089
-
2131
+
2090
2132
  CrispClient.website.listCampaignRecipients(websiteID, campaignID, pageNumber);
2091
2133
  ```
2092
2134
  </details>
@@ -2100,7 +2142,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2100
2142
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2101
2143
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2102
2144
  var pageNumber = 1;
2103
-
2145
+
2104
2146
  CrispClient.website.listCampaignStatistics(websiteID, campaignID, action, pageNumber);
2105
2147
  ```
2106
2148
  </details>
@@ -2170,12 +2212,12 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2170
2212
 
2171
2213
  ```javascript
2172
2214
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2173
-
2215
+
2174
2216
  CrispClient.plugin.listSubscriptionsForWebsite(websiteID);
2175
2217
  ```
2176
2218
  </details>
2177
2219
 
2178
- * **Get Subscription Details** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-subscription-details)
2220
+ * **Get Subscription Details** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-subscription-details)
2179
2221
  * `CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID)`
2180
2222
  * <details>
2181
2223
  <summary>See Example</summary>
@@ -2183,7 +2225,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2183
2225
  ```javascript
2184
2226
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2185
2227
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2186
-
2228
+
2187
2229
  CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID);
2188
2230
  ```
2189
2231
  </details>
@@ -2196,9 +2238,9 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2196
2238
  ```javascript
2197
2239
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2198
2240
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2199
-
2241
+
2200
2242
  var pluginID = "98454664-9f7d-4d95-a9ce-f37356f5e65a";
2201
-
2243
+
2202
2244
  CrispClient.plugin.subscribeWebsiteToPlugin(websiteID, pluginID);
2203
2245
  ```
2204
2246
  </details>
@@ -2211,7 +2253,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2211
2253
  ```javascript
2212
2254
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2213
2255
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2214
-
2256
+
2215
2257
  CrispClient.plugin.unsubscribePluginFromWebsite(websiteID, pluginID);
2216
2258
  ```
2217
2259
  </details>
@@ -2224,7 +2266,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2224
2266
  ```javascript
2225
2267
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2226
2268
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2227
-
2269
+
2228
2270
  CrispClient.plugin.getSubscriptionSettings(websiteID, pluginID);
2229
2271
  ```
2230
2272
  </details>
@@ -2237,13 +2279,13 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2237
2279
  ```javascript
2238
2280
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2239
2281
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2240
-
2282
+
2241
2283
  var settings = {
2242
2284
  "chatbox": {
2243
2285
  "25": "#bbbbbb"
2244
2286
  }
2245
2287
  };
2246
-
2288
+
2247
2289
  CrispClient.plugin.saveSubscriptionSettings(websiteID, pluginID, settings);
2248
2290
  ```
2249
2291
  </details>
@@ -2256,13 +2298,13 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2256
2298
  ```javascript
2257
2299
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2258
2300
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2259
-
2301
+
2260
2302
  var settings = {
2261
2303
  "chatbox": {
2262
2304
  "25": "#bbbbbb"
2263
2305
  }
2264
2306
  };
2265
-
2307
+
2266
2308
  CrispClient.plugin.updateSubscriptionSettings(websiteID, pluginID, settings);
2267
2309
  ```
2268
2310
  </details>
@@ -2275,14 +2317,14 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2275
2317
  ```javascript
2276
2318
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2277
2319
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2278
-
2320
+
2279
2321
  var payload = {
2280
2322
  "namespace": "bot:step",
2281
2323
  "payload": {
2282
2324
  "step": 1
2283
2325
  }
2284
2326
  };
2285
-
2327
+
2286
2328
  CrispClient.plugin.forwardPluginPayloadToChannel(websiteID, pluginID, payload);
2287
2329
  ```
2288
2330
  </details>
@@ -2295,7 +2337,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2295
2337
  ```javascript
2296
2338
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2297
2339
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2298
-
2340
+
2299
2341
  var payload = {
2300
2342
  "name": "bot-is-running",
2301
2343
  "data": {
@@ -2303,7 +2345,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2303
2345
  "email": "valerian@crisp.chat"
2304
2346
  }
2305
2347
  };
2306
-
2348
+
2307
2349
  CrispClient.plugin.dispatchPluginEvent(websiteID, pluginID, payload);
2308
2350
  ```
2309
2351
  </details>
@@ -2320,7 +2362,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2320
2362
  ```javascript
2321
2363
  var listID = "f7fb43da-1cd8-49c1-ade0-9f5b71d034e3";
2322
2364
  var pageNumber = 1;
2323
-
2365
+
2324
2366
  CrispClient.media.listAnimationMedias(pageNumber, listID, searchQuery);
2325
2367
  ```
2326
2368
  </details>
@@ -2344,7 +2386,10 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2344
2386
 
2345
2387
  You can bind to realtime events from Crisp, in order to get notified of incoming messages and updates in websites.
2346
2388
 
2347
- You won't receive any event if you don't explicitly subscribe to realtime events using `CrispClient.on()`, as the library doesn't connect to the realtime backend automatically. This method returns a `Promise` object.
2389
+ Before you start with RTM events, please consider the following:
2390
+
2391
+ * You won't receive any event if you don't explicitly subscribe to realtime events using `CrispClient.on()`, as the library doesn't connect to the realtime backend automatically. This method returns a `Promise` object.
2392
+ * Whenever the list of websites that your authentication token is entitled to receive events for changes, you will need to call `CrispClient.rebind()`. This method also returns a `Promise` object.
2348
2393
 
2349
2394
  Available events are listed below:
2350
2395
 
@@ -2371,7 +2416,7 @@ Available events are listed below:
2371
2416
  * `session:set_data`
2372
2417
  * **Session Sync Pages** [`user`, `plugin`]:
2373
2418
  * `session:sync:pages`
2374
- * **Session Sync Events** [`user`, `plugin`]:
2419
+ * **Session Sync Events** [`user`, `plugin`]:
2375
2420
  * `session:sync:events`
2376
2421
  * **Session Sync Capabilities** [`user`, `plugin`]:
2377
2422
  * `session:sync:capabilities`
@@ -2413,6 +2458,8 @@ Available events are listed below:
2413
2458
  * `message:send`
2414
2459
  * **Message Received** [`user`, `plugin`]:
2415
2460
  * `message:received`
2461
+ * **Message Removed** [`user`, `plugin`]:
2462
+ * `message:removed`
2416
2463
  * **Message Compose Send** [`user`, `plugin`]:
2417
2464
  * `message:compose:send`
2418
2465
  * **Message Compose Receive** [`user`, `plugin`]:
@@ -2477,7 +2524,7 @@ Available events are listed below:
2477
2524
  * `website:update_visitors_count`
2478
2525
  * **Website Update Operators Availability** [`user`, `plugin`]:
2479
2526
  * `website:update_operators_availability`
2480
- * **Website Users Available** [`user`, `plugin`]:
2527
+ * **Website Users Available** [`user`, `plugin`]:
2481
2528
  * `website:users:available`
2482
2529
 
2483
2530
  * #### **Bucket Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#bucket-events)
@@ -2507,9 +2554,9 @@ Available events are listed below:
2507
2554
  * `email:track:view`
2508
2555
 
2509
2556
  * #### **Plugin Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#plugin-events)
2510
- * **Plugin Channel** [`user`, `plugin`]:
2557
+ * **Plugin Channel** [`user`, `plugin`]:
2511
2558
  * `plugin:channel`
2512
2559
  * **Plugin Event** [`user`, `plugin`]:
2513
2560
  * `plugin:event`
2514
- * **Plugin Settings Saved** [`user`, `plugin`]:
2561
+ * **Plugin Settings Saved** [`user`, `plugin`]:
2515
2562
  * `plugin:settings:saved`