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