crisp-api 5.0.0 → 5.0.4

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