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