crisp-api 5.0.2 → 5.1.0

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