crisp-api 5.3.0 → 6.2.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: 22/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
@@ -79,7 +79,13 @@ CrispClient.on("message:send", function(message) {
79
79
  .catch(function(error) {
80
80
  console.error("Error sending message:", error);
81
81
  });
82
- });
82
+ })
83
+ .then(function() {
84
+ console.error("Requested to listen to sent messages");
85
+ })
86
+ .catch(function(error) {
87
+ console.error("Failed listening to sent messages:", error);
88
+ });
83
89
  ```
84
90
 
85
91
  ## Resource Methods
@@ -99,7 +105,7 @@ All methods that you will most likely need when building a Crisp integration are
99
105
  <ul>
100
106
  <li><a href="#website-conversations">Website Conversations</a></li>
101
107
  <li><a href="#website-conversation">Website Conversation</a></li>
102
- <li><a href="#website-people">Website People</a></li>
108
+ <li><a href="#website-people-these-are-your-end-users">Website People</a></li>
103
109
  <li><a href="#website-operator">Website Operator</a></li>
104
110
  <li><a href="#website-availability">Website Availability</a></li>
105
111
  <li><a href="#website-analytics">Website Analytics</a></li>
@@ -168,7 +174,7 @@ All methods that you will most likely need when building a Crisp integration are
168
174
  ```javascript
169
175
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
170
176
  var pageNumber = 1;
171
-
177
+
172
178
  CrispClient.website.listConversations(websiteID, pageNumber);
173
179
  ```
174
180
  </details>
@@ -181,7 +187,7 @@ All methods that you will most likely need when building a Crisp integration are
181
187
  ```javascript
182
188
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
183
189
  var pageNumber = 1;
184
-
190
+
185
191
  CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber);
186
192
  ```
187
193
  </details>
@@ -193,9 +199,9 @@ All methods that you will most likely need when building a Crisp integration are
193
199
 
194
200
  ```javascript
195
201
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
196
-
202
+
197
203
  var segment = "bug";
198
-
204
+
199
205
  CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment);
200
206
  ```
201
207
  </details>
@@ -208,7 +214,7 @@ All methods that you will most likely need when building a Crisp integration are
208
214
  ```javascript
209
215
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
210
216
  var pageNumber = 1;
211
-
217
+
212
218
  CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber);
213
219
  ```
214
220
  </details>
@@ -220,9 +226,9 @@ All methods that you will most likely need when building a Crisp integration are
220
226
 
221
227
  ```javascript
222
228
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
223
-
229
+
224
230
  var key = "price";
225
-
231
+
226
232
  CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key);
227
233
  ```
228
234
  </details>
@@ -236,7 +242,7 @@ All methods that you will most likely need when building a Crisp integration are
236
242
 
237
243
  ```javascript
238
244
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
239
-
245
+
240
246
  CrispClient.website.createNewConversation(websiteID);
241
247
  ```
242
248
  </details>
@@ -249,7 +255,7 @@ All methods that you will most likely need when building a Crisp integration are
249
255
  ```javascript
250
256
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
251
257
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
252
-
258
+
253
259
  CrispClient.website.checkConversationExists(websiteID, sessionID);
254
260
  ```
255
261
  </details>
@@ -262,7 +268,7 @@ All methods that you will most likely need when building a Crisp integration are
262
268
  ```javascript
263
269
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
264
270
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
265
-
271
+
266
272
  CrispClient.website.getConversation(websiteID, sessionID);
267
273
  ```
268
274
  </details>
@@ -275,7 +281,7 @@ All methods that you will most likely need when building a Crisp integration are
275
281
  ```javascript
276
282
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
277
283
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
278
-
284
+
279
285
  CrispClient.website.removeConversation(websiteID, sessionID);
280
286
  ```
281
287
  </details>
@@ -288,7 +294,7 @@ All methods that you will most likely need when building a Crisp integration are
288
294
  ```javascript
289
295
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
290
296
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
291
-
297
+
292
298
  CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID);
293
299
  ```
294
300
  </details>
@@ -302,7 +308,7 @@ All methods that you will most likely need when building a Crisp integration are
302
308
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
303
309
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
304
310
  var timestampBefore = 1641206011000;
305
-
311
+
306
312
  CrispClient.website.getMessagesInConversation(websiteID, sessionID, timestampBefore);
307
313
  ```
308
314
  </details>
@@ -315,14 +321,14 @@ All methods that you will most likely need when building a Crisp integration are
315
321
  ```javascript
316
322
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
317
323
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
318
-
324
+
319
325
  var message = {
320
326
  "type": "text",
321
327
  "from": "operator",
322
328
  "origin": "chat",
323
329
  "content": "Hey there! Need help?"
324
330
  };
325
-
331
+
326
332
  CrispClient.website.sendMessageInConversation(websiteID, sessionID, message);
327
333
  ```
328
334
  </details>
@@ -336,7 +342,7 @@ All methods that you will most likely need when building a Crisp integration are
336
342
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
337
343
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
338
344
  var fingerprint = 524653764345;
339
-
345
+
340
346
  CrispClient.website.getMessageInConversation(websiteID, sessionID, fingerprint);
341
347
  ```
342
348
  </details>
@@ -350,13 +356,27 @@ All methods that you will most likely need when building a Crisp integration are
350
356
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
351
357
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
352
358
  var fingerprint = 524653764345;
353
-
359
+
354
360
  var content = "Hey there! Need help?";
355
-
361
+
356
362
  CrispClient.website.updateMessageInConversation(websiteID, sessionID, fingerprint, content);
357
363
  ```
358
364
  </details>
359
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
+
360
380
  * **Compose A Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#compose-a-message-in-conversation)
361
381
  * `CrispClient.website.composeMessageInConversation(websiteID, sessionID, compose)`
362
382
  * <details>
@@ -365,12 +385,12 @@ All methods that you will most likely need when building a Crisp integration are
365
385
  ```javascript
366
386
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
367
387
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
368
-
388
+
369
389
  var compose = {
370
390
  "type": "start",
371
391
  "from": "operator"
372
392
  };
373
-
393
+
374
394
  CrispClient.website.composeMessageInConversation(websiteID, sessionID, compose);
375
395
  ```
376
396
  </details>
@@ -383,7 +403,7 @@ All methods that you will most likely need when building a Crisp integration are
383
403
  ```javascript
384
404
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
385
405
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
386
-
406
+
387
407
  var read = {
388
408
  "from": "operator",
389
409
  "origin": "urn:crisp.im:slack:0",
@@ -391,7 +411,7 @@ All methods that you will most likely need when building a Crisp integration are
391
411
  "5719231201"
392
412
  ]
393
413
  };
394
-
414
+
395
415
  CrispClient.website.markMessagesReadInConversation(websiteID, sessionID, read);
396
416
  ```
397
417
  </details>
@@ -404,7 +424,7 @@ All methods that you will most likely need when building a Crisp integration are
404
424
  ```javascript
405
425
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
406
426
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
407
-
427
+
408
428
  var delivered = {
409
429
  "from": "operator",
410
430
  "origin": "urn:crisp.im:slack:0",
@@ -412,7 +432,7 @@ All methods that you will most likely need when building a Crisp integration are
412
432
  "5719231201"
413
433
  ]
414
434
  };
415
-
435
+
416
436
  CrispClient.website.markMessagesDeliveredInConversation(websiteID, sessionID, delivered);
417
437
  ```
418
438
  </details>
@@ -425,9 +445,9 @@ All methods that you will most likely need when building a Crisp integration are
425
445
  ```javascript
426
446
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
427
447
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
428
-
448
+
429
449
  var opened = true;
430
-
450
+
431
451
  CrispClient.website.updateConversationOpenState(websiteID, sessionID, opened);
432
452
  ```
433
453
  </details>
@@ -440,7 +460,7 @@ All methods that you will most likely need when building a Crisp integration are
440
460
  ```javascript
441
461
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
442
462
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
443
-
463
+
444
464
  CrispClient.website.getConversationRoutingAssign(websiteID, sessionID);
445
465
  ```
446
466
  </details>
@@ -453,13 +473,13 @@ All methods that you will most likely need when building a Crisp integration are
453
473
  ```javascript
454
474
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
455
475
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
456
-
476
+
457
477
  var assign = {
458
478
  "assigned": {
459
479
  "user_id": "a4c32c68-be91-4e29-8a05-976e93abbe3f"
460
480
  }
461
481
  };
462
-
482
+
463
483
  CrispClient.website.assignConversationRouting(websiteID, sessionID, assign);
464
484
  ```
465
485
  </details>
@@ -472,7 +492,7 @@ All methods that you will most likely need when building a Crisp integration are
472
492
  ```javascript
473
493
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
474
494
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
475
-
495
+
476
496
  CrispClient.website.getConversationMetas(websiteID, sessionID);
477
497
  ```
478
498
  </details>
@@ -485,7 +505,7 @@ All methods that you will most likely need when building a Crisp integration are
485
505
  ```javascript
486
506
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
487
507
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
488
-
508
+
489
509
  var metas = {
490
510
  "nickname": "John Doe",
491
511
  "email": "john.doe@acme-inc.com",
@@ -499,7 +519,7 @@ All methods that you will most likely need when building a Crisp integration are
499
519
  "signup": "finished"
500
520
  }
501
521
  };
502
-
522
+
503
523
  CrispClient.website.updateConversationMetas(websiteID, sessionID, metas);
504
524
  ```
505
525
  </details>
@@ -513,7 +533,7 @@ All methods that you will most likely need when building a Crisp integration are
513
533
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
514
534
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
515
535
  var originalID = "2325a3c0-9b47-4fc6-b00e-111b752e44cd";
516
-
536
+
517
537
  CrispClient.website.getOriginalMessageInConversation(websiteID, sessionID, originalID);
518
538
  ```
519
539
  </details>
@@ -527,7 +547,7 @@ All methods that you will most likely need when building a Crisp integration are
527
547
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
528
548
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
529
549
  var pageNumber = 1;
530
-
550
+
531
551
  CrispClient.website.listConversationPages(websiteID, sessionID, pageNumber);
532
552
  ```
533
553
  </details>
@@ -541,7 +561,7 @@ All methods that you will most likely need when building a Crisp integration are
541
561
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
542
562
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
543
563
  var pageNumber = 1;
544
-
564
+
545
565
  CrispClient.website.listConversationEvents(websiteID, sessionID, pageNumber);
546
566
  ```
547
567
  </details>
@@ -554,7 +574,7 @@ All methods that you will most likely need when building a Crisp integration are
554
574
  ```javascript
555
575
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
556
576
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
557
-
577
+
558
578
  CrispClient.website.getConversationState(websiteID, sessionID);
559
579
  ```
560
580
  </details>
@@ -567,9 +587,9 @@ All methods that you will most likely need when building a Crisp integration are
567
587
  ```javascript
568
588
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
569
589
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
570
-
590
+
571
591
  var state = "unresolved";
572
-
592
+
573
593
  CrispClient.website.changeConversationState(websiteID, sessionID, state);
574
594
  ```
575
595
  </details>
@@ -582,7 +602,7 @@ All methods that you will most likely need when building a Crisp integration are
582
602
  ```javascript
583
603
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
584
604
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
585
-
605
+
586
606
  CrispClient.website.getConversationParticipants(websiteID, sessionID);
587
607
  ```
588
608
  </details>
@@ -595,7 +615,7 @@ All methods that you will most likely need when building a Crisp integration are
595
615
  ```javascript
596
616
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
597
617
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
598
-
618
+
599
619
  var participants = {
600
620
  "participants": [
601
621
  {
@@ -604,7 +624,7 @@ All methods that you will most likely need when building a Crisp integration are
604
624
  }
605
625
  ]
606
626
  };
607
-
627
+
608
628
  CrispClient.website.saveConversationParticipants(websiteID, sessionID, participants);
609
629
  ```
610
630
  </details>
@@ -617,7 +637,7 @@ All methods that you will most likely need when building a Crisp integration are
617
637
  ```javascript
618
638
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
619
639
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
620
-
640
+
621
641
  CrispClient.website.getBlockStatusForConversation(websiteID, sessionID);
622
642
  ```
623
643
  </details>
@@ -630,13 +650,41 @@ All methods that you will most likely need when building a Crisp integration are
630
650
  ```javascript
631
651
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
632
652
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
633
-
653
+
634
654
  var blocked = true;
635
-
655
+
636
656
  CrispClient.website.blockIncomingMessagesForConversation(websiteID, sessionID, blocked);
637
657
  ```
638
658
  </details>
639
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
+
640
688
  * **Request Email Transcript For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-email-transcript-for-conversation)
641
689
  * `CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email)`
642
690
  * <details>
@@ -645,12 +693,12 @@ All methods that you will most likely need when building a Crisp integration are
645
693
  ```javascript
646
694
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
647
695
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
648
-
696
+
649
697
  var email = {
650
698
  "to": "operator",
651
699
  "email": "valerian@crisp.chat"
652
700
  };
653
-
701
+
654
702
  CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email);
655
703
  ```
656
704
  </details>
@@ -663,7 +711,7 @@ All methods that you will most likely need when building a Crisp integration are
663
711
  ```javascript
664
712
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
665
713
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
666
-
714
+
667
715
  CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID);
668
716
  ```
669
717
  </details>
@@ -676,7 +724,7 @@ All methods that you will most likely need when building a Crisp integration are
676
724
  ```javascript
677
725
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
678
726
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
679
-
727
+
680
728
  CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID);
681
729
  ```
682
730
  </details>
@@ -689,7 +737,7 @@ All methods that you will most likely need when building a Crisp integration are
689
737
  ```javascript
690
738
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
691
739
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
692
-
740
+
693
741
  CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID);
694
742
  ```
695
743
  </details>
@@ -703,9 +751,9 @@ All methods that you will most likely need when building a Crisp integration are
703
751
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
704
752
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
705
753
  var browsingID = "browsing_05a9392d-ff3f-45e7-b021-1179c45668fa";
706
-
754
+
707
755
  var action = "start";
708
-
756
+
709
757
  CrispClient.website.sendActionToExistingBrowsingSession(websiteID, sessionID, browsingID, action);
710
758
  ```
711
759
  </details>
@@ -719,7 +767,7 @@ All methods that you will most likely need when building a Crisp integration are
719
767
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
720
768
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
721
769
  var browsingID = "browsing_05a9392d-ff3f-45e7-b021-1179c45668fa";
722
-
770
+
723
771
  var assist = {
724
772
  "action": "mouse",
725
773
  "mouse": {
@@ -727,7 +775,7 @@ All methods that you will most likely need when building a Crisp integration are
727
775
  "y": 784
728
776
  }
729
777
  };
730
-
778
+
731
779
  CrispClient.website.assistExistingBrowsingSession(websiteID, sessionID, browsingID, assist);
732
780
  ```
733
781
  </details>
@@ -740,9 +788,9 @@ All methods that you will most likely need when building a Crisp integration are
740
788
  ```javascript
741
789
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
742
790
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
743
-
791
+
744
792
  var mode = "audio";
745
-
793
+
746
794
  CrispClient.website.initiateNewCallSessionForConversation(websiteID, sessionID, mode);
747
795
  ```
748
796
  </details>
@@ -755,7 +803,7 @@ All methods that you will most likely need when building a Crisp integration are
755
803
  ```javascript
756
804
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
757
805
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
758
-
806
+
759
807
  CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID);
760
808
  ```
761
809
  </details>
@@ -769,7 +817,7 @@ All methods that you will most likely need when building a Crisp integration are
769
817
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
770
818
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
771
819
  var callID = "call_35a0c062-72fa-4095-a2a0-f9911d47ee56";
772
-
820
+
773
821
  CrispClient.website.abortOngoingCallSessionForConversation(websiteID, sessionID, callID);
774
822
  ```
775
823
  </details>
@@ -783,12 +831,12 @@ All methods that you will most likely need when building a Crisp integration are
783
831
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
784
832
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
785
833
  var callID = "call_35a0c062-72fa-4095-a2a0-f9911d47ee56";
786
-
834
+
787
835
  var payload = {
788
836
  "type": "sdp",
789
837
  "payload": {}
790
838
  };
791
-
839
+
792
840
  CrispClient.website.transmitSignalingOnOngoingCallSession(websiteID, sessionID, callID, payload);
793
841
  ```
794
842
  </details>
@@ -804,7 +852,7 @@ All methods that you will most likely need when building a Crisp integration are
804
852
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
805
853
  var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292";
806
854
  var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785";
807
-
855
+
808
856
  var value = {
809
857
  "section_id": "payments",
810
858
  "item_id": "refund_on_stripe",
@@ -812,7 +860,7 @@ All methods that you will most likely need when building a Crisp integration are
812
860
  "invoice": "D-1929-X"
813
861
  }
814
862
  };
815
-
863
+
816
864
  CrispClient.website.deliverWidgetButtonActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data, value);
817
865
  ```
818
866
  </details>
@@ -828,14 +876,14 @@ All methods that you will most likely need when building a Crisp integration are
828
876
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
829
877
  var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292";
830
878
  var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785";
831
-
879
+
832
880
  var data = {
833
881
  "section_id": "payments",
834
882
  "item_id": "unpaid_balance",
835
883
  "action": "fetch",
836
884
  "data": {}
837
885
  };
838
-
886
+
839
887
  CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data);
840
888
  ```
841
889
  </details>
@@ -851,14 +899,14 @@ All methods that you will most likely need when building a Crisp integration are
851
899
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
852
900
  var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292";
853
901
  var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785";
854
-
902
+
855
903
  var data = {
856
904
  "section_id": "payments",
857
905
  "item_id": "unpaid_balance",
858
906
  "action": "fetch",
859
907
  "data": {}
860
908
  };
861
-
909
+
862
910
  CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data);
863
911
  ```
864
912
  </details>
@@ -871,12 +919,12 @@ All methods that you will most likely need when building a Crisp integration are
871
919
  ```javascript
872
920
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
873
921
  var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
874
-
922
+
875
923
  var note = {
876
924
  "date": "2018-05-29T09:00:00Z",
877
925
  "note": "Call this customer."
878
926
  };
879
-
927
+
880
928
  CrispClient.website.scheduleReminderForConversation(websiteID, sessionID, date, note);
881
929
  ```
882
930
  </details>
@@ -890,7 +938,7 @@ All methods that you will most likely need when building a Crisp integration are
890
938
 
891
939
  ```javascript
892
940
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
893
-
941
+
894
942
  CrispClient.website.getPeopleStatistics(websiteID);
895
943
  ```
896
944
  </details>
@@ -903,7 +951,7 @@ All methods that you will most likely need when building a Crisp integration are
903
951
  ```javascript
904
952
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
905
953
  var pageNumber = 1;
906
-
954
+
907
955
  CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber);
908
956
  ```
909
957
  </details>
@@ -915,9 +963,9 @@ All methods that you will most likely need when building a Crisp integration are
915
963
 
916
964
  ```javascript
917
965
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
918
-
966
+
919
967
  var segment = "poweruser";
920
-
968
+
921
969
  CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment);
922
970
  ```
923
971
  </details>
@@ -931,9 +979,9 @@ All methods that you will most likely need when building a Crisp integration are
931
979
 
932
980
  ```javascript
933
981
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
934
-
982
+
935
983
  var key = "price";
936
-
984
+
937
985
  CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key);
938
986
  ```
939
987
  </details>
@@ -946,7 +994,7 @@ All methods that you will most likely need when building a Crisp integration are
946
994
  ```javascript
947
995
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
948
996
  var pageNumber = 1;
949
-
997
+
950
998
  CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber);
951
999
  ```
952
1000
  </details>
@@ -958,9 +1006,9 @@ All methods that you will most likely need when building a Crisp integration are
958
1006
 
959
1007
  ```javascript
960
1008
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
961
-
1009
+
962
1010
  var text = "Removed item from basket";
963
-
1011
+
964
1012
  CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text);
965
1013
  ```
966
1014
  </details>
@@ -973,7 +1021,7 @@ All methods that you will most likely need when building a Crisp integration are
973
1021
  ```javascript
974
1022
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
975
1023
  var pageNumber = 1;
976
-
1024
+
977
1025
  CrispClient.website.listPeopleProfiles(websiteID, pageNumber, searchField, searchOrder, searchOperator, searchFilter, searchText);
978
1026
  ```
979
1027
  </details>
@@ -985,14 +1033,14 @@ All methods that you will most likely need when building a Crisp integration are
985
1033
 
986
1034
  ```javascript
987
1035
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
988
-
1036
+
989
1037
  var peopleProfile = {
990
1038
  "email": "valerian@crisp.chat",
991
1039
  "person": {
992
1040
  "nickname": "Valerian Saliou"
993
1041
  }
994
1042
  };
995
-
1043
+
996
1044
  CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile);
997
1045
  ```
998
1046
  </details>
@@ -1005,7 +1053,7 @@ All methods that you will most likely need when building a Crisp integration are
1005
1053
  ```javascript
1006
1054
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1007
1055
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1008
-
1056
+
1009
1057
  CrispClient.website.checkPeopleProfileExists(websiteID, peopleID);
1010
1058
  ```
1011
1059
  </details>
@@ -1018,7 +1066,7 @@ All methods that you will most likely need when building a Crisp integration are
1018
1066
  ```javascript
1019
1067
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1020
1068
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1021
-
1069
+
1022
1070
  CrispClient.website.getPeopleProfile(websiteID, peopleID);
1023
1071
  ```
1024
1072
  </details>
@@ -1031,14 +1079,14 @@ All methods that you will most likely need when building a Crisp integration are
1031
1079
  ```javascript
1032
1080
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1033
1081
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1034
-
1082
+
1035
1083
  var peopleProfile = {
1036
1084
  "email": "valerian@crisp.chat",
1037
1085
  "person": {
1038
1086
  "nickname": "Valerian Saliou"
1039
1087
  }
1040
1088
  };
1041
-
1089
+
1042
1090
  CrispClient.website.savePeopleProfile(websiteID, peopleID, peopleProfile);
1043
1091
  ```
1044
1092
  </details>
@@ -1051,14 +1099,14 @@ All methods that you will most likely need when building a Crisp integration are
1051
1099
  ```javascript
1052
1100
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1053
1101
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1054
-
1102
+
1055
1103
  var peopleProfile = {
1056
1104
  "email": "valerian@crisp.chat",
1057
1105
  "person": {
1058
1106
  "nickname": "Valerian Saliou"
1059
1107
  }
1060
1108
  };
1061
-
1109
+
1062
1110
  CrispClient.website.updatePeopleProfile(websiteID, peopleID, peopleProfile);
1063
1111
  ```
1064
1112
  </details>
@@ -1071,7 +1119,7 @@ All methods that you will most likely need when building a Crisp integration are
1071
1119
  ```javascript
1072
1120
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1073
1121
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1074
-
1122
+
1075
1123
  CrispClient.website.removePeopleProfile(websiteID, peopleID);
1076
1124
  ```
1077
1125
  </details>
@@ -1085,7 +1133,7 @@ All methods that you will most likely need when building a Crisp integration are
1085
1133
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1086
1134
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1087
1135
  var pageNumber = 1;
1088
-
1136
+
1089
1137
  CrispClient.website.listPeopleConversations(websiteID, peopleID, pageNumber);
1090
1138
  ```
1091
1139
  </details>
@@ -1099,7 +1147,7 @@ All methods that you will most likely need when building a Crisp integration are
1099
1147
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1100
1148
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1101
1149
  var pageNumber = 1;
1102
-
1150
+
1103
1151
  CrispClient.website.listPeopleCampaigns(websiteID, peopleID, pageNumber);
1104
1152
  ```
1105
1153
  </details>
@@ -1112,7 +1160,7 @@ All methods that you will most likely need when building a Crisp integration are
1112
1160
  ```javascript
1113
1161
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1114
1162
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1115
-
1163
+
1116
1164
  var peopleEvent = {
1117
1165
  "text": "Added item to basket",
1118
1166
  "data": {
@@ -1121,7 +1169,7 @@ All methods that you will most likely need when building a Crisp integration are
1121
1169
  },
1122
1170
  "color": "red"
1123
1171
  };
1124
-
1172
+
1125
1173
  CrispClient.website.addPeopleEvent(websiteID, peopleID, peopleEvent);
1126
1174
  ```
1127
1175
  </details>
@@ -1135,7 +1183,7 @@ All methods that you will most likely need when building a Crisp integration are
1135
1183
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1136
1184
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1137
1185
  var pageNumber = 1;
1138
-
1186
+
1139
1187
  CrispClient.website.listPeopleEvents(websiteID, peopleID, pageNumber);
1140
1188
  ```
1141
1189
  </details>
@@ -1148,7 +1196,7 @@ All methods that you will most likely need when building a Crisp integration are
1148
1196
  ```javascript
1149
1197
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1150
1198
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1151
-
1199
+
1152
1200
  CrispClient.website.getPeopleData(websiteID, peopleID);
1153
1201
  ```
1154
1202
  </details>
@@ -1161,14 +1209,14 @@ All methods that you will most likely need when building a Crisp integration are
1161
1209
  ```javascript
1162
1210
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1163
1211
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1164
-
1212
+
1165
1213
  var peopleData = {
1166
1214
  "data": {
1167
1215
  "type": "customer",
1168
1216
  "signup": "finished"
1169
1217
  }
1170
1218
  };
1171
-
1219
+
1172
1220
  CrispClient.website.savePeopleData(websiteID, peopleID, peopleData);
1173
1221
  ```
1174
1222
  </details>
@@ -1181,13 +1229,13 @@ All methods that you will most likely need when building a Crisp integration are
1181
1229
  ```javascript
1182
1230
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1183
1231
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1184
-
1232
+
1185
1233
  var peopleData = {
1186
1234
  "data": {
1187
1235
  "signup": "finished"
1188
1236
  }
1189
1237
  };
1190
-
1238
+
1191
1239
  CrispClient.website.updatePeopleData(websiteID, peopleID, peopleData);
1192
1240
  ```
1193
1241
  </details>
@@ -1200,7 +1248,7 @@ All methods that you will most likely need when building a Crisp integration are
1200
1248
  ```javascript
1201
1249
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1202
1250
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1203
-
1251
+
1204
1252
  CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID);
1205
1253
  ```
1206
1254
  </details>
@@ -1213,11 +1261,11 @@ All methods that you will most likely need when building a Crisp integration are
1213
1261
  ```javascript
1214
1262
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1215
1263
  var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1216
-
1264
+
1217
1265
  var peopleSubscription = {
1218
1266
  "email": true
1219
1267
  };
1220
-
1268
+
1221
1269
  CrispClient.website.updatePeopleSubscriptionStatus(websiteID, peopleID, peopleSubscription);
1222
1270
  ```
1223
1271
  </details>
@@ -1229,7 +1277,7 @@ All methods that you will most likely need when building a Crisp integration are
1229
1277
 
1230
1278
  ```javascript
1231
1279
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1232
-
1280
+
1233
1281
  CrispClient.website.exportPeopleProfiles(websiteID);
1234
1282
  ```
1235
1283
  </details>
@@ -1241,7 +1289,7 @@ All methods that you will most likely need when building a Crisp integration are
1241
1289
 
1242
1290
  ```javascript
1243
1291
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1244
-
1292
+
1245
1293
  var profileImportSetup = {
1246
1294
  "url": "https://storage.crisp.chat/users/processing/import/aa0b64dd-9fb4-4db9-80d6-5a49eb84087b/19d956c7-0294-45ad-89e1-58ce45e7008f.csv",
1247
1295
  "mapping": [
@@ -1259,7 +1307,7 @@ All methods that you will most likely need when building a Crisp integration are
1259
1307
  "skip_header": true
1260
1308
  }
1261
1309
  };
1262
-
1310
+
1263
1311
  CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup);
1264
1312
  ```
1265
1313
  </details>
@@ -1295,7 +1343,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1295
1343
 
1296
1344
  ```javascript
1297
1345
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1298
-
1346
+
1299
1347
  CrispClient.website.getWebsite(websiteID);
1300
1348
  ```
1301
1349
  </details>
@@ -1307,9 +1355,9 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1307
1355
 
1308
1356
  ```javascript
1309
1357
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1310
-
1358
+
1311
1359
  var verify = "MySuperSecurePassword";
1312
-
1360
+
1313
1361
  CrispClient.website.deleteWebsite(websiteID, verify);
1314
1362
  ```
1315
1363
  </details>
@@ -1323,7 +1371,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1323
1371
 
1324
1372
  ```javascript
1325
1373
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1326
-
1374
+
1327
1375
  CrispClient.website.getWebsiteSettings(websiteID);
1328
1376
  ```
1329
1377
  </details>
@@ -1335,7 +1383,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1335
1383
 
1336
1384
  ```javascript
1337
1385
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1338
-
1386
+
1339
1387
  var settings = {
1340
1388
  "name": "Crisp",
1341
1389
  "domain": "crisp.chat",
@@ -1400,7 +1448,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1400
1448
  ]
1401
1449
  }
1402
1450
  };
1403
-
1451
+
1404
1452
  CrispClient.website.updateWebsiteSettings(websiteID, settings);
1405
1453
  ```
1406
1454
  </details>
@@ -1414,7 +1462,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1414
1462
 
1415
1463
  ```javascript
1416
1464
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1417
-
1465
+
1418
1466
  CrispClient.website.listWebsiteOperators(websiteID);
1419
1467
  ```
1420
1468
  </details>
@@ -1426,7 +1474,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1426
1474
 
1427
1475
  ```javascript
1428
1476
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1429
-
1477
+
1430
1478
  CrispClient.website.listLastActiveWebsiteOperators(websiteID);
1431
1479
  ```
1432
1480
  </details>
@@ -1438,7 +1486,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1438
1486
 
1439
1487
  ```javascript
1440
1488
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1441
-
1489
+
1442
1490
  CrispClient.website.flushLastActiveWebsiteOperators(websiteID);
1443
1491
  ```
1444
1492
  </details>
@@ -1450,13 +1498,13 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1450
1498
 
1451
1499
  ```javascript
1452
1500
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1453
-
1501
+
1454
1502
  var emailData = {
1455
1503
  "recipient": "owners",
1456
1504
  "subject": "Plugin limits reached",
1457
1505
  "message": "Hi, you've reached the Slack plugin limits. Please contact our support team."
1458
1506
  };
1459
-
1507
+
1460
1508
  CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData);
1461
1509
  ```
1462
1510
  </details>
@@ -1469,7 +1517,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1469
1517
  ```javascript
1470
1518
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1471
1519
  var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
1472
-
1520
+
1473
1521
  CrispClient.website.getWebsiteOperator(websiteID, userID);
1474
1522
  ```
1475
1523
  </details>
@@ -1481,13 +1529,13 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1481
1529
 
1482
1530
  ```javascript
1483
1531
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1484
-
1532
+
1485
1533
  var verify = {
1486
1534
  "email": "julien@crisp.chat",
1487
1535
  "role": "member",
1488
1536
  "verify": "MySuperSecurePassword"
1489
1537
  };
1490
-
1538
+
1491
1539
  CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify);
1492
1540
  ```
1493
1541
  </details>
@@ -1500,12 +1548,12 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1500
1548
  ```javascript
1501
1549
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1502
1550
  var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
1503
-
1551
+
1504
1552
  var title = {
1505
1553
  "role": "owner",
1506
1554
  "title": "CTO"
1507
1555
  };
1508
-
1556
+
1509
1557
  CrispClient.website.changeOperatorMembership(websiteID, userID, role, title);
1510
1558
  ```
1511
1559
  </details>
@@ -1518,7 +1566,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1518
1566
  ```javascript
1519
1567
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1520
1568
  var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
1521
-
1569
+
1522
1570
  CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID);
1523
1571
  ```
1524
1572
  </details>
@@ -1532,7 +1580,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1532
1580
 
1533
1581
  ```javascript
1534
1582
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1535
-
1583
+
1536
1584
  CrispClient.website.countVisitors(websiteID);
1537
1585
  ```
1538
1586
  </details>
@@ -1545,7 +1593,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1545
1593
  ```javascript
1546
1594
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1547
1595
  var pageNumber = 1;
1548
-
1596
+
1549
1597
  CrispClient.website.listVisitors(websiteID, pageNumber);
1550
1598
  ```
1551
1599
  </details>
@@ -1557,7 +1605,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1557
1605
 
1558
1606
  ```javascript
1559
1607
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1560
-
1608
+
1561
1609
  CrispClient.website.pinpointVisitorsOnMap(websiteID, centerLongitude, centerLatitude, centerRadius);
1562
1610
  ```
1563
1611
  </details>
@@ -1570,7 +1618,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1570
1618
  ```javascript
1571
1619
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1572
1620
  var tokenID = "d3c17241-1327-47d7-9d8e-b89ff7bd2904";
1573
-
1621
+
1574
1622
  CrispClient.website.getSessionIdentifierFromToken(websiteID, tokenID);
1575
1623
  ```
1576
1624
  </details>
@@ -1584,7 +1632,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1584
1632
 
1585
1633
  ```javascript
1586
1634
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1587
-
1635
+
1588
1636
  CrispClient.website.countBlockedVisitorsInRule(websiteID, rule);
1589
1637
  ```
1590
1638
  </details>
@@ -1596,7 +1644,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1596
1644
 
1597
1645
  ```javascript
1598
1646
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1599
-
1647
+
1600
1648
  CrispClient.website.clearBlockedVisitorsInRule(websiteID, rule);
1601
1649
  ```
1602
1650
  </details>
@@ -1610,7 +1658,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1610
1658
 
1611
1659
  ```javascript
1612
1660
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1613
-
1661
+
1614
1662
  CrispClient.website.getWebsiteAvailabilityStatus(websiteID);
1615
1663
  ```
1616
1664
  </details>
@@ -1622,7 +1670,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1622
1670
 
1623
1671
  ```javascript
1624
1672
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1625
-
1673
+
1626
1674
  CrispClient.website.listWebsiteOperatorAvailabilities(websiteID);
1627
1675
  ```
1628
1676
  </details>
@@ -1636,7 +1684,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1636
1684
 
1637
1685
  ```javascript
1638
1686
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1639
-
1687
+
1640
1688
  CrispClient.website.acquireAnalyticsPoints(websiteID, pointType, pointMetric, dateFrom, dateTo, dateSplit, classifier, filterPrimary, filterSecondary, filterTertiary);
1641
1689
  ```
1642
1690
  </details>
@@ -1649,7 +1697,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1649
1697
  ```javascript
1650
1698
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1651
1699
  var pageNumber = 1;
1652
-
1700
+
1653
1701
  CrispClient.website.listAnalyticsFilters(websiteID, pageNumber, pointType, pointMetric, dateFrom, dateTo);
1654
1702
  ```
1655
1703
  </details>
@@ -1662,7 +1710,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1662
1710
  ```javascript
1663
1711
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1664
1712
  var pageNumber = 1;
1665
-
1713
+
1666
1714
  CrispClient.website.listAnalyticsClassifiers(websiteID, pageNumber, pointType, pointMetric, dateFrom, dateTo);
1667
1715
  ```
1668
1716
  </details>
@@ -1676,7 +1724,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1676
1724
 
1677
1725
  ```javascript
1678
1726
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1679
-
1727
+
1680
1728
  CrispClient.website.batchResolveConversations(websiteID, sessions);
1681
1729
  ```
1682
1730
  </details>
@@ -1688,7 +1736,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1688
1736
 
1689
1737
  ```javascript
1690
1738
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1691
-
1739
+
1692
1740
  CrispClient.website.batchReadConversations(websiteID, sessions);
1693
1741
  ```
1694
1742
  </details>
@@ -1700,12 +1748,12 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1700
1748
 
1701
1749
  ```javascript
1702
1750
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1703
-
1751
+
1704
1752
  var sessions = [
1705
1753
  "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
1706
1754
  "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
1707
1755
  ];
1708
-
1756
+
1709
1757
  CrispClient.website.batchRemoveConversations(websiteID, sessions);
1710
1758
  ```
1711
1759
  </details>
@@ -1717,12 +1765,12 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1717
1765
 
1718
1766
  ```javascript
1719
1767
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1720
-
1768
+
1721
1769
  var sessions = [
1722
1770
  "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
1723
1771
  "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
1724
1772
  ];
1725
-
1773
+
1726
1774
  CrispClient.website.batchRemoveConversations(websiteID, sessions);
1727
1775
  ```
1728
1776
  </details>
@@ -1736,7 +1784,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1736
1784
 
1737
1785
  ```javascript
1738
1786
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1739
-
1787
+
1740
1788
  CrispClient.website.getVerifySettings(websiteID);
1741
1789
  ```
1742
1790
  </details>
@@ -1748,11 +1796,11 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1748
1796
 
1749
1797
  ```javascript
1750
1798
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1751
-
1799
+
1752
1800
  var settings = {
1753
1801
  "enabled": true
1754
1802
  };
1755
-
1803
+
1756
1804
  CrispClient.website.updateVerifySettings(websiteID, settings);
1757
1805
  ```
1758
1806
  </details>
@@ -1764,7 +1812,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1764
1812
 
1765
1813
  ```javascript
1766
1814
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1767
-
1815
+
1768
1816
  CrispClient.website.getVerifyKey(websiteID);
1769
1817
  ```
1770
1818
  </details>
@@ -1776,7 +1824,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1776
1824
 
1777
1825
  ```javascript
1778
1826
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1779
-
1827
+
1780
1828
  CrispClient.website.rollVerifyKey(websiteID);
1781
1829
  ```
1782
1830
  </details>
@@ -1791,7 +1839,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1791
1839
  ```javascript
1792
1840
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1793
1841
  var pageNumber = 1;
1794
-
1842
+
1795
1843
  CrispClient.website.listCampaigns(websiteID, pageNumber);
1796
1844
  ```
1797
1845
  </details>
@@ -1803,7 +1851,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1803
1851
 
1804
1852
  ```javascript
1805
1853
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1806
-
1854
+
1807
1855
  CrispClient.website.listCampaignTags(websiteID);
1808
1856
  ```
1809
1857
  </details>
@@ -1816,7 +1864,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1816
1864
  ```javascript
1817
1865
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1818
1866
  var pageNumber = 1;
1819
-
1867
+
1820
1868
  CrispClient.website.listCampaignTemplates(websiteID, pageNumber);
1821
1869
  ```
1822
1870
  </details>
@@ -1828,12 +1876,12 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1828
1876
 
1829
1877
  ```javascript
1830
1878
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1831
-
1879
+
1832
1880
  var templateName = {
1833
1881
  "name": "HTML Template",
1834
1882
  "format": "html"
1835
1883
  };
1836
-
1884
+
1837
1885
  CrispClient.website.createNewCampaignTemplate(websiteID, templateFormat, templateName);
1838
1886
  ```
1839
1887
  </details>
@@ -1846,7 +1894,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1846
1894
  ```javascript
1847
1895
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1848
1896
  var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
1849
-
1897
+
1850
1898
  CrispClient.website.checkCampaignTemplateExists(websiteID, templateID);
1851
1899
  ```
1852
1900
  </details>
@@ -1859,7 +1907,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1859
1907
  ```javascript
1860
1908
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1861
1909
  var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
1862
-
1910
+
1863
1911
  CrispClient.website.getCampaignTemplate(websiteID, templateID);
1864
1912
  ```
1865
1913
  </details>
@@ -1872,13 +1920,13 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1872
1920
  ```javascript
1873
1921
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1874
1922
  var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
1875
-
1923
+
1876
1924
  var template = {
1877
1925
  "name": "HTML Template",
1878
1926
  "format": "html",
1879
1927
  "content": "<html><body><a href=\"{{url.unsubscribe}}\"></a></body></html>"
1880
1928
  };
1881
-
1929
+
1882
1930
  CrispClient.website.saveCampaignTemplate(websiteID, templateID, template);
1883
1931
  ```
1884
1932
  </details>
@@ -1891,9 +1939,9 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1891
1939
  ```javascript
1892
1940
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1893
1941
  var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
1894
-
1942
+
1895
1943
  var template = "<html><body><a href=\"{{url.unsubscribe}}\"></a></body></html>";
1896
-
1944
+
1897
1945
  CrispClient.website.updateCampaignTemplate(websiteID, templateID, template);
1898
1946
  ```
1899
1947
  </details>
@@ -1906,7 +1954,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1906
1954
  ```javascript
1907
1955
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1908
1956
  var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
1909
-
1957
+
1910
1958
  CrispClient.website.removeCampaignTemplate(websiteID, templateID);
1911
1959
  ```
1912
1960
  </details>
@@ -1920,12 +1968,12 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1920
1968
 
1921
1969
  ```javascript
1922
1970
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1923
-
1971
+
1924
1972
  var campaignName = {
1925
1973
  "type": "one-shot",
1926
1974
  "name": "Welcome!"
1927
1975
  };
1928
-
1976
+
1929
1977
  CrispClient.website.createNewCampaign(websiteID, campaignType, campaignName);
1930
1978
  ```
1931
1979
  </details>
@@ -1938,7 +1986,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1938
1986
  ```javascript
1939
1987
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1940
1988
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
1941
-
1989
+
1942
1990
  CrispClient.website.checkCampaignExists(websiteID, campaignID);
1943
1991
  ```
1944
1992
  </details>
@@ -1951,7 +1999,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1951
1999
  ```javascript
1952
2000
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1953
2001
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
1954
-
2002
+
1955
2003
  CrispClient.website.getCampaign(websiteID, campaignID);
1956
2004
  ```
1957
2005
  </details>
@@ -1964,7 +2012,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1964
2012
  ```javascript
1965
2013
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1966
2014
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
1967
-
2015
+
1968
2016
  var campaign = {
1969
2017
  "type": "one-shot",
1970
2018
  "format": "markdown",
@@ -1984,7 +2032,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1984
2032
  "tracking": true
1985
2033
  }
1986
2034
  };
1987
-
2035
+
1988
2036
  CrispClient.website.saveCampaign(websiteID, campaignID, campaign);
1989
2037
  ```
1990
2038
  </details>
@@ -1997,11 +2045,11 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
1997
2045
  ```javascript
1998
2046
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1999
2047
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2000
-
2048
+
2001
2049
  var campaign = {
2002
2050
  "message": "*Hey there*, welcome on Crisp folks!"
2003
2051
  };
2004
-
2052
+
2005
2053
  CrispClient.website.updateCampaign(websiteID, campaignID, campaign);
2006
2054
  ```
2007
2055
  </details>
@@ -2014,7 +2062,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2014
2062
  ```javascript
2015
2063
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2016
2064
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2017
-
2065
+
2018
2066
  CrispClient.website.removeCampaign(websiteID, campaignID);
2019
2067
  ```
2020
2068
  </details>
@@ -2027,7 +2075,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2027
2075
  ```javascript
2028
2076
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2029
2077
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2030
-
2078
+
2031
2079
  CrispClient.website.dispatchCampaign(websiteID, campaignID);
2032
2080
  ```
2033
2081
  </details>
@@ -2040,7 +2088,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2040
2088
  ```javascript
2041
2089
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2042
2090
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2043
-
2091
+
2044
2092
  CrispClient.website.resumeCampaign(websiteID, campaignID);
2045
2093
  ```
2046
2094
  </details>
@@ -2053,7 +2101,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2053
2101
  ```javascript
2054
2102
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2055
2103
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2056
-
2104
+
2057
2105
  CrispClient.website.pauseCampaign(websiteID, campaignID);
2058
2106
  ```
2059
2107
  </details>
@@ -2066,7 +2114,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2066
2114
  ```javascript
2067
2115
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2068
2116
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2069
-
2117
+
2070
2118
  CrispClient.website.testCampaign(websiteID, campaignID);
2071
2119
  ```
2072
2120
  </details>
@@ -2080,7 +2128,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2080
2128
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2081
2129
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2082
2130
  var pageNumber = 1;
2083
-
2131
+
2084
2132
  CrispClient.website.listCampaignRecipients(websiteID, campaignID, pageNumber);
2085
2133
  ```
2086
2134
  </details>
@@ -2094,7 +2142,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2094
2142
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2095
2143
  var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2096
2144
  var pageNumber = 1;
2097
-
2145
+
2098
2146
  CrispClient.website.listCampaignStatistics(websiteID, campaignID, action, pageNumber);
2099
2147
  ```
2100
2148
  </details>
@@ -2164,7 +2212,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2164
2212
 
2165
2213
  ```javascript
2166
2214
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2167
-
2215
+
2168
2216
  CrispClient.plugin.listSubscriptionsForWebsite(websiteID);
2169
2217
  ```
2170
2218
  </details>
@@ -2177,7 +2225,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2177
2225
  ```javascript
2178
2226
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2179
2227
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2180
-
2228
+
2181
2229
  CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID);
2182
2230
  ```
2183
2231
  </details>
@@ -2190,9 +2238,9 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2190
2238
  ```javascript
2191
2239
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2192
2240
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2193
-
2241
+
2194
2242
  var pluginID = "98454664-9f7d-4d95-a9ce-f37356f5e65a";
2195
-
2243
+
2196
2244
  CrispClient.plugin.subscribeWebsiteToPlugin(websiteID, pluginID);
2197
2245
  ```
2198
2246
  </details>
@@ -2205,7 +2253,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2205
2253
  ```javascript
2206
2254
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2207
2255
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2208
-
2256
+
2209
2257
  CrispClient.plugin.unsubscribePluginFromWebsite(websiteID, pluginID);
2210
2258
  ```
2211
2259
  </details>
@@ -2218,7 +2266,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2218
2266
  ```javascript
2219
2267
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2220
2268
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2221
-
2269
+
2222
2270
  CrispClient.plugin.getSubscriptionSettings(websiteID, pluginID);
2223
2271
  ```
2224
2272
  </details>
@@ -2231,13 +2279,13 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2231
2279
  ```javascript
2232
2280
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2233
2281
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2234
-
2282
+
2235
2283
  var settings = {
2236
2284
  "chatbox": {
2237
2285
  "25": "#bbbbbb"
2238
2286
  }
2239
2287
  };
2240
-
2288
+
2241
2289
  CrispClient.plugin.saveSubscriptionSettings(websiteID, pluginID, settings);
2242
2290
  ```
2243
2291
  </details>
@@ -2250,13 +2298,13 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2250
2298
  ```javascript
2251
2299
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2252
2300
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2253
-
2301
+
2254
2302
  var settings = {
2255
2303
  "chatbox": {
2256
2304
  "25": "#bbbbbb"
2257
2305
  }
2258
2306
  };
2259
-
2307
+
2260
2308
  CrispClient.plugin.updateSubscriptionSettings(websiteID, pluginID, settings);
2261
2309
  ```
2262
2310
  </details>
@@ -2269,14 +2317,14 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2269
2317
  ```javascript
2270
2318
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2271
2319
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2272
-
2320
+
2273
2321
  var payload = {
2274
2322
  "namespace": "bot:step",
2275
2323
  "payload": {
2276
2324
  "step": 1
2277
2325
  }
2278
2326
  };
2279
-
2327
+
2280
2328
  CrispClient.plugin.forwardPluginPayloadToChannel(websiteID, pluginID, payload);
2281
2329
  ```
2282
2330
  </details>
@@ -2289,7 +2337,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2289
2337
  ```javascript
2290
2338
  var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2291
2339
  var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2292
-
2340
+
2293
2341
  var payload = {
2294
2342
  "name": "bot-is-running",
2295
2343
  "data": {
@@ -2297,7 +2345,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2297
2345
  "email": "valerian@crisp.chat"
2298
2346
  }
2299
2347
  };
2300
-
2348
+
2301
2349
  CrispClient.plugin.dispatchPluginEvent(websiteID, pluginID, payload);
2302
2350
  ```
2303
2351
  </details>
@@ -2314,7 +2362,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2314
2362
  ```javascript
2315
2363
  var listID = "f7fb43da-1cd8-49c1-ade0-9f5b71d034e3";
2316
2364
  var pageNumber = 1;
2317
-
2365
+
2318
2366
  CrispClient.media.listAnimationMedias(pageNumber, listID, searchQuery);
2319
2367
  ```
2320
2368
  </details>
@@ -2338,7 +2386,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
2338
2386
 
2339
2387
  You can bind to realtime events from Crisp, in order to get notified of incoming messages and updates in websites.
2340
2388
 
2341
- 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.
2389
+ 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.
2342
2390
 
2343
2391
  Available events are listed below:
2344
2392
 
@@ -2365,7 +2413,7 @@ Available events are listed below:
2365
2413
  * `session:set_data`
2366
2414
  * **Session Sync Pages** [`user`, `plugin`]:
2367
2415
  * `session:sync:pages`
2368
- * **Session Sync Events** [`user`, `plugin`]:
2416
+ * **Session Sync Events** [`user`, `plugin`]:
2369
2417
  * `session:sync:events`
2370
2418
  * **Session Sync Capabilities** [`user`, `plugin`]:
2371
2419
  * `session:sync:capabilities`
@@ -2407,6 +2455,8 @@ Available events are listed below:
2407
2455
  * `message:send`
2408
2456
  * **Message Received** [`user`, `plugin`]:
2409
2457
  * `message:received`
2458
+ * **Message Removed** [`user`, `plugin`]:
2459
+ * `message:removed`
2410
2460
  * **Message Compose Send** [`user`, `plugin`]:
2411
2461
  * `message:compose:send`
2412
2462
  * **Message Compose Receive** [`user`, `plugin`]:
@@ -2471,7 +2521,7 @@ Available events are listed below:
2471
2521
  * `website:update_visitors_count`
2472
2522
  * **Website Update Operators Availability** [`user`, `plugin`]:
2473
2523
  * `website:update_operators_availability`
2474
- * **Website Users Available** [`user`, `plugin`]:
2524
+ * **Website Users Available** [`user`, `plugin`]:
2475
2525
  * `website:users:available`
2476
2526
 
2477
2527
  * #### **Bucket Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#bucket-events)
@@ -2501,9 +2551,9 @@ Available events are listed below:
2501
2551
  * `email:track:view`
2502
2552
 
2503
2553
  * #### **Plugin Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#plugin-events)
2504
- * **Plugin Channel** [`user`, `plugin`]:
2554
+ * **Plugin Channel** [`user`, `plugin`]:
2505
2555
  * `plugin:channel`
2506
2556
  * **Plugin Event** [`user`, `plugin`]:
2507
2557
  * `plugin:event`
2508
- * **Plugin Settings Saved** [`user`, `plugin`]:
2558
+ * **Plugin Settings Saved** [`user`, `plugin`]:
2509
2559
  * `plugin:settings:saved`