crisp-api 5.0.3 → 5.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
@@ -4,9 +4,9 @@
4
4
 
5
5
  The Crisp API Node wrapper. Authenticate, send messages, fetch conversations, access your agent accounts from your JavaScript code.
6
6
 
7
- Copyright 2021 Crisp IM SARL. See LICENSE for copying information.
7
+ Copyright 2021 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: 30/11/2021
9
+ * **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 10/04/2022
10
10
  * **😘 Maintainers**: [@baptistejamin](https://github.com/baptistejamin), [@eliottvincent](https://github.com/eliottvincent), [@valeriansaliou](https://github.com/valeriansaliou)
11
11
 
12
12
  ## Installation
@@ -90,329 +90,2239 @@ All methods that you will most likely need when building a Crisp integration are
90
90
 
91
91
  **⚠️ Note that, depending on your authentication token tier, which is either `user` or `plugin`, you may not be allowed to use all methods from the library. When in doubt, refer to the library method descriptions below. Most likely, you are using a `plugin` token.**
92
92
 
93
+ ---
94
+
95
+ <details>
96
+ <summary>
97
+ <a href="#website">Website</a>
98
+ </summary>
99
+ <ul>
100
+ <li><a href="#website-conversations">Website Conversations</a></li>
101
+ <li><a href="#website-conversation">Website Conversation</a></li>
102
+ <li><a href="#website-people">Website People</a></li>
103
+ <li><a href="#website-operator">Website Operator</a></li>
104
+ <li><a href="#website-availability">Website Availability</a></li>
105
+ <li><a href="#website-analytics">Website Analytics</a></li>
106
+ <li><a href="#website-batch">Website Batch</a></li>
107
+ <li><a href="#website-verify">Website Verify</a></li>
108
+ <li><a href="#website-campaigns">Website Campaigns</a></li>
109
+ <li><a href="#website-campaign">Website Campaign</a></li>
110
+ </ul>
111
+ </details>
112
+ <details>
113
+ <summary>
114
+ <a href="#plugin">Plugin</a>
115
+ </summary>
116
+ <ul>
117
+ <li><a href="#plugin-connect">Plugin Connect</a></li>
118
+ <li><a href="#plugin-subscription">Plugin Subscription</a></li>
119
+ </ul>
120
+ </details>
121
+ <details>
122
+ <summary>
123
+ <a href="#media">Media</a>
124
+ </summary>
125
+ <ul>
126
+ <li><a href="#media-animation">Media Animation</a></li>
127
+ </ul>
128
+ </details>
129
+ <details>
130
+ <summary>
131
+ <a href="#bucket">Bucket</a>
132
+ </summary>
133
+ <ul>
134
+ <li><a href="#bucket-url">Bucket URL</a></li>
135
+ </ul>
136
+ </details>
137
+ <details>
138
+ <summary>
139
+ <a href="#plugin">RTM Events</a>
140
+ </summary>
141
+ <ul>
142
+ <li><a href="#session--reference">Session Events</a></li>
143
+ <li><a href="#message-events-reference">Message Events</a></li>
144
+ <li><a href="#people-events-reference">People Events</a></li>
145
+ <li><a href="#campaign-events-reference">Campaign Events</a></li>
146
+ <li><a href="#browsing-events-reference">Browsing Events</a></li>
147
+ <li><a href="#call-events-reference">Call Events</a></li>
148
+ <li><a href="#widget-events-reference">Widget Events</a></li>
149
+ <li><a href="#status-events-reference">Status Events</a></li>
150
+ <li><a href="#website-events-reference">Website Events</a></li>
151
+ <li><a href="#bucket-events-reference">Bucket Events</a></li>
152
+ <li><a href="#media-events-reference">Media Events</a></li>
153
+ <li><a href="#email-events-reference">Email Events</a></li>
154
+ <li><a href="#plugin-events-reference">Plugin Events</a></li>
155
+ </ul>
156
+ </details>
157
+
158
+ ---
159
+
93
160
  ### Website
94
161
 
95
- * **Website Conversations**
162
+ * #### **Website Conversations**
96
163
  * **⭐ List Conversations** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-conversations)
97
164
  * `CrispClient.website.listConversations(websiteID, pageNumber)`
165
+ * <details>
166
+ <summary>See Example</summary>
167
+
168
+ ```javascript
169
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
170
+ var pageNumber = 1;
171
+
172
+ CrispClient.website.listConversations(websiteID, pageNumber);
173
+ ```
174
+ </details>
175
+
98
176
  * **List Suggested Conversation Segments** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-conversation-segments)
99
177
  * `CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber)`
178
+ * <details>
179
+ <summary>See Example</summary>
180
+
181
+ ```javascript
182
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
183
+ var pageNumber = 1;
184
+
185
+ CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber);
186
+ ```
187
+ </details>
188
+
100
189
  * **Delete Suggested Conversation Segment** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-conversation-segment)
101
190
  * `CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment)`
191
+ * <details>
192
+ <summary>See Example</summary>
193
+
194
+ ```javascript
195
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
196
+
197
+ var segment = "bug";
198
+
199
+ CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment);
200
+ ```
201
+ </details>
202
+
102
203
  * **List Suggested Conversation Data Keys** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-conversation-data-keys)
103
204
  * `CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber)`
205
+ * <details>
206
+ <summary>See Example</summary>
207
+
208
+ ```javascript
209
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
210
+ var pageNumber = 1;
211
+
212
+ CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber);
213
+ ```
214
+ </details>
215
+
104
216
  * **Delete Suggested Conversation Data Key** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-conversation-data-key)
105
217
  * `CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key)`
218
+ * <details>
219
+ <summary>See Example</summary>
220
+
221
+ ```javascript
222
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
223
+
224
+ var key = "price";
225
+
226
+ CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key);
227
+ ```
228
+ </details>
106
229
 
107
- * **Website Conversation**
230
+
231
+ * #### **Website Conversation**
108
232
  * **⭐ Create A New Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-a-new-conversation)
109
233
  * `CrispClient.website.createNewConversation(websiteID)`
234
+ * <details>
235
+ <summary>See Example</summary>
236
+
237
+ ```javascript
238
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
239
+
240
+ CrispClient.website.createNewConversation(websiteID);
241
+ ```
242
+ </details>
243
+
110
244
  * **Check If Conversation Exists** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-conversation-exists)
111
245
  * `CrispClient.website.checkConversationExists(websiteID, sessionID)`
246
+ * <details>
247
+ <summary>See Example</summary>
248
+
249
+ ```javascript
250
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
251
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
252
+
253
+ CrispClient.website.checkConversationExists(websiteID, sessionID);
254
+ ```
255
+ </details>
256
+
112
257
  * **⭐ Get A Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-conversation)
113
258
  * `CrispClient.website.getConversation(websiteID, sessionID)`
259
+ * <details>
260
+ <summary>See Example</summary>
261
+
262
+ ```javascript
263
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
264
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
265
+
266
+ CrispClient.website.getConversation(websiteID, sessionID);
267
+ ```
268
+ </details>
269
+
114
270
  * **Remove A Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-a-conversation)
115
271
  * `CrispClient.website.removeConversation(websiteID, sessionID)`
272
+ * <details>
273
+ <summary>See Example</summary>
274
+
275
+ ```javascript
276
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
277
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
278
+
279
+ CrispClient.website.removeConversation(websiteID, sessionID);
280
+ ```
281
+ </details>
282
+
116
283
  * **Initiate A Conversation With Existing Session** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#initiate-a-conversation-with-existing-session)
117
284
  * `CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID)`
285
+ * <details>
286
+ <summary>See Example</summary>
287
+
288
+ ```javascript
289
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
290
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
291
+
292
+ CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID);
293
+ ```
294
+ </details>
295
+
118
296
  * **⭐ Get Messages In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-messages-in-conversation)
119
297
  * `CrispClient.website.getMessagesInConversation(websiteID, sessionID, timestampBefore)`
298
+ * <details>
299
+ <summary>See Example</summary>
300
+
301
+ ```javascript
302
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
303
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
304
+ var timestampBefore = 1641206011000;
305
+
306
+ CrispClient.website.getMessagesInConversation(websiteID, sessionID, timestampBefore);
307
+ ```
308
+ </details>
309
+
120
310
  * **⭐ Send A Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#send-a-message-in-conversation)
121
311
  * `CrispClient.website.sendMessageInConversation(websiteID, sessionID, message)`
312
+ * <details>
313
+ <summary>See Example</summary>
314
+
315
+ ```javascript
316
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
317
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
318
+
319
+ var message = {
320
+ "type": "text",
321
+ "from": "operator",
322
+ "origin": "chat",
323
+ "content": "Hey there! Need help?"
324
+ };
325
+
326
+ CrispClient.website.sendMessageInConversation(websiteID, sessionID, message);
327
+ ```
328
+ </details>
329
+
122
330
  * **Get A Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-message-in-conversation)
123
331
  * `CrispClient.website.getMessageInConversation(websiteID, sessionID, fingerprint)`
332
+ * <details>
333
+ <summary>See Example</summary>
334
+
335
+ ```javascript
336
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
337
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
338
+ var fingerprint = 524653764345;
339
+
340
+ CrispClient.website.getMessageInConversation(websiteID, sessionID, fingerprint);
341
+ ```
342
+ </details>
343
+
124
344
  * **Update A Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-a-message-in-conversation)
125
345
  * `CrispClient.website.updateMessageInConversation(websiteID, sessionID, fingerprint, content)`
346
+ * <details>
347
+ <summary>See Example</summary>
348
+
349
+ ```javascript
350
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
351
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
352
+ var fingerprint = 524653764345;
353
+
354
+ var content = "Hey there! Need help?";
355
+
356
+ CrispClient.website.updateMessageInConversation(websiteID, sessionID, fingerprint, content);
357
+ ```
358
+ </details>
359
+
126
360
  * **Compose A Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#compose-a-message-in-conversation)
127
361
  * `CrispClient.website.composeMessageInConversation(websiteID, sessionID, compose)`
362
+ * <details>
363
+ <summary>See Example</summary>
364
+
365
+ ```javascript
366
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
367
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
368
+
369
+ var compose = {
370
+ "type": "start",
371
+ "from": "operator"
372
+ };
373
+
374
+ CrispClient.website.composeMessageInConversation(websiteID, sessionID, compose);
375
+ ```
376
+ </details>
377
+
128
378
  * **⭐ Mark Messages As Read In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#mark-messages-as-read-in-conversation)
129
379
  * `CrispClient.website.markMessagesReadInConversation(websiteID, sessionID, read)`
380
+ * <details>
381
+ <summary>See Example</summary>
382
+
383
+ ```javascript
384
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
385
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
386
+
387
+ var read = {
388
+ "from": "operator",
389
+ "origin": "urn:crisp.im:slack:0",
390
+ "fingerprints": [
391
+ "5719231201"
392
+ ]
393
+ };
394
+
395
+ CrispClient.website.markMessagesReadInConversation(websiteID, sessionID, read);
396
+ ```
397
+ </details>
398
+
130
399
  * **⭐ Mark Messages As Delivered In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#mark-messages-as-delivered-in-conversation)
131
400
  * `CrispClient.website.markMessagesDeliveredInConversation(websiteID, sessionID, delivered)`
401
+ * <details>
402
+ <summary>See Example</summary>
403
+
404
+ ```javascript
405
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
406
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
407
+
408
+ var delivered = {
409
+ "from": "operator",
410
+ "origin": "urn:crisp.im:slack:0",
411
+ "fingerprints": [
412
+ "5719231201"
413
+ ]
414
+ };
415
+
416
+ CrispClient.website.markMessagesDeliveredInConversation(websiteID, sessionID, delivered);
417
+ ```
418
+ </details>
419
+
132
420
  * **Update Conversation Open State** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-conversation-open-state)
133
421
  * `CrispClient.website.updateConversationOpenState(websiteID, sessionID, opened)`
422
+ * <details>
423
+ <summary>See Example</summary>
424
+
425
+ ```javascript
426
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
427
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
428
+
429
+ var opened = true;
430
+
431
+ CrispClient.website.updateConversationOpenState(websiteID, sessionID, opened);
432
+ ```
433
+ </details>
434
+
134
435
  * **⭐ Get Conversation Routing Assign** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-routing-assign)
135
436
  * `CrispClient.website.getConversationRoutingAssign(websiteID, sessionID)`
437
+ * <details>
438
+ <summary>See Example</summary>
439
+
440
+ ```javascript
441
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
442
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
443
+
444
+ CrispClient.website.getConversationRoutingAssign(websiteID, sessionID);
445
+ ```
446
+ </details>
447
+
136
448
  * **⭐ Assign Conversation Routing** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#assign-conversation-routing)
137
449
  * `CrispClient.website.assignConversationRouting(websiteID, sessionID, assign)`
450
+ * <details>
451
+ <summary>See Example</summary>
452
+
453
+ ```javascript
454
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
455
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
456
+
457
+ var assign = {
458
+ "assigned": {
459
+ "user_id": "a4c32c68-be91-4e29-8a05-976e93abbe3f"
460
+ }
461
+ };
462
+
463
+ CrispClient.website.assignConversationRouting(websiteID, sessionID, assign);
464
+ ```
465
+ </details>
466
+
138
467
  * **⭐ Get Conversation Metas** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-metas)
139
468
  * `CrispClient.website.getConversationMetas(websiteID, sessionID)`
469
+ * <details>
470
+ <summary>See Example</summary>
471
+
472
+ ```javascript
473
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
474
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
475
+
476
+ CrispClient.website.getConversationMetas(websiteID, sessionID);
477
+ ```
478
+ </details>
479
+
140
480
  * **⭐ Update Conversation Metas** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-conversation-metas)
141
481
  * `CrispClient.website.updateConversationMetas(websiteID, sessionID, metas)`
482
+ * <details>
483
+ <summary>See Example</summary>
484
+
485
+ ```javascript
486
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
487
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
488
+
489
+ var metas = {
490
+ "nickname": "John Doe",
491
+ "email": "john.doe@acme-inc.com",
492
+ "segments": [
493
+ "happy",
494
+ "customer",
495
+ "love"
496
+ ],
497
+ "data": {
498
+ "type": "customer",
499
+ "signup": "finished"
500
+ }
501
+ };
502
+
503
+ CrispClient.website.updateConversationMetas(websiteID, sessionID, metas);
504
+ ```
505
+ </details>
506
+
142
507
  * **Get An Original Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-an-original-message-in-conversation)
143
508
  * `CrispClient.website.getOriginalMessageInConversation(websiteID, sessionID, originalID)`
509
+ * <details>
510
+ <summary>See Example</summary>
511
+
512
+ ```javascript
513
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
514
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
515
+ var originalID = "2325a3c0-9b47-4fc6-b00e-111b752e44cd";
516
+
517
+ CrispClient.website.getOriginalMessageInConversation(websiteID, sessionID, originalID);
518
+ ```
519
+ </details>
520
+
144
521
  * **List Conversation Pages** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-conversation-pages)
145
522
  * `CrispClient.website.listConversationPages(websiteID, sessionID, pageNumber)`
523
+ * <details>
524
+ <summary>See Example</summary>
525
+
526
+ ```javascript
527
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
528
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
529
+ var pageNumber = 1;
530
+
531
+ CrispClient.website.listConversationPages(websiteID, sessionID, pageNumber);
532
+ ```
533
+ </details>
534
+
146
535
  * **List Conversation Events** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-conversation-events)
147
536
  * `CrispClient.website.listConversationEvents(websiteID, sessionID, pageNumber)`
537
+ * <details>
538
+ <summary>See Example</summary>
539
+
540
+ ```javascript
541
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
542
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
543
+ var pageNumber = 1;
544
+
545
+ CrispClient.website.listConversationEvents(websiteID, sessionID, pageNumber);
546
+ ```
547
+ </details>
548
+
148
549
  * **Get Conversation State** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-state)
149
550
  * `CrispClient.website.getConversationState(websiteID, sessionID)`
551
+ * <details>
552
+ <summary>See Example</summary>
553
+
554
+ ```javascript
555
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
556
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
557
+
558
+ CrispClient.website.getConversationState(websiteID, sessionID);
559
+ ```
560
+ </details>
561
+
150
562
  * **⭐ Change Conversation State** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#change-conversation-state)
151
563
  * `CrispClient.website.changeConversationState(websiteID, sessionID, state)`
564
+ * <details>
565
+ <summary>See Example</summary>
566
+
567
+ ```javascript
568
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
569
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
570
+
571
+ var state = "unresolved";
572
+
573
+ CrispClient.website.changeConversationState(websiteID, sessionID, state);
574
+ ```
575
+ </details>
576
+
152
577
  * **Get Conversation Participants** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-participants)
153
578
  * `CrispClient.website.getConversationParticipants(websiteID, sessionID)`
579
+ * <details>
580
+ <summary>See Example</summary>
581
+
582
+ ```javascript
583
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
584
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
585
+
586
+ CrispClient.website.getConversationParticipants(websiteID, sessionID);
587
+ ```
588
+ </details>
589
+
154
590
  * **Save Conversation Participants** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-conversation-participants)
155
591
  * `CrispClient.website.saveConversationParticipants(websiteID, sessionID, participants)`
592
+ * <details>
593
+ <summary>See Example</summary>
594
+
595
+ ```javascript
596
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
597
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
598
+
599
+ var participants = {
600
+ "participants": [
601
+ {
602
+ "type": "email",
603
+ "target": "jane.doe@acme-inc.com"
604
+ }
605
+ ]
606
+ };
607
+
608
+ CrispClient.website.saveConversationParticipants(websiteID, sessionID, participants);
609
+ ```
610
+ </details>
611
+
156
612
  * **Get Block Status For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-block-status-for-conversation)
157
613
  * `CrispClient.website.getBlockStatusForConversation(websiteID, sessionID)`
614
+ * <details>
615
+ <summary>See Example</summary>
616
+
617
+ ```javascript
618
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
619
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
620
+
621
+ CrispClient.website.getBlockStatusForConversation(websiteID, sessionID);
622
+ ```
623
+ </details>
624
+
158
625
  * **Block Incoming Messages For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#block-incoming-messages-for-conversation)
159
626
  * `CrispClient.website.blockIncomingMessagesForConversation(websiteID, sessionID, blocked)`
627
+ * <details>
628
+ <summary>See Example</summary>
629
+
630
+ ```javascript
631
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
632
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
633
+
634
+ var blocked = true;
635
+
636
+ CrispClient.website.blockIncomingMessagesForConversation(websiteID, sessionID, blocked);
637
+ ```
638
+ </details>
639
+
160
640
  * **Request Email Transcript For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-email-transcript-for-conversation)
161
641
  * `CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email)`
642
+ * <details>
643
+ <summary>See Example</summary>
644
+
645
+ ```javascript
646
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
647
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
648
+
649
+ var email = {
650
+ "to": "operator",
651
+ "email": "valerian@crisp.chat"
652
+ };
653
+
654
+ CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email);
655
+ ```
656
+ </details>
657
+
162
658
  * **Request Chatbox Binding Purge For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-chatbox-binding-purge-for-conversation)
163
659
  * `CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID)`
660
+ * <details>
661
+ <summary>See Example</summary>
662
+
663
+ ```javascript
664
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
665
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
666
+
667
+ CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID);
668
+ ```
669
+ </details>
670
+
164
671
  * **List Browsing Sessions For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-browsing-sessions-for-conversation)
165
672
  * `CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID)`
673
+ * <details>
674
+ <summary>See Example</summary>
675
+
676
+ ```javascript
677
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
678
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
679
+
680
+ CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID);
681
+ ```
682
+ </details>
683
+
166
684
  * **Initiate Browsing Session For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#initiate-browsing-session-for-conversation)
167
685
  * `CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID)`
686
+ * <details>
687
+ <summary>See Example</summary>
688
+
689
+ ```javascript
690
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
691
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
692
+
693
+ CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID);
694
+ ```
695
+ </details>
696
+
168
697
  * **Send Action To An Existing Browsing Session** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#send-action-to-an-existing-browsing-session)
169
698
  * `CrispClient.website.sendActionToExistingBrowsingSession(websiteID, sessionID, browsingID, action)`
699
+ * <details>
700
+ <summary>See Example</summary>
701
+
702
+ ```javascript
703
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
704
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
705
+ var browsingID = "browsing_05a9392d-ff3f-45e7-b021-1179c45668fa";
706
+
707
+ var action = "start";
708
+
709
+ CrispClient.website.sendActionToExistingBrowsingSession(websiteID, sessionID, browsingID, action);
710
+ ```
711
+ </details>
712
+
170
713
  * **Assist Existing Browsing Session** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#assist-an-existing-browsing-session)
171
714
  * `CrispClient.website.assistExistingBrowsingSession(websiteID, sessionID, browsingID, assist)`
715
+ * <details>
716
+ <summary>See Example</summary>
717
+
718
+ ```javascript
719
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
720
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
721
+ var browsingID = "browsing_05a9392d-ff3f-45e7-b021-1179c45668fa";
722
+
723
+ var assist = {
724
+ "action": "mouse",
725
+ "mouse": {
726
+ "x": 0,
727
+ "y": 784
728
+ }
729
+ };
730
+
731
+ CrispClient.website.assistExistingBrowsingSession(websiteID, sessionID, browsingID, assist);
732
+ ```
733
+ </details>
734
+
172
735
  * **Initiate New Call Session For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#initiate-new-call-session-for-conversation)
173
- * `CrispClient.website.initiateNewCallSessionForConversation(websiteID, sessionID)`
736
+ * `CrispClient.website.initiateNewCallSessionForConversation(websiteID, sessionID, mode)`
737
+ * <details>
738
+ <summary>See Example</summary>
739
+
740
+ ```javascript
741
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
742
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
743
+
744
+ var mode = "audio";
745
+
746
+ CrispClient.website.initiateNewCallSessionForConversation(websiteID, sessionID, mode);
747
+ ```
748
+ </details>
749
+
174
750
  * **Get Ongoing Call Session For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-ongoing-call-session-for-conversation)
175
751
  * `CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID)`
752
+ * <details>
753
+ <summary>See Example</summary>
754
+
755
+ ```javascript
756
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
757
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
758
+
759
+ CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID);
760
+ ```
761
+ </details>
762
+
176
763
  * **Abort Ongoing Call Session For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#abort-ongoing-call-session-for-conversation)
177
764
  * `CrispClient.website.abortOngoingCallSessionForConversation(websiteID, sessionID, callID)`
765
+ * <details>
766
+ <summary>See Example</summary>
767
+
768
+ ```javascript
769
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
770
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
771
+ var callID = "call_35a0c062-72fa-4095-a2a0-f9911d47ee56";
772
+
773
+ CrispClient.website.abortOngoingCallSessionForConversation(websiteID, sessionID, callID);
774
+ ```
775
+ </details>
776
+
178
777
  * **Transmit Signaling On Ongoing Call Session** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#transmit-signaling-on-ongoing-call-session)
179
778
  * `CrispClient.website.transmitSignalingOnOngoingCallSession(websiteID, sessionID, callID, payload)`
779
+ * <details>
780
+ <summary>See Example</summary>
781
+
782
+ ```javascript
783
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
784
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
785
+ var callID = "call_35a0c062-72fa-4095-a2a0-f9911d47ee56";
786
+
787
+ var payload = {
788
+ "type": "sdp",
789
+ "payload": {}
790
+ };
791
+
792
+ CrispClient.website.transmitSignalingOnOngoingCallSession(websiteID, sessionID, callID, payload);
793
+ ```
794
+ </details>
795
+
180
796
  * **Deliver Widget Button Action For Conversation** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#deliver-widget-button-action-for-conversation)
181
797
  * `CrispClient.website.deliverWidgetButtonActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data, value)`
798
+ * <details>
799
+ <summary>See Example</summary>
800
+
801
+ ```javascript
802
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
803
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
804
+ var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
805
+ var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292";
806
+ var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785";
807
+
808
+ var value = {
809
+ "section_id": "payments",
810
+ "item_id": "refund_on_stripe",
811
+ "data": {
812
+ "invoice": "D-1929-X"
813
+ }
814
+ };
815
+
816
+ CrispClient.website.deliverWidgetButtonActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data, value);
817
+ ```
818
+ </details>
819
+
182
820
  * **Deliver Widget Data Fetch Action For Conversation** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#deliver-widget-data-action-for-conversation)
183
821
  * `CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data)`
822
+ * <details>
823
+ <summary>See Example</summary>
824
+
825
+ ```javascript
826
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
827
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
828
+ var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
829
+ var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292";
830
+ var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785";
831
+
832
+ var data = {
833
+ "section_id": "payments",
834
+ "item_id": "unpaid_balance",
835
+ "action": "fetch",
836
+ "data": {}
837
+ };
838
+
839
+ CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data);
840
+ ```
841
+ </details>
842
+
184
843
  * **Deliver Widget Data Edit Action For Conversation** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#deliver-widget-data-action-for-conversation)
185
844
  * `CrispClient.website.deliverWidgetDataEditActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, value)`
845
+ * <details>
846
+ <summary>See Example</summary>
847
+
848
+ ```javascript
849
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
850
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
851
+ var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
852
+ var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292";
853
+ var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785";
854
+
855
+ var data = {
856
+ "section_id": "payments",
857
+ "item_id": "unpaid_balance",
858
+ "action": "fetch",
859
+ "data": {}
860
+ };
861
+
862
+ CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data);
863
+ ```
864
+ </details>
865
+
186
866
  * **Schedule A Reminder For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#schedule-a-reminder-for-conversation)
187
867
  * `CrispClient.website.scheduleReminderForConversation(websiteID, sessionID, date, note)`
188
-
189
- * **Website People** _(these are your end-users)_
868
+ * <details>
869
+ <summary>See Example</summary>
870
+
871
+ ```javascript
872
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
873
+ var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
874
+
875
+ var note = {
876
+ "date": "2018-05-29T09:00:00Z",
877
+ "note": "Call this customer."
878
+ };
879
+
880
+ CrispClient.website.scheduleReminderForConversation(websiteID, sessionID, date, note);
881
+ ```
882
+ </details>
883
+
884
+
885
+ * ### **Website People** _(these are your end-users)_
190
886
  * **Get People Statistics** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-statistics)
191
887
  * `CrispClient.website.getPeopleStatistics(websiteID)`
888
+ * <details>
889
+ <summary>See Example</summary>
890
+
891
+ ```javascript
892
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
893
+
894
+ CrispClient.website.getPeopleStatistics(websiteID);
895
+ ```
896
+ </details>
897
+
192
898
  * **List Suggested People Segments** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-people-segments)
193
899
  * `CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber)`
900
+ * <details>
901
+ <summary>See Example</summary>
902
+
903
+ ```javascript
904
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
905
+ var pageNumber = 1;
906
+
907
+ CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber);
908
+ ```
909
+ </details>
910
+
194
911
  * **Delete Suggested People Segment** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-people-segment)
195
912
  * `CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment)`
913
+ * <details>
914
+ <summary>See Example</summary>
915
+
916
+ ```javascript
917
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
918
+
919
+ var segment = "poweruser";
920
+
921
+ CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment);
922
+ ```
923
+ </details>
924
+
196
925
  * **List Suggested People Data Keys** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-people-data-keys/)
197
926
  * `CrispClient.website.listSuggestedPeopleDataKeys(websiteID, pageNumber)`
198
927
  * **Delete Suggested People Data Key** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-people-data-key)
199
928
  * `CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key)`
929
+ * <details>
930
+ <summary>See Example</summary>
931
+
932
+ ```javascript
933
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
934
+
935
+ var key = "price";
936
+
937
+ CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key);
938
+ ```
939
+ </details>
940
+
200
941
  * **List Suggested People Events** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-people-events)
201
942
  * `CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber)`
943
+ * <details>
944
+ <summary>See Example</summary>
945
+
946
+ ```javascript
947
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
948
+ var pageNumber = 1;
949
+
950
+ CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber);
951
+ ```
952
+ </details>
953
+
202
954
  * **Delete Suggested People Event** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-people-event)
203
955
  * `CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text)`
956
+ * <details>
957
+ <summary>See Example</summary>
958
+
959
+ ```javascript
960
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
961
+
962
+ var text = "Removed item from basket";
963
+
964
+ CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text);
965
+ ```
966
+ </details>
967
+
204
968
  * **⭐ List People Profiles** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-profiles)
205
969
  * `CrispClient.website.listPeopleProfiles(websiteID, pageNumber, searchField, searchOrder, searchOperator, searchFilter, searchText)`
970
+ * <details>
971
+ <summary>See Example</summary>
972
+
973
+ ```javascript
974
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
975
+ var pageNumber = 1;
976
+
977
+ CrispClient.website.listPeopleProfiles(websiteID, pageNumber, searchField, searchOrder, searchOperator, searchFilter, searchText);
978
+ ```
979
+ </details>
980
+
206
981
  * **⭐ Add New People Profile** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-new-people-profile)
207
982
  * `CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile)`
983
+ * <details>
984
+ <summary>See Example</summary>
985
+
986
+ ```javascript
987
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
988
+
989
+ var peopleProfile = {
990
+ "email": "valerian@crisp.chat",
991
+ "person": {
992
+ "nickname": "Valerian Saliou"
993
+ }
994
+ };
995
+
996
+ CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile);
997
+ ```
998
+ </details>
999
+
208
1000
  * **⭐ Check If People Profile Exists** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-people-profile-exists)
209
1001
  * `CrispClient.website.checkPeopleProfileExists(websiteID, peopleID)`
1002
+ * <details>
1003
+ <summary>See Example</summary>
1004
+
1005
+ ```javascript
1006
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1007
+ var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1008
+
1009
+ CrispClient.website.checkPeopleProfileExists(websiteID, peopleID);
1010
+ ```
1011
+ </details>
1012
+
210
1013
  * **⭐ Get People Profile** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-profile)
211
1014
  * `CrispClient.website.getPeopleProfile(websiteID, peopleID)`
1015
+ * <details>
1016
+ <summary>See Example</summary>
1017
+
1018
+ ```javascript
1019
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1020
+ var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1021
+
1022
+ CrispClient.website.getPeopleProfile(websiteID, peopleID);
1023
+ ```
1024
+ </details>
1025
+
212
1026
  * **⭐ Save People Profile** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-people-profile)
213
1027
  * `CrispClient.website.savePeopleProfile(websiteID, peopleID, peopleProfile)`
1028
+ * <details>
1029
+ <summary>See Example</summary>
1030
+
1031
+ ```javascript
1032
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1033
+ var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1034
+
1035
+ var peopleProfile = {
1036
+ "email": "valerian@crisp.chat",
1037
+ "person": {
1038
+ "nickname": "Valerian Saliou"
1039
+ }
1040
+ };
1041
+
1042
+ CrispClient.website.savePeopleProfile(websiteID, peopleID, peopleProfile);
1043
+ ```
1044
+ </details>
1045
+
214
1046
  * **⭐ Update People Profile** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-people-profile)
215
1047
  * `CrispClient.website.updatePeopleProfile(websiteID, peopleID, peopleProfile)`
1048
+ * <details>
1049
+ <summary>See Example</summary>
1050
+
1051
+ ```javascript
1052
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1053
+ var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1054
+
1055
+ var peopleProfile = {
1056
+ "email": "valerian@crisp.chat",
1057
+ "person": {
1058
+ "nickname": "Valerian Saliou"
1059
+ }
1060
+ };
1061
+
1062
+ CrispClient.website.updatePeopleProfile(websiteID, peopleID, peopleProfile);
1063
+ ```
1064
+ </details>
1065
+
216
1066
  * **⭐ Remove People Profile** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-people-profile)
217
1067
  * `CrispClient.website.removePeopleProfile(websiteID, peopleID)`
1068
+ * <details>
1069
+ <summary>See Example</summary>
1070
+
1071
+ ```javascript
1072
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1073
+ var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1074
+
1075
+ CrispClient.website.removePeopleProfile(websiteID, peopleID);
1076
+ ```
1077
+ </details>
1078
+
218
1079
  * **List People Conversations** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-conversations)
219
1080
  * `CrispClient.website.listPeopleConversations(websiteID, peopleID, pageNumber)`
1081
+ * <details>
1082
+ <summary>See Example</summary>
1083
+
1084
+ ```javascript
1085
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1086
+ var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1087
+ var pageNumber = 1;
1088
+
1089
+ CrispClient.website.listPeopleConversations(websiteID, peopleID, pageNumber);
1090
+ ```
1091
+ </details>
1092
+
220
1093
  * **List People Campaigns** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-campaigns)
221
1094
  * `CrispClient.website.listPeopleCampaigns(websiteID, peopleID, pageNumber)`
1095
+ * <details>
1096
+ <summary>See Example</summary>
1097
+
1098
+ ```javascript
1099
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1100
+ var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1101
+ var pageNumber = 1;
1102
+
1103
+ CrispClient.website.listPeopleCampaigns(websiteID, peopleID, pageNumber);
1104
+ ```
1105
+ </details>
1106
+
222
1107
  * **Add A People Event** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-a-people-event)
223
1108
  * `CrispClient.website.addPeopleEvent(websiteID, peopleID, peopleEvent)`
1109
+ * <details>
1110
+ <summary>See Example</summary>
1111
+
1112
+ ```javascript
1113
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1114
+ var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1115
+
1116
+ var peopleEvent = {
1117
+ "text": "Added item to basket",
1118
+ "data": {
1119
+ "price": 10.99,
1120
+ "currency": "USD"
1121
+ },
1122
+ "color": "red"
1123
+ };
1124
+
1125
+ CrispClient.website.addPeopleEvent(websiteID, peopleID, peopleEvent);
1126
+ ```
1127
+ </details>
1128
+
224
1129
  * **List People Events** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-events)
225
1130
  * `CrispClient.website.listPeopleEvents(websiteID, peopleID, pageNumber)`
1131
+ * <details>
1132
+ <summary>See Example</summary>
1133
+
1134
+ ```javascript
1135
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1136
+ var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1137
+ var pageNumber = 1;
1138
+
1139
+ CrispClient.website.listPeopleEvents(websiteID, peopleID, pageNumber);
1140
+ ```
1141
+ </details>
1142
+
226
1143
  * **Get People Data** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-data)
227
1144
  * `CrispClient.website.getPeopleData(websiteID, peopleID)`
1145
+ * <details>
1146
+ <summary>See Example</summary>
1147
+
1148
+ ```javascript
1149
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1150
+ var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1151
+
1152
+ CrispClient.website.getPeopleData(websiteID, peopleID);
1153
+ ```
1154
+ </details>
1155
+
228
1156
  * **Save People Data** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-people-data)
229
1157
  * `CrispClient.website.savePeopleData(websiteID, peopleID, peopleData)`
1158
+ * <details>
1159
+ <summary>See Example</summary>
1160
+
1161
+ ```javascript
1162
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1163
+ var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1164
+
1165
+ var peopleData = {
1166
+ "data": {
1167
+ "type": "customer",
1168
+ "signup": "finished"
1169
+ }
1170
+ };
1171
+
1172
+ CrispClient.website.savePeopleData(websiteID, peopleID, peopleData);
1173
+ ```
1174
+ </details>
1175
+
230
1176
  * **Update People Data** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-people-data)
231
1177
  * `CrispClient.website.updatePeopleData(websiteID, peopleID, peopleData)`
1178
+ * <details>
1179
+ <summary>See Example</summary>
1180
+
1181
+ ```javascript
1182
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1183
+ var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1184
+
1185
+ var peopleData = {
1186
+ "data": {
1187
+ "signup": "finished"
1188
+ }
1189
+ };
1190
+
1191
+ CrispClient.website.updatePeopleData(websiteID, peopleID, peopleData);
1192
+ ```
1193
+ </details>
1194
+
232
1195
  * **Get People Subscription Status** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-subscription-status)
233
1196
  * `CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID)`
1197
+ * <details>
1198
+ <summary>See Example</summary>
1199
+
1200
+ ```javascript
1201
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1202
+ var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1203
+
1204
+ CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID);
1205
+ ```
1206
+ </details>
1207
+
234
1208
  * **Update People Subscription Status** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-people-subscription-status)
235
1209
  * `CrispClient.website.updatePeopleSubscriptionStatus(websiteID, peopleID, peopleSubscription)`
1210
+ * <details>
1211
+ <summary>See Example</summary>
1212
+
1213
+ ```javascript
1214
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1215
+ var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
1216
+
1217
+ var peopleSubscription = {
1218
+ "email": true
1219
+ };
1220
+
1221
+ CrispClient.website.updatePeopleSubscriptionStatus(websiteID, peopleID, peopleSubscription);
1222
+ ```
1223
+ </details>
1224
+
236
1225
  * **Export People Profiles** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#export-people-profiles)
237
1226
  * `CrispClient.website.exportPeopleProfiles(websiteID)`
1227
+ * <details>
1228
+ <summary>See Example</summary>
1229
+
1230
+ ```javascript
1231
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1232
+
1233
+ CrispClient.website.exportPeopleProfiles(websiteID);
1234
+ ```
1235
+ </details>
1236
+
238
1237
  * **Import People Profiles** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#import-people-profiles)
239
1238
  * `CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup)`
1239
+ * <details>
1240
+ <summary>See Example</summary>
1241
+
1242
+ ```javascript
1243
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1244
+
1245
+ var profileImportSetup = {
1246
+ "url": "https://storage.crisp.chat/users/processing/import/aa0b64dd-9fb4-4db9-80d6-5a49eb84087b/19d956c7-0294-45ad-89e1-58ce45e7008f.csv",
1247
+ "mapping": [
1248
+ {
1249
+ "column": 1,
1250
+ "field": "email"
1251
+ },
1252
+ {
1253
+ "column": 2,
1254
+ "field": "person.nickname"
1255
+ }
1256
+ ],
1257
+ "options": {
1258
+ "column_separator": ";",
1259
+ "skip_header": true
1260
+ }
1261
+ };
1262
+
1263
+ CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup);
1264
+ ```
1265
+ </details>
1266
+
240
1267
 
241
1268
  _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
242
1269
 
243
- * **Website Base**
1270
+ * #### **Website Base**
244
1271
  * **Check If Website Exists** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-website-exists)
245
1272
  * `CrispClient.website.checkWebsiteExists(domain)`
1273
+ * <details>
1274
+ <summary>See Example</summary>
1275
+
1276
+ ```javascript
1277
+ CrispClient.website.checkWebsiteExists(domain);
1278
+ ```
1279
+ </details>
1280
+
246
1281
  * **Create Website** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-website)
247
1282
  * `CrispClient.website.createWebsite(websiteData)`
1283
+ * <details>
1284
+ <summary>See Example</summary>
1285
+
1286
+ ```javascript
1287
+ CrispClient.website.createWebsite(websiteData);
1288
+ ```
1289
+ </details>
1290
+
248
1291
  * **Get A Website** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-website)
249
1292
  * `CrispClient.website.getWebsite(websiteID)`
1293
+ * <details>
1294
+ <summary>See Example</summary>
1295
+
1296
+ ```javascript
1297
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1298
+
1299
+ CrispClient.website.getWebsite(websiteID);
1300
+ ```
1301
+ </details>
1302
+
250
1303
  * **Delete A Website** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-a-website)
251
1304
  * `CrispClient.website.deleteWebsite(websiteID, verify)`
1305
+ * <details>
1306
+ <summary>See Example</summary>
1307
+
1308
+ ```javascript
1309
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1310
+
1311
+ var verify = "MySuperSecurePassword";
1312
+
1313
+ CrispClient.website.deleteWebsite(websiteID, verify);
1314
+ ```
1315
+ </details>
1316
+
252
1317
 
253
- * **Website Settings**
1318
+ * #### **Website Settings**
254
1319
  * **Get Website Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-website-settings)
255
1320
  * `CrispClient.website.getWebsiteSettings(websiteID)`
1321
+ * <details>
1322
+ <summary>See Example</summary>
1323
+
1324
+ ```javascript
1325
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1326
+
1327
+ CrispClient.website.getWebsiteSettings(websiteID);
1328
+ ```
1329
+ </details>
1330
+
256
1331
  * **Update Website Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-website-settings)
257
1332
  * `CrispClient.website.updateWebsiteSettings(websiteID, settings)`
258
-
259
- * **Website Operator**
1333
+ * <details>
1334
+ <summary>See Example</summary>
1335
+
1336
+ ```javascript
1337
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1338
+
1339
+ var settings = {
1340
+ "name": "Crisp",
1341
+ "domain": "crisp.chat",
1342
+ "logo": "https://storage.crisp.chat/users/avatar/website/8c842203-7ed8-4e29-a608-7cf78a7d2fcc/b6c2948d-b061-405e-91a9-2fdf855d1cc0.png",
1343
+ "contact": {
1344
+ "email": "contact@crisp.chat",
1345
+ "phone": "+33757905447"
1346
+ },
1347
+ "inbox": {
1348
+ "lock_removal": false,
1349
+ "force_operator_token": false
1350
+ },
1351
+ "emails": {
1352
+ "rating": true,
1353
+ "transcript": true,
1354
+ "enrich": true,
1355
+ "junk_filter": true
1356
+ },
1357
+ "chatbox": {
1358
+ "tile": "default",
1359
+ "wait_game": false,
1360
+ "last_operator_face": false,
1361
+ "ongoing_operator_face": true,
1362
+ "activity_metrics": true,
1363
+ "operator_privacy": false,
1364
+ "availability_tooltip": true,
1365
+ "hide_vacation": false,
1366
+ "hide_on_away": false,
1367
+ "hide_on_mobile": false,
1368
+ "position_reverse": false,
1369
+ "email_visitors": false,
1370
+ "phone_visitors": false,
1371
+ "force_identify": false,
1372
+ "ignore_privacy": false,
1373
+ "visitor_compose": false,
1374
+ "file_transfer": true,
1375
+ "helpdesk_link": true,
1376
+ "status_health_dead": true,
1377
+ "check_domain": false,
1378
+ "color_theme": "blue",
1379
+ "text_theme": "default",
1380
+ "welcome_message": "default",
1381
+ "locale": "en",
1382
+ "allowed_pages": [],
1383
+ "blocked_pages": [
1384
+ "status/*/",
1385
+ "docs.crisp.chat/*",
1386
+ "crisp.chat/terms/",
1387
+ "https://crisp.chat/privacy/"
1388
+ ],
1389
+ "blocked_countries": [
1390
+ "IT"
1391
+ ],
1392
+ "blocked_locales": [
1393
+ "fa",
1394
+ "he"
1395
+ ],
1396
+ "blocked_ips": [
1397
+ "8.8.8.8",
1398
+ "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
1399
+ "192.168.1.1/24"
1400
+ ]
1401
+ }
1402
+ };
1403
+
1404
+ CrispClient.website.updateWebsiteSettings(websiteID, settings);
1405
+ ```
1406
+ </details>
1407
+
1408
+
1409
+ * #### **Website Operator**
260
1410
  * **List Website Operators** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-website-operators)
261
1411
  * `CrispClient.website.listWebsiteOperators(websiteID)`
1412
+ * <details>
1413
+ <summary>See Example</summary>
1414
+
1415
+ ```javascript
1416
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1417
+
1418
+ CrispClient.website.listWebsiteOperators(websiteID);
1419
+ ```
1420
+ </details>
1421
+
262
1422
  * **List Last Active Website Operators** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-last-active-website-operators)
263
1423
  * `CrispClient.website.listLastActiveWebsiteOperators(websiteID)`
1424
+ * <details>
1425
+ <summary>See Example</summary>
1426
+
1427
+ ```javascript
1428
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1429
+
1430
+ CrispClient.website.listLastActiveWebsiteOperators(websiteID);
1431
+ ```
1432
+ </details>
1433
+
264
1434
  * **Flush Last Active Website Operators** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#flush-last-active-website-operators)
265
1435
  * `CrispClient.website.flushLastActiveWebsiteOperators(websiteID)`
1436
+ * <details>
1437
+ <summary>See Example</summary>
1438
+
1439
+ ```javascript
1440
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1441
+
1442
+ CrispClient.website.flushLastActiveWebsiteOperators(websiteID);
1443
+ ```
1444
+ </details>
1445
+
266
1446
  * **Send Email To Website Operators** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#send-email-to-website-operators)
267
1447
  * `CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData)`
1448
+ * <details>
1449
+ <summary>See Example</summary>
1450
+
1451
+ ```javascript
1452
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1453
+
1454
+ var emailData = {
1455
+ "recipient": "owners",
1456
+ "subject": "Plugin limits reached",
1457
+ "message": "Hi, you've reached the Slack plugin limits. Please contact our support team."
1458
+ };
1459
+
1460
+ CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData);
1461
+ ```
1462
+ </details>
1463
+
268
1464
  * **Get A Website Operator** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-website-operator)
269
1465
  * `CrispClient.website.getWebsiteOperator(websiteID, userID)`
1466
+ * <details>
1467
+ <summary>See Example</summary>
1468
+
1469
+ ```javascript
1470
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1471
+ var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
1472
+
1473
+ CrispClient.website.getWebsiteOperator(websiteID, userID);
1474
+ ```
1475
+ </details>
1476
+
270
1477
  * **Invite A Website Operator** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#invite-a-website-operator)
271
1478
  * `CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify)`
1479
+ * <details>
1480
+ <summary>See Example</summary>
1481
+
1482
+ ```javascript
1483
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1484
+
1485
+ var verify = {
1486
+ "email": "julien@crisp.chat",
1487
+ "role": "member",
1488
+ "verify": "MySuperSecurePassword"
1489
+ };
1490
+
1491
+ CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify);
1492
+ ```
1493
+ </details>
1494
+
272
1495
  * **Change Operator Membership** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#change-operator-membership)
273
1496
  * `CrispClient.website.changeOperatorMembership(websiteID, userID, role, title)`
1497
+ * <details>
1498
+ <summary>See Example</summary>
1499
+
1500
+ ```javascript
1501
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1502
+ var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
1503
+
1504
+ var title = {
1505
+ "role": "owner",
1506
+ "title": "CTO"
1507
+ };
1508
+
1509
+ CrispClient.website.changeOperatorMembership(websiteID, userID, role, title);
1510
+ ```
1511
+ </details>
1512
+
274
1513
  * **Unlink Operator From Website** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#unlink-operator-from-website)
275
1514
  * `CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID)`
1515
+ * <details>
1516
+ <summary>See Example</summary>
276
1517
 
277
- * **Website Visitors**
1518
+ ```javascript
1519
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1520
+ var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
1521
+
1522
+ CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID);
1523
+ ```
1524
+ </details>
1525
+
1526
+
1527
+ * #### **Website Visitors**
278
1528
  * **Count Visitors** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#count-visitors)
279
1529
  * `CrispClient.website.countVisitors(websiteID)`
1530
+ * <details>
1531
+ <summary>See Example</summary>
1532
+
1533
+ ```javascript
1534
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1535
+
1536
+ CrispClient.website.countVisitors(websiteID);
1537
+ ```
1538
+ </details>
1539
+
280
1540
  * **List Visitors** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-visitors)
281
1541
  * `CrispClient.website.listVisitors(websiteID, pageNumber)`
1542
+ * <details>
1543
+ <summary>See Example</summary>
1544
+
1545
+ ```javascript
1546
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1547
+ var pageNumber = 1;
1548
+
1549
+ CrispClient.website.listVisitors(websiteID, pageNumber);
1550
+ ```
1551
+ </details>
1552
+
282
1553
  * **Pinpoint Visitors On A Map** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#pinpoint-visitors-on-a-map)
283
1554
  * `CrispClient.website.pinpointVisitorsOnMap(websiteID, centerLongitude, centerLatitude, centerRadius)`
1555
+ * <details>
1556
+ <summary>See Example</summary>
1557
+
1558
+ ```javascript
1559
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1560
+
1561
+ CrispClient.website.pinpointVisitorsOnMap(websiteID, centerLongitude, centerLatitude, centerRadius);
1562
+ ```
1563
+ </details>
1564
+
284
1565
  * **Get Session Identifier From Token** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-session-identifier-from-token)
285
1566
  * `CrispClient.website.getSessionIdentifierFromToken(websiteID, tokenID)`
1567
+ * <details>
1568
+ <summary>See Example</summary>
1569
+
1570
+ ```javascript
1571
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1572
+ var tokenID = "d3c17241-1327-47d7-9d8e-b89ff7bd2904";
1573
+
1574
+ CrispClient.website.getSessionIdentifierFromToken(websiteID, tokenID);
1575
+ ```
1576
+ </details>
1577
+
286
1578
  * **Count Blocked Visitors** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#count-blocked-visitors/)
287
1579
  * `CrispClient.website.countBlockedVisitors(websiteID)`
288
1580
  * **Count Blocked Visitors In Rule** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#count-blocked-visitors-in-rule)
289
1581
  * `CrispClient.website.countBlockedVisitorsInRule(websiteID, rule)`
1582
+ * <details>
1583
+ <summary>See Example</summary>
1584
+
1585
+ ```javascript
1586
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1587
+
1588
+ CrispClient.website.countBlockedVisitorsInRule(websiteID, rule);
1589
+ ```
1590
+ </details>
1591
+
290
1592
  * **Clear Blocked Visitors In Rule** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#clear-blocked-visitors-in-rule)
291
1593
  * `CrispClient.website.clearBlockedVisitorsInRule(websiteID, rule)`
1594
+ * <details>
1595
+ <summary>See Example</summary>
1596
+
1597
+ ```javascript
1598
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1599
+
1600
+ CrispClient.website.clearBlockedVisitorsInRule(websiteID, rule);
1601
+ ```
1602
+ </details>
292
1603
 
293
- * **Website Availability**
1604
+
1605
+ * #### **Website Availability**
294
1606
  * **Get Website Availability Status** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-website-availability-status)
295
1607
  * `CrispClient.website.getWebsiteAvailabilityStatus(websiteID)`
1608
+ * <details>
1609
+ <summary>See Example</summary>
1610
+
1611
+ ```javascript
1612
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1613
+
1614
+ CrispClient.website.getWebsiteAvailabilityStatus(websiteID);
1615
+ ```
1616
+ </details>
1617
+
296
1618
  * **List Website Operator Availabilities** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-website-operator-availabilities)
297
1619
  * `CrispClient.website.listWebsiteOperatorAvailabilities(websiteID)`
1620
+ * <details>
1621
+ <summary>See Example</summary>
298
1622
 
299
- * **Website Analytics**
1623
+ ```javascript
1624
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1625
+
1626
+ CrispClient.website.listWebsiteOperatorAvailabilities(websiteID);
1627
+ ```
1628
+ </details>
1629
+
1630
+
1631
+ * #### **Website Analytics**
300
1632
  * **Acquire Analytics Points** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#acquire-analytics-points)
301
1633
  * `CrispClient.website.acquireAnalyticsPoints(websiteID, pointType, pointMetric, dateFrom, dateTo, dateSplit, classifier, filterPrimary, filterSecondary, filterTertiary)`
1634
+ * <details>
1635
+ <summary>See Example</summary>
1636
+
1637
+ ```javascript
1638
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1639
+
1640
+ CrispClient.website.acquireAnalyticsPoints(websiteID, pointType, pointMetric, dateFrom, dateTo, dateSplit, classifier, filterPrimary, filterSecondary, filterTertiary);
1641
+ ```
1642
+ </details>
1643
+
302
1644
  * **List Analytics Filters** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-analytics-filters)
303
1645
  * `CrispClient.website.listAnalyticsFilters(websiteID, pageNumber, pointType, pointMetric, dateFrom, dateTo)`
1646
+ * <details>
1647
+ <summary>See Example</summary>
1648
+
1649
+ ```javascript
1650
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1651
+ var pageNumber = 1;
1652
+
1653
+ CrispClient.website.listAnalyticsFilters(websiteID, pageNumber, pointType, pointMetric, dateFrom, dateTo);
1654
+ ```
1655
+ </details>
1656
+
304
1657
  * **List Analytics Classifiers** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-analytics-classifiers)
305
1658
  * `CrispClient.website.listAnalyticsClassifiers(websiteID, pageNumber, pointType, pointMetric, dateFrom, dateTo)`
1659
+ * <details>
1660
+ <summary>See Example</summary>
1661
+
1662
+ ```javascript
1663
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1664
+ var pageNumber = 1;
1665
+
1666
+ CrispClient.website.listAnalyticsClassifiers(websiteID, pageNumber, pointType, pointMetric, dateFrom, dateTo);
1667
+ ```
1668
+ </details>
306
1669
 
307
- * **Website Batch**
1670
+
1671
+ * #### **Website Batch**
308
1672
  * **Batch Resolve Conversations** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-resolve-items)
309
1673
  * `CrispClient.website.batchResolveConversations(websiteID, sessions)`
1674
+ * <details>
1675
+ <summary>See Example</summary>
1676
+
1677
+ ```javascript
1678
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1679
+
1680
+ CrispClient.website.batchResolveConversations(websiteID, sessions);
1681
+ ```
1682
+ </details>
1683
+
310
1684
  * **Batch Read Conversations** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-read-items)
311
1685
  * `CrispClient.website.batchReadConversations(websiteID, sessions)`
1686
+ * <details>
1687
+ <summary>See Example</summary>
1688
+
1689
+ ```javascript
1690
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1691
+
1692
+ CrispClient.website.batchReadConversations(websiteID, sessions);
1693
+ ```
1694
+ </details>
1695
+
312
1696
  * **Batch Remove Conversations** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-remove-items)
313
1697
  * `CrispClient.website.batchRemoveConversations(websiteID, sessions)`
1698
+ * <details>
1699
+ <summary>See Example</summary>
1700
+
1701
+ ```javascript
1702
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1703
+
1704
+ var sessions = [
1705
+ "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
1706
+ "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
1707
+ ];
1708
+
1709
+ CrispClient.website.batchRemoveConversations(websiteID, sessions);
1710
+ ```
1711
+ </details>
1712
+
314
1713
  * **Batch Remove People** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-remove-items)
315
1714
  * `CrispClient.website.batchRemovePeople(websiteID, people)`
316
-
317
- * **Website Verify**
1715
+ * <details>
1716
+ <summary>See Example</summary>
1717
+
1718
+ ```javascript
1719
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1720
+
1721
+ var sessions = [
1722
+ "session_19e5240f-0a8d-461e-a661-a3123fc6eec9",
1723
+ "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
1724
+ ];
1725
+
1726
+ CrispClient.website.batchRemoveConversations(websiteID, sessions);
1727
+ ```
1728
+ </details>
1729
+
1730
+
1731
+ * #### **Website Verify**
318
1732
  * **Get Verify Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-verify-settings)
319
1733
  * `CrispClient.website.getVerifySettings(websiteID)`
1734
+ * <details>
1735
+ <summary>See Example</summary>
1736
+
1737
+ ```javascript
1738
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1739
+
1740
+ CrispClient.website.getVerifySettings(websiteID);
1741
+ ```
1742
+ </details>
1743
+
320
1744
  * **Update Verify Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-verify-settings)
321
1745
  * `CrispClient.website.updateVerifySettings(websiteID, settings)`
1746
+ * <details>
1747
+ <summary>See Example</summary>
1748
+
1749
+ ```javascript
1750
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1751
+
1752
+ var settings = {
1753
+ "enabled": true
1754
+ };
1755
+
1756
+ CrispClient.website.updateVerifySettings(websiteID, settings);
1757
+ ```
1758
+ </details>
1759
+
322
1760
  * **Get Verify Key** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-verify-key)
323
1761
  * `CrispClient.website.getVerifyKey(websiteID)`
1762
+ * <details>
1763
+ <summary>See Example</summary>
1764
+
1765
+ ```javascript
1766
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1767
+
1768
+ CrispClient.website.getVerifyKey(websiteID);
1769
+ ```
1770
+ </details>
1771
+
324
1772
  * **Roll Verify Key** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#roll-verify-key)
325
1773
  * `CrispClient.website.rollVerifyKey(websiteID)`
1774
+ * <details>
1775
+ <summary>See Example</summary>
1776
+
1777
+ ```javascript
1778
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1779
+
1780
+ CrispClient.website.rollVerifyKey(websiteID);
1781
+ ```
1782
+ </details>
1783
+
326
1784
 
327
- * **Website Campaigns**
1785
+ * #### **Website Campaigns**
328
1786
  * **List Campaigns** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-campaigns)
329
1787
  * `CrispClient.website.listCampaigns(websiteID, pageNumber)`
1788
+ * <details>
1789
+ <summary>See Example</summary>
1790
+
1791
+ ```javascript
1792
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1793
+ var pageNumber = 1;
1794
+
1795
+ CrispClient.website.listCampaigns(websiteID, pageNumber);
1796
+ ```
1797
+ </details>
1798
+
330
1799
  * **List Campaign Tags** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-campaign-tags)
331
1800
  * `CrispClient.website.listCampaignTags(websiteID)`
1801
+ * <details>
1802
+ <summary>See Example</summary>
1803
+
1804
+ ```javascript
1805
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1806
+
1807
+ CrispClient.website.listCampaignTags(websiteID);
1808
+ ```
1809
+ </details>
1810
+
332
1811
  * **List Campaign Templates** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-campaign-templates)
333
1812
  * `CrispClient.website.listCampaignTemplates(websiteID, pageNumber)`
1813
+ * <details>
1814
+ <summary>See Example</summary>
1815
+
1816
+ ```javascript
1817
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1818
+ var pageNumber = 1;
1819
+
1820
+ CrispClient.website.listCampaignTemplates(websiteID, pageNumber);
1821
+ ```
1822
+ </details>
1823
+
334
1824
  * **Create A New Campaign Template** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-a-new-campaign-template)
335
1825
  * `CrispClient.website.createNewCampaignTemplate(websiteID, templateFormat, templateName)`
1826
+ * <details>
1827
+ <summary>See Example</summary>
1828
+
1829
+ ```javascript
1830
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1831
+
1832
+ var templateName = {
1833
+ "name": "HTML Template",
1834
+ "format": "html"
1835
+ };
1836
+
1837
+ CrispClient.website.createNewCampaignTemplate(websiteID, templateFormat, templateName);
1838
+ ```
1839
+ </details>
1840
+
336
1841
  * **Check If Campaign Template Exists** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-campaign-template-exists)
337
1842
  * `CrispClient.website.checkCampaignTemplateExists(websiteID, templateID)`
1843
+ * <details>
1844
+ <summary>See Example</summary>
1845
+
1846
+ ```javascript
1847
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1848
+ var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
1849
+
1850
+ CrispClient.website.checkCampaignTemplateExists(websiteID, templateID);
1851
+ ```
1852
+ </details>
1853
+
338
1854
  * **Get A Campaign Template** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-campaign-template)
339
1855
  * `CrispClient.website.getCampaignTemplate(websiteID, templateID)`
1856
+ * <details>
1857
+ <summary>See Example</summary>
1858
+
1859
+ ```javascript
1860
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1861
+ var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
1862
+
1863
+ CrispClient.website.getCampaignTemplate(websiteID, templateID);
1864
+ ```
1865
+ </details>
1866
+
340
1867
  * **Save A Campaign Template** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-a-campaign-template)
341
1868
  * `CrispClient.website.saveCampaignTemplate(websiteID, templateID, template)`
1869
+ * <details>
1870
+ <summary>See Example</summary>
1871
+
1872
+ ```javascript
1873
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1874
+ var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
1875
+
1876
+ var template = {
1877
+ "name": "HTML Template",
1878
+ "format": "html",
1879
+ "content": "<html><body><a href=\"{{url.unsubscribe}}\"></a></body></html>"
1880
+ };
1881
+
1882
+ CrispClient.website.saveCampaignTemplate(websiteID, templateID, template);
1883
+ ```
1884
+ </details>
1885
+
342
1886
  * **Update A Campaign Template** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-a-campaign-template)
343
1887
  * `CrispClient.website.updateCampaignTemplate(websiteID, templateID, template)`
1888
+ * <details>
1889
+ <summary>See Example</summary>
1890
+
1891
+ ```javascript
1892
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1893
+ var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
1894
+
1895
+ var template = "<html><body><a href=\"{{url.unsubscribe}}\"></a></body></html>";
1896
+
1897
+ CrispClient.website.updateCampaignTemplate(websiteID, templateID, template);
1898
+ ```
1899
+ </details>
1900
+
344
1901
  * **Remove A Campaign Template** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-a-campaign-template)
345
1902
  * `CrispClient.website.removeCampaignTemplate(websiteID, templateID)`
1903
+ * <details>
1904
+ <summary>See Example</summary>
346
1905
 
347
- * **Website Campaign**
1906
+ ```javascript
1907
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1908
+ var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2";
1909
+
1910
+ CrispClient.website.removeCampaignTemplate(websiteID, templateID);
1911
+ ```
1912
+ </details>
1913
+
1914
+
1915
+ * #### **Website Campaign**
348
1916
  * **Create A New Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-a-new-campaign)
349
1917
  * `CrispClient.website.createNewCampaign(websiteID, campaignType, campaignName)`
1918
+ * <details>
1919
+ <summary>See Example</summary>
1920
+
1921
+ ```javascript
1922
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1923
+
1924
+ var campaignName = {
1925
+ "type": "one-shot",
1926
+ "name": "Welcome!"
1927
+ };
1928
+
1929
+ CrispClient.website.createNewCampaign(websiteID, campaignType, campaignName);
1930
+ ```
1931
+ </details>
1932
+
350
1933
  * **Check If Campaign Exists** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-campaign-exists)
351
1934
  * `CrispClient.website.checkCampaignExists(websiteID, campaignID)`
1935
+ * <details>
1936
+ <summary>See Example</summary>
1937
+
1938
+ ```javascript
1939
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1940
+ var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
1941
+
1942
+ CrispClient.website.checkCampaignExists(websiteID, campaignID);
1943
+ ```
1944
+ </details>
1945
+
352
1946
  * **Get A Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-campaign)
353
1947
  * `CrispClient.website.getCampaign(websiteID, campaignID)`
1948
+ * <details>
1949
+ <summary>See Example</summary>
1950
+
1951
+ ```javascript
1952
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1953
+ var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
1954
+
1955
+ CrispClient.website.getCampaign(websiteID, campaignID);
1956
+ ```
1957
+ </details>
1958
+
354
1959
  * **Save A Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-a-campaign)
355
1960
  * `CrispClient.website.saveCampaign(websiteID, campaignID, campaign)`
1961
+ * <details>
1962
+ <summary>See Example</summary>
1963
+
1964
+ ```javascript
1965
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1966
+ var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
1967
+
1968
+ var campaign = {
1969
+ "type": "one-shot",
1970
+ "format": "markdown",
1971
+ "name": "Welcome!",
1972
+ "sender": {
1973
+ "user_id": "aa0b64dd-9fb4-4db9-80d6-5a49eb84087b"
1974
+ },
1975
+ "recipients": {
1976
+ "type": "all"
1977
+ },
1978
+ "message": "*Hey there*, welcome on Crisp!",
1979
+ "options": {
1980
+ "deliver_to_chatbox": true,
1981
+ "deliver_to_email": true,
1982
+ "sender_name_website": false,
1983
+ "sender_email_reply": null,
1984
+ "tracking": true
1985
+ }
1986
+ };
1987
+
1988
+ CrispClient.website.saveCampaign(websiteID, campaignID, campaign);
1989
+ ```
1990
+ </details>
1991
+
356
1992
  * **Update A Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-a-campaign)
357
1993
  * `CrispClient.website.updateCampaign(websiteID, campaignID, campaign)`
1994
+ * <details>
1995
+ <summary>See Example</summary>
1996
+
1997
+ ```javascript
1998
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
1999
+ var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2000
+
2001
+ var campaign = {
2002
+ "message": "*Hey there*, welcome on Crisp folks!"
2003
+ };
2004
+
2005
+ CrispClient.website.updateCampaign(websiteID, campaignID, campaign);
2006
+ ```
2007
+ </details>
2008
+
358
2009
  * **Remove A Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-a-campaign)
359
2010
  * `CrispClient.website.removeCampaign(websiteID, campaignID)`
2011
+ * <details>
2012
+ <summary>See Example</summary>
2013
+
2014
+ ```javascript
2015
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2016
+ var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2017
+
2018
+ CrispClient.website.removeCampaign(websiteID, campaignID);
2019
+ ```
2020
+ </details>
2021
+
360
2022
  * **Dispatch A Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#dispatch-a-campaign)
361
2023
  * `CrispClient.website.dispatchCampaign(websiteID, campaignID)`
2024
+ * <details>
2025
+ <summary>See Example</summary>
2026
+
2027
+ ```javascript
2028
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2029
+ var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2030
+
2031
+ CrispClient.website.dispatchCampaign(websiteID, campaignID);
2032
+ ```
2033
+ </details>
2034
+
362
2035
  * **Resume A Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resume-a-campaign)
363
2036
  * `CrispClient.website.resumeCampaign(websiteID, campaignID)`
2037
+ * <details>
2038
+ <summary>See Example</summary>
2039
+
2040
+ ```javascript
2041
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2042
+ var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2043
+
2044
+ CrispClient.website.resumeCampaign(websiteID, campaignID);
2045
+ ```
2046
+ </details>
2047
+
364
2048
  * **Pause A Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#pause-a-campaign)
365
2049
  * `CrispClient.website.pauseCampaign(websiteID, campaignID)`
2050
+ * <details>
2051
+ <summary>See Example</summary>
2052
+
2053
+ ```javascript
2054
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2055
+ var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2056
+
2057
+ CrispClient.website.pauseCampaign(websiteID, campaignID);
2058
+ ```
2059
+ </details>
2060
+
366
2061
  * **Test A Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#test-a-campaign)
367
2062
  * `CrispClient.website.testCampaign(websiteID, campaignID)`
2063
+ * <details>
2064
+ <summary>See Example</summary>
2065
+
2066
+ ```javascript
2067
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2068
+ var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2069
+
2070
+ CrispClient.website.testCampaign(websiteID, campaignID);
2071
+ ```
2072
+ </details>
2073
+
368
2074
  * **List Campaign Recipients** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-campaign-recipients)
369
2075
  * `CrispClient.website.listCampaignRecipients(websiteID, campaignID, pageNumber)`
2076
+ * <details>
2077
+ <summary>See Example</summary>
2078
+
2079
+ ```javascript
2080
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2081
+ var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2082
+ var pageNumber = 1;
2083
+
2084
+ CrispClient.website.listCampaignRecipients(websiteID, campaignID, pageNumber);
2085
+ ```
2086
+ </details>
2087
+
370
2088
  * **List Campaign Statistics** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-campaign-statistics)
371
2089
  * `CrispClient.website.listCampaignStatistics(websiteID, campaignID, action, pageNumber)`
2090
+ * <details>
2091
+ <summary>See Example</summary>
2092
+
2093
+ ```javascript
2094
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2095
+ var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8";
2096
+ var pageNumber = 1;
2097
+
2098
+ CrispClient.website.listCampaignStatistics(websiteID, campaignID, action, pageNumber);
2099
+ ```
2100
+ </details>
2101
+
372
2102
 
373
2103
  ### Plugin
374
2104
 
375
- * **Plugin Connect**
2105
+ * #### **Plugin Connect**
376
2106
  * **⭐ Get Connect Account** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-connect-account)
377
2107
  * `CrispClient.plugin.getConnectAccount()`
2108
+ * <details>
2109
+ <summary>See Example</summary>
2110
+
2111
+ ```javascript
2112
+ CrispClient.plugin.getConnectAccount();
2113
+ ```
2114
+ </details>
2115
+
378
2116
  * **⭐ Check Connect Session Validity** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-connect-session-validity)
379
2117
  * `CrispClient.plugin.checkConnectSessionValidity()`
2118
+ * <details>
2119
+ <summary>See Example</summary>
2120
+
2121
+ ```javascript
2122
+ CrispClient.plugin.checkConnectSessionValidity();
2123
+ ```
2124
+ </details>
2125
+
380
2126
  * **⭐ List All Connect Websites** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-all-connect-websites)
381
2127
  * `CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured, dateSince)`
2128
+ * <details>
2129
+ <summary>See Example</summary>
2130
+
2131
+ ```javascript
2132
+ var pageNumber = 1;
2133
+
2134
+ CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured, dateSince);
2135
+ ```
2136
+ </details>
382
2137
 
383
- * **Plugin Subscription**
2138
+
2139
+ * #### **Plugin Subscription**
384
2140
  * **List All Active Subscriptions** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-all-active-subscriptions)
385
2141
  * `CrispClient.plugin.listAllActiveSubscriptions()`
2142
+ * <details>
2143
+ <summary>See Example</summary>
2144
+
2145
+ ```javascript
2146
+ CrispClient.plugin.listAllActiveSubscriptions();
2147
+ ```
2148
+ </details>
2149
+
386
2150
  * **List Subscriptions For A Website** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-subscriptions-for-a-website)
387
2151
  * `CrispClient.plugin.listSubscriptionsForWebsite(websiteID)`
2152
+ * <details>
2153
+ <summary>See Example</summary>
2154
+
2155
+ ```javascript
2156
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2157
+
2158
+ CrispClient.plugin.listSubscriptionsForWebsite(websiteID);
2159
+ ```
2160
+ </details>
2161
+
388
2162
  * **Get Subscription Details** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-subscription-details)
389
2163
  * `CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID)`
2164
+ * <details>
2165
+ <summary>See Example</summary>
2166
+
2167
+ ```javascript
2168
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2169
+ var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2170
+
2171
+ CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID);
2172
+ ```
2173
+ </details>
2174
+
390
2175
  * **Subscribe Website To Plugin** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#subscribe-website-to-plugin)
391
2176
  * `CrispClient.plugin.subscribeWebsiteToPlugin(websiteID, pluginID)`
2177
+ * <details>
2178
+ <summary>See Example</summary>
2179
+
2180
+ ```javascript
2181
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2182
+ var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2183
+
2184
+ var pluginID = "98454664-9f7d-4d95-a9ce-f37356f5e65a";
2185
+
2186
+ CrispClient.plugin.subscribeWebsiteToPlugin(websiteID, pluginID);
2187
+ ```
2188
+ </details>
2189
+
392
2190
  * **Unsubscribe Plugin From Website** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#unsubscribe-plugin-from-website)
393
2191
  * `CrispClient.plugin.unsubscribePluginFromWebsite(websiteID, pluginID)`
2192
+ * <details>
2193
+ <summary>See Example</summary>
2194
+
2195
+ ```javascript
2196
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2197
+ var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2198
+
2199
+ CrispClient.plugin.unsubscribePluginFromWebsite(websiteID, pluginID);
2200
+ ```
2201
+ </details>
2202
+
394
2203
  * **Get Subscription Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-subscription-settings)
395
2204
  * `CrispClient.plugin.getSubscriptionSettings(websiteID, pluginID)`
2205
+ * <details>
2206
+ <summary>See Example</summary>
2207
+
2208
+ ```javascript
2209
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2210
+ var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2211
+
2212
+ CrispClient.plugin.getSubscriptionSettings(websiteID, pluginID);
2213
+ ```
2214
+ </details>
2215
+
396
2216
  * **Save Subscription Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-subscription-settings)
397
2217
  * `CrispClient.plugin.saveSubscriptionSettings(websiteID, pluginID, settings)`
2218
+ * <details>
2219
+ <summary>See Example</summary>
2220
+
2221
+ ```javascript
2222
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2223
+ var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2224
+
2225
+ var settings = {
2226
+ "chatbox": {
2227
+ "25": "#bbbbbb"
2228
+ }
2229
+ };
2230
+
2231
+ CrispClient.plugin.saveSubscriptionSettings(websiteID, pluginID, settings);
2232
+ ```
2233
+ </details>
2234
+
398
2235
  * **Update Subscription Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-subscription-settings)
399
2236
  * `CrispClient.plugin.updateSubscriptionSettings(websiteID, pluginID, settings)`
2237
+ * <details>
2238
+ <summary>See Example</summary>
2239
+
2240
+ ```javascript
2241
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2242
+ var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2243
+
2244
+ var settings = {
2245
+ "chatbox": {
2246
+ "25": "#bbbbbb"
2247
+ }
2248
+ };
2249
+
2250
+ CrispClient.plugin.updateSubscriptionSettings(websiteID, pluginID, settings);
2251
+ ```
2252
+ </details>
2253
+
400
2254
  * **Forward Plugin Payload To Channel** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#forward-plugin-payload-to-channel)
401
2255
  * `CrispClient.plugin.forwardPluginPayloadToChannel(websiteID, pluginID, payload)`
2256
+ * <details>
2257
+ <summary>See Example</summary>
2258
+
2259
+ ```javascript
2260
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2261
+ var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2262
+
2263
+ var payload = {
2264
+ "namespace": "bot:step",
2265
+ "payload": {
2266
+ "step": 1
2267
+ }
2268
+ };
2269
+
2270
+ CrispClient.plugin.forwardPluginPayloadToChannel(websiteID, pluginID, payload);
2271
+ ```
2272
+ </details>
2273
+
402
2274
  * **Dispatch Plugin Event** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#dispatch-plugin-event)
403
2275
  * `CrispClient.plugin.dispatchPluginEvent(websiteID, pluginID, payload)`
2276
+ * <details>
2277
+ <summary>See Example</summary>
2278
+
2279
+ ```javascript
2280
+ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
2281
+ var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
2282
+
2283
+ var payload = {
2284
+ "name": "bot-is-running",
2285
+ "data": {
2286
+ "bot": "Sales",
2287
+ "email": "valerian@crisp.chat"
2288
+ }
2289
+ };
2290
+
2291
+ CrispClient.plugin.dispatchPluginEvent(websiteID, pluginID, payload);
2292
+ ```
2293
+ </details>
2294
+
404
2295
 
405
2296
  ### Media
406
2297
 
407
- * **Media Animation**
2298
+ * #### **Media Animation**
408
2299
  * **List Animation Medias** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-animation-medias)
409
2300
  * `CrispClient.media.listAnimationMedias(pageNumber, listID, searchQuery)`
2301
+ * <details>
2302
+ <summary>See Example</summary>
2303
+
2304
+ ```javascript
2305
+ var listID = "f7fb43da-1cd8-49c1-ade0-9f5b71d034e3";
2306
+ var pageNumber = 1;
2307
+
2308
+ CrispClient.media.listAnimationMedias(pageNumber, listID, searchQuery);
2309
+ ```
2310
+ </details>
2311
+
410
2312
 
411
2313
  ### Bucket
412
2314
 
413
- * **Bucket URL**
2315
+ * #### **Bucket URL**
414
2316
  * **Generate Bucket URL** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#bucket-url)
415
2317
  * `CrispClient.bucket.generateBucketURL(data)`
2318
+ * <details>
2319
+ <summary>See Example</summary>
2320
+
2321
+ ```javascript
2322
+ CrispClient.bucket.generateBucketURL(data);
2323
+ ```
2324
+ </details>
2325
+
416
2326
 
417
2327
  ## Realtime Events
418
2328
 
@@ -422,7 +2332,7 @@ You won't receive any event if you don't explicitly subscribe to realtime events
422
2332
 
423
2333
  Available events are listed below:
424
2334
 
425
- * **Session Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#session-events)
2335
+ * #### **Session Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#session-events)
426
2336
  * **Session Update Availability** [`user`, `plugin`]:
427
2337
  * `session:update_availability`
428
2338
  * **Session Update Verify** [`user`, `plugin`]:
@@ -435,6 +2345,8 @@ Available events are listed below:
435
2345
  * `session:set_phone`
436
2346
  * **Session Set Address** [`user`, `plugin`]:
437
2347
  * `session:set_address`
2348
+ * **Session Set Subject** [`user`, `plugin`]:
2349
+ * `session:set_subject`
438
2350
  * **Session Set Avatar** [`user`, `plugin`]:
439
2351
  * `session:set_avatar`
440
2352
  * **Session Set Nickname** [`user`, `plugin`]:
@@ -478,7 +2390,7 @@ Available events are listed below:
478
2390
  * **Session Removed** [`user`, `plugin`]:
479
2391
  * `session:removed`
480
2392
 
481
- * **Message Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#message-events)
2393
+ * #### **Message Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#message-events)
482
2394
  * **Message Updated** [`user`, `plugin`]:
483
2395
  * `message:updated`
484
2396
  * **Message Send** [`user`, `plugin`]:
@@ -500,7 +2412,7 @@ Available events are listed below:
500
2412
  * **Message Notify Unread Received** [`user`, `plugin`]:
501
2413
  * `message:notify:unread:received`
502
2414
 
503
- * **People Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#people-events)
2415
+ * #### **People Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#people-events)
504
2416
  * **People Profile Created** [`user`, `plugin`]:
505
2417
  * `people:profile:created`
506
2418
  * **People Profile Updated** [`user`, `plugin`]:
@@ -516,7 +2428,7 @@ Available events are listed below:
516
2428
  * **People Import Done** [`user`]:
517
2429
  * `people:import:done`
518
2430
 
519
- * **Campaign Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#campaign-events)
2431
+ * #### **Campaign Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#campaign-events)
520
2432
  * **Campaign Progress** [`user`]:
521
2433
  * `campaign:progress`
522
2434
  * **Campaign Dispatched** [`user`]:
@@ -524,27 +2436,27 @@ Available events are listed below:
524
2436
  * **Campaign Running** [`user`]:
525
2437
  * `campaign:running`
526
2438
 
527
- * **Browsing Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#browsing-events)
2439
+ * #### **Browsing Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#browsing-events)
528
2440
  * **Browsing Request Initiated** [`user`, `plugin`]:
529
2441
  * `browsing:request:initiated`
530
2442
  * **Browsing Request Rejected** [`user`, `plugin`]:
531
2443
  * `browsing:request:rejected`
532
2444
 
533
- * **Call Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#call-events)
2445
+ * #### **Call Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#call-events)
534
2446
  * **Call Request Initiated** [`user`, `plugin`]:
535
2447
  * `call:request:initiated`
536
2448
  * **Call Request Rejected** [`user`, `plugin`]:
537
2449
  * `call:request:rejected`
538
2450
 
539
- * **Widget Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#widget-events)
2451
+ * #### **Widget Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#widget-events)
540
2452
  * **Widget Action Processed** [`user`]:
541
2453
  * `widget:action:processed`
542
2454
 
543
- * **Status Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#status-events)
2455
+ * #### **Status Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#status-events)
544
2456
  * **Status Health Changed** [`user`]:
545
2457
  * `status:health:changed`
546
2458
 
547
- * **Website Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#website-events)
2459
+ * #### **Website Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#website-events)
548
2460
  * **Website Update Visitors Count** [`user`, `plugin`]:
549
2461
  * `website:update_visitors_count`
550
2462
  * **Website Update Operators Availability** [`user`, `plugin`]:
@@ -552,7 +2464,7 @@ Available events are listed below:
552
2464
  * **Website Users Available** [`user`, `plugin`]:
553
2465
  * `website:users:available`
554
2466
 
555
- * **Bucket Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#bucket-events)
2467
+ * #### **Bucket Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#bucket-events)
556
2468
  * **Bucket URL Upload Generated** [`user`, `plugin`]:
557
2469
  * `bucket:url:upload:generated`
558
2470
  * **Bucket URL Avatar Generated** [`user`, `plugin`]:
@@ -568,17 +2480,17 @@ Available events are listed below:
568
2480
  * **Bucket URL Processing Generated** [`user`, `plugin`]:
569
2481
  * `bucket:url:processing:generated`
570
2482
 
571
- * **Media Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#media-events)
2483
+ * #### **Media Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#media-events)
572
2484
  * **Media Animation Listed** [`user`]:
573
2485
  * `media:animation:listed`
574
2486
 
575
- * **Email Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#email-events)
2487
+ * #### **Email Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#email-events)
576
2488
  * **Email Subscribe** [`user`, `plugin`]:
577
2489
  * `email:subscribe`
578
2490
  * **Email Track View** [`user`, `plugin`]:
579
2491
  * `email:track:view`
580
2492
 
581
- * **Plugin Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#plugin-events)
2493
+ * #### **Plugin Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#plugin-events)
582
2494
  * **Plugin Channel** [`user`, `plugin`]:
583
2495
  * `plugin:channel`
584
2496
  * **Plugin Event** [`user`, `plugin`]: