crisp-api 5.0.2 → 5.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/README.md +446 -237
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -86,193 +86,333 @@ 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
|
-
|
|
89
|
+
All methods that you will most likely need when building a Crisp integration are prefixed with a star symbol (⭐).
|
|
90
90
|
|
|
91
91
|
**⚠️ Note that, depending on your authentication token tier, which is either `user` or `plugin`, you may not be allowed to use all methods from the library. When in doubt, refer to the library method descriptions below. Most likely, you are using a `plugin` token.**
|
|
92
92
|
|
|
93
93
|
### Website
|
|
94
94
|
|
|
95
95
|
* **Website Conversations**
|
|
96
|
-
*
|
|
97
|
-
|
|
98
|
-
* **
|
|
99
|
-
|
|
100
|
-
* **Delete Suggested Conversation
|
|
96
|
+
* **⭐ List Conversations** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-conversations)
|
|
97
|
+
* `CrispClient.website.listConversations(websiteID, pageNumber)`
|
|
98
|
+
* **List Suggested Conversation Segments** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-conversation-segments)
|
|
99
|
+
* `CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber)`
|
|
100
|
+
* **Delete Suggested Conversation Segment** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-conversation-segment)
|
|
101
|
+
* `CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment)`
|
|
102
|
+
* **List Suggested Conversation Data Keys** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-conversation-data-keys)
|
|
103
|
+
* `CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber)`
|
|
104
|
+
* **Delete Suggested Conversation Data Key** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-conversation-data-key)
|
|
105
|
+
* `CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key)`
|
|
101
106
|
|
|
102
107
|
* **Website Conversation**
|
|
103
|
-
*
|
|
104
|
-
|
|
105
|
-
* **
|
|
106
|
-
|
|
107
|
-
*
|
|
108
|
-
|
|
109
|
-
* **
|
|
110
|
-
|
|
111
|
-
* **
|
|
112
|
-
|
|
113
|
-
*
|
|
114
|
-
|
|
115
|
-
*
|
|
116
|
-
|
|
117
|
-
* **
|
|
118
|
-
|
|
119
|
-
* **Update Conversation
|
|
120
|
-
|
|
121
|
-
* **
|
|
122
|
-
|
|
123
|
-
*
|
|
124
|
-
|
|
125
|
-
*
|
|
126
|
-
|
|
127
|
-
* **
|
|
128
|
-
|
|
129
|
-
*
|
|
130
|
-
|
|
131
|
-
*
|
|
132
|
-
|
|
133
|
-
*
|
|
134
|
-
|
|
135
|
-
*
|
|
136
|
-
|
|
137
|
-
* **
|
|
138
|
-
|
|
139
|
-
* **
|
|
140
|
-
|
|
141
|
-
* **
|
|
142
|
-
|
|
108
|
+
* **⭐ Create A New Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-a-new-conversation)
|
|
109
|
+
* `CrispClient.website.createNewConversation(websiteID)`
|
|
110
|
+
* **Check If Conversation Exists** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-conversation-exists)
|
|
111
|
+
* `CrispClient.website.checkConversationExists(websiteID, sessionID)`
|
|
112
|
+
* **⭐ Get A Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-conversation)
|
|
113
|
+
* `CrispClient.website.getConversation(websiteID, sessionID)`
|
|
114
|
+
* **Remove A Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-a-conversation)
|
|
115
|
+
* `CrispClient.website.removeConversation(websiteID, sessionID)`
|
|
116
|
+
* **Initiate A Conversation With Existing Session** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#initiate-a-conversation-with-existing-session)
|
|
117
|
+
* `CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID)`
|
|
118
|
+
* **⭐ Get Messages In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-messages-in-conversation)
|
|
119
|
+
* `CrispClient.website.getMessagesInConversation(websiteID, sessionID, timestampBefore)`
|
|
120
|
+
* **⭐ Send A Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#send-a-message-in-conversation)
|
|
121
|
+
* `CrispClient.website.sendMessageInConversation(websiteID, sessionID, message)`
|
|
122
|
+
* **Get A Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-message-in-conversation)
|
|
123
|
+
* `CrispClient.website.getMessageInConversation(websiteID, sessionID, fingerprint)`
|
|
124
|
+
* **Update A Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-a-message-in-conversation)
|
|
125
|
+
* `CrispClient.website.updateMessageInConversation(websiteID, sessionID, fingerprint, content)`
|
|
126
|
+
* **Compose A Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#compose-a-message-in-conversation)
|
|
127
|
+
* `CrispClient.website.composeMessageInConversation(websiteID, sessionID, compose)`
|
|
128
|
+
* **⭐ Mark Messages As Read In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#mark-messages-as-read-in-conversation)
|
|
129
|
+
* `CrispClient.website.markMessagesReadInConversation(websiteID, sessionID, read)`
|
|
130
|
+
* **⭐ Mark Messages As Delivered In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#mark-messages-as-delivered-in-conversation)
|
|
131
|
+
* `CrispClient.website.markMessagesDeliveredInConversation(websiteID, sessionID, delivered)`
|
|
132
|
+
* **Update Conversation Open State** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-conversation-open-state)
|
|
133
|
+
* `CrispClient.website.updateConversationOpenState(websiteID, sessionID, opened)`
|
|
134
|
+
* **⭐ Get Conversation Routing Assign** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-routing-assign)
|
|
135
|
+
* `CrispClient.website.getConversationRoutingAssign(websiteID, sessionID)`
|
|
136
|
+
* **⭐ Assign Conversation Routing** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#assign-conversation-routing)
|
|
137
|
+
* `CrispClient.website.assignConversationRouting(websiteID, sessionID, assign)`
|
|
138
|
+
* **⭐ Get Conversation Metas** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-metas)
|
|
139
|
+
* `CrispClient.website.getConversationMetas(websiteID, sessionID)`
|
|
140
|
+
* **⭐ Update Conversation Metas** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-conversation-metas)
|
|
141
|
+
* `CrispClient.website.updateConversationMetas(websiteID, sessionID, metas)`
|
|
142
|
+
* **Get An Original Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-an-original-message-in-conversation)
|
|
143
|
+
* `CrispClient.website.getOriginalMessageInConversation(websiteID, sessionID, originalID)`
|
|
144
|
+
* **List Conversation Pages** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-conversation-pages)
|
|
145
|
+
* `CrispClient.website.listConversationPages(websiteID, sessionID, pageNumber)`
|
|
146
|
+
* **List Conversation Events** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-conversation-events)
|
|
147
|
+
* `CrispClient.website.listConversationEvents(websiteID, sessionID, pageNumber)`
|
|
148
|
+
* **Get Conversation State** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-state)
|
|
149
|
+
* `CrispClient.website.getConversationState(websiteID, sessionID)`
|
|
150
|
+
* **⭐ Change Conversation State** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#change-conversation-state)
|
|
151
|
+
* `CrispClient.website.changeConversationState(websiteID, sessionID, state)`
|
|
152
|
+
* **Get Conversation Participants** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-participants)
|
|
153
|
+
* `CrispClient.website.getConversationParticipants(websiteID, sessionID)`
|
|
154
|
+
* **Save Conversation Participants** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-conversation-participants)
|
|
155
|
+
* `CrispClient.website.saveConversationParticipants(websiteID, sessionID, participants)`
|
|
156
|
+
* **Get Block Status For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-block-status-for-conversation)
|
|
157
|
+
* `CrispClient.website.getBlockStatusForConversation(websiteID, sessionID)`
|
|
158
|
+
* **Block Incoming Messages For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#block-incoming-messages-for-conversation)
|
|
159
|
+
* `CrispClient.website.blockIncomingMessagesForConversation(websiteID, sessionID, blocked)`
|
|
160
|
+
* **Request Email Transcript For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-email-transcript-for-conversation)
|
|
161
|
+
* `CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email)`
|
|
162
|
+
* **Request Chatbox Binding Purge For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-chatbox-binding-purge-for-conversation)
|
|
163
|
+
* `CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID)`
|
|
164
|
+
* **List Browsing Sessions For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-browsing-sessions-for-conversation)
|
|
165
|
+
* `CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID)`
|
|
166
|
+
* **Initiate Browsing Session For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#initiate-browsing-session-for-conversation)
|
|
167
|
+
* `CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID)`
|
|
168
|
+
* **Send Action To An Existing Browsing Session** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#send-action-to-an-existing-browsing-session)
|
|
169
|
+
* `CrispClient.website.sendActionToExistingBrowsingSession(websiteID, sessionID, browsingID, action)`
|
|
170
|
+
* **Assist Existing Browsing Session** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#assist-an-existing-browsing-session)
|
|
171
|
+
* `CrispClient.website.assistExistingBrowsingSession(websiteID, sessionID, browsingID, assist)`
|
|
172
|
+
* **Initiate New Call Session For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#initiate-new-call-session-for-conversation)
|
|
173
|
+
* `CrispClient.website.initiateNewCallSessionForConversation(websiteID, sessionID)`
|
|
174
|
+
* **Get Ongoing Call Session For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-ongoing-call-session-for-conversation)
|
|
175
|
+
* `CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID)`
|
|
176
|
+
* **Abort Ongoing Call Session For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#abort-ongoing-call-session-for-conversation)
|
|
177
|
+
* `CrispClient.website.abortOngoingCallSessionForConversation(websiteID, sessionID, callID)`
|
|
178
|
+
* **Transmit Signaling On Ongoing Call Session** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#transmit-signaling-on-ongoing-call-session)
|
|
179
|
+
* `CrispClient.website.transmitSignalingOnOngoingCallSession(websiteID, sessionID, callID, payload)`
|
|
180
|
+
* **Deliver Widget Button Action For Conversation** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#deliver-widget-button-action-for-conversation)
|
|
181
|
+
* `CrispClient.website.deliverWidgetButtonActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data, value)`
|
|
182
|
+
* **Deliver Widget Data Fetch Action For Conversation** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#deliver-widget-data-action-for-conversation)
|
|
183
|
+
* `CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data)`
|
|
184
|
+
* **Deliver Widget Data Edit Action For Conversation** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#deliver-widget-data-action-for-conversation)
|
|
185
|
+
* `CrispClient.website.deliverWidgetDataEditActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, value)`
|
|
186
|
+
* **Schedule A Reminder For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#schedule-a-reminder-for-conversation)
|
|
187
|
+
* `CrispClient.website.scheduleReminderForConversation(websiteID, sessionID, date, note)`
|
|
143
188
|
|
|
144
189
|
* **Website People** _(these are your end-users)_
|
|
145
|
-
* **Get People Statistics** [`user`, `plugin`]:
|
|
146
|
-
|
|
147
|
-
* **
|
|
148
|
-
|
|
149
|
-
* **Delete Suggested People
|
|
150
|
-
|
|
151
|
-
* **
|
|
152
|
-
|
|
153
|
-
* **
|
|
154
|
-
|
|
155
|
-
* **
|
|
156
|
-
|
|
157
|
-
* **
|
|
158
|
-
|
|
159
|
-
*
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
*
|
|
190
|
+
* **Get People Statistics** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-statistics)
|
|
191
|
+
* `CrispClient.website.getPeopleStatistics(websiteID)`
|
|
192
|
+
* **List Suggested People Segments** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-people-segments)
|
|
193
|
+
* `CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber)`
|
|
194
|
+
* **Delete Suggested People Segment** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-people-segment)
|
|
195
|
+
* `CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment)`
|
|
196
|
+
* **List Suggested People Data Keys** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-people-data-keys/)
|
|
197
|
+
* `CrispClient.website.listSuggestedPeopleDataKeys(websiteID, pageNumber)`
|
|
198
|
+
* **Delete Suggested People Data Key** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-people-data-key)
|
|
199
|
+
* `CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key)`
|
|
200
|
+
* **List Suggested People Events** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-people-events)
|
|
201
|
+
* `CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber)`
|
|
202
|
+
* **Delete Suggested People Event** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-people-event)
|
|
203
|
+
* `CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text)`
|
|
204
|
+
* **⭐ List People Profiles** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-profiles)
|
|
205
|
+
* `CrispClient.website.listPeopleProfiles(websiteID, pageNumber, searchField, searchOrder, searchOperator, searchFilter, searchText)`
|
|
206
|
+
* **⭐ Add New People Profile** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-new-people-profile)
|
|
207
|
+
* `CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile)`
|
|
208
|
+
* **⭐ Check If People Profile Exists** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-people-profile-exists)
|
|
209
|
+
* `CrispClient.website.checkPeopleProfileExists(websiteID, peopleID)`
|
|
210
|
+
* **⭐ Get People Profile** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-profile)
|
|
211
|
+
* `CrispClient.website.getPeopleProfile(websiteID, peopleID)`
|
|
212
|
+
* **⭐ Save People Profile** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-people-profile)
|
|
213
|
+
* `CrispClient.website.savePeopleProfile(websiteID, peopleID, peopleProfile)`
|
|
214
|
+
* **⭐ Update People Profile** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-people-profile)
|
|
215
|
+
* `CrispClient.website.updatePeopleProfile(websiteID, peopleID, peopleProfile)`
|
|
216
|
+
* **⭐ Remove People Profile** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-people-profile)
|
|
217
|
+
* `CrispClient.website.removePeopleProfile(websiteID, peopleID)`
|
|
218
|
+
* **List People Conversations** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-conversations)
|
|
219
|
+
* `CrispClient.website.listPeopleConversations(websiteID, peopleID, pageNumber)`
|
|
220
|
+
* **List People Campaigns** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-campaigns)
|
|
221
|
+
* `CrispClient.website.listPeopleCampaigns(websiteID, peopleID, pageNumber)`
|
|
222
|
+
* **Add A People Event** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-a-people-event)
|
|
223
|
+
* `CrispClient.website.addPeopleEvent(websiteID, peopleID, peopleEvent)`
|
|
224
|
+
* **List People Events** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-events)
|
|
225
|
+
* `CrispClient.website.listPeopleEvents(websiteID, peopleID, pageNumber)`
|
|
226
|
+
* **Get People Data** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-data)
|
|
227
|
+
* `CrispClient.website.getPeopleData(websiteID, peopleID)`
|
|
228
|
+
* **Save People Data** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-people-data)
|
|
229
|
+
* `CrispClient.website.savePeopleData(websiteID, peopleID, peopleData)`
|
|
230
|
+
* **Update People Data** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-people-data)
|
|
231
|
+
* `CrispClient.website.updatePeopleData(websiteID, peopleID, peopleData)`
|
|
232
|
+
* **Get People Subscription Status** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-subscription-status)
|
|
233
|
+
* `CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID)`
|
|
234
|
+
* **Update People Subscription Status** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-people-subscription-status)
|
|
235
|
+
* `CrispClient.website.updatePeopleSubscriptionStatus(websiteID, peopleID, peopleSubscription)`
|
|
236
|
+
* **Export People Profiles** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#export-people-profiles)
|
|
237
|
+
* `CrispClient.website.exportPeopleProfiles(websiteID)`
|
|
238
|
+
* **Import People Profiles** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#import-people-profiles)
|
|
239
|
+
* `CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup)`
|
|
170
240
|
|
|
171
241
|
_👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
172
242
|
|
|
173
243
|
* **Website Base**
|
|
174
|
-
* **Check If Website Exists** [`user`, `plugin`]:
|
|
175
|
-
|
|
176
|
-
* **
|
|
177
|
-
|
|
244
|
+
* **Check If Website Exists** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-website-exists)
|
|
245
|
+
* `CrispClient.website.checkWebsiteExists(domain)`
|
|
246
|
+
* **Create Website** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-website)
|
|
247
|
+
* `CrispClient.website.createWebsite(websiteData)`
|
|
248
|
+
* **Get A Website** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-website)
|
|
249
|
+
* `CrispClient.website.getWebsite(websiteID)`
|
|
250
|
+
* **Delete A Website** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-a-website)
|
|
251
|
+
* `CrispClient.website.deleteWebsite(websiteID, verify)`
|
|
178
252
|
|
|
179
253
|
* **Website Settings**
|
|
180
|
-
* **Get Website Settings** [`user`, `plugin`]:
|
|
181
|
-
|
|
254
|
+
* **Get Website Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-website-settings)
|
|
255
|
+
* `CrispClient.website.getWebsiteSettings(websiteID)`
|
|
256
|
+
* **Update Website Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-website-settings)
|
|
257
|
+
* `CrispClient.website.updateWebsiteSettings(websiteID, settings)`
|
|
182
258
|
|
|
183
259
|
* **Website Operator**
|
|
184
|
-
* **List Website Operators** [`user`, `plugin`]:
|
|
185
|
-
|
|
186
|
-
* **
|
|
187
|
-
|
|
188
|
-
* **
|
|
189
|
-
|
|
190
|
-
* **
|
|
191
|
-
|
|
260
|
+
* **List Website Operators** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-website-operators)
|
|
261
|
+
* `CrispClient.website.listWebsiteOperators(websiteID)`
|
|
262
|
+
* **List Last Active Website Operators** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-last-active-website-operators)
|
|
263
|
+
* `CrispClient.website.listLastActiveWebsiteOperators(websiteID)`
|
|
264
|
+
* **Flush Last Active Website Operators** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#flush-last-active-website-operators)
|
|
265
|
+
* `CrispClient.website.flushLastActiveWebsiteOperators(websiteID)`
|
|
266
|
+
* **Send Email To Website Operators** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#send-email-to-website-operators)
|
|
267
|
+
* `CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData)`
|
|
268
|
+
* **Get A Website Operator** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-website-operator)
|
|
269
|
+
* `CrispClient.website.getWebsiteOperator(websiteID, userID)`
|
|
270
|
+
* **Invite A Website Operator** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#invite-a-website-operator)
|
|
271
|
+
* `CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify)`
|
|
272
|
+
* **Change Operator Membership** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#change-operator-membership)
|
|
273
|
+
* `CrispClient.website.changeOperatorMembership(websiteID, userID, role, title)`
|
|
274
|
+
* **Unlink Operator From Website** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#unlink-operator-from-website)
|
|
275
|
+
* `CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID)`
|
|
192
276
|
|
|
193
277
|
* **Website Visitors**
|
|
194
|
-
* **Count Visitors** [`user`, `plugin`]:
|
|
195
|
-
|
|
196
|
-
* **
|
|
197
|
-
|
|
198
|
-
* **
|
|
199
|
-
|
|
200
|
-
* **
|
|
278
|
+
* **Count Visitors** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#count-visitors)
|
|
279
|
+
* `CrispClient.website.countVisitors(websiteID)`
|
|
280
|
+
* **List Visitors** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-visitors)
|
|
281
|
+
* `CrispClient.website.listVisitors(websiteID, pageNumber)`
|
|
282
|
+
* **Pinpoint Visitors On A Map** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#pinpoint-visitors-on-a-map)
|
|
283
|
+
* `CrispClient.website.pinpointVisitorsOnMap(websiteID, centerLongitude, centerLatitude, centerRadius)`
|
|
284
|
+
* **Get Session Identifier From Token** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-session-identifier-from-token)
|
|
285
|
+
* `CrispClient.website.getSessionIdentifierFromToken(websiteID, tokenID)`
|
|
286
|
+
* **Count Blocked Visitors** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#count-blocked-visitors/)
|
|
287
|
+
* `CrispClient.website.countBlockedVisitors(websiteID)`
|
|
288
|
+
* **Count Blocked Visitors In Rule** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#count-blocked-visitors-in-rule)
|
|
289
|
+
* `CrispClient.website.countBlockedVisitorsInRule(websiteID, rule)`
|
|
290
|
+
* **Clear Blocked Visitors In Rule** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#clear-blocked-visitors-in-rule)
|
|
291
|
+
* `CrispClient.website.clearBlockedVisitorsInRule(websiteID, rule)`
|
|
201
292
|
|
|
202
293
|
* **Website Availability**
|
|
203
|
-
* **Get Website Availability Status** [`user`, `plugin`]:
|
|
204
|
-
|
|
294
|
+
* **Get Website Availability Status** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-website-availability-status)
|
|
295
|
+
* `CrispClient.website.getWebsiteAvailabilityStatus(websiteID)`
|
|
296
|
+
* **List Website Operator Availabilities** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-website-operator-availabilities)
|
|
297
|
+
* `CrispClient.website.listWebsiteOperatorAvailabilities(websiteID)`
|
|
205
298
|
|
|
206
299
|
* **Website Analytics**
|
|
207
|
-
* **Acquire Analytics Points** [`user`]:
|
|
208
|
-
|
|
209
|
-
* **List Analytics
|
|
300
|
+
* **Acquire Analytics Points** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#acquire-analytics-points)
|
|
301
|
+
* `CrispClient.website.acquireAnalyticsPoints(websiteID, pointType, pointMetric, dateFrom, dateTo, dateSplit, classifier, filterPrimary, filterSecondary, filterTertiary)`
|
|
302
|
+
* **List Analytics Filters** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-analytics-filters)
|
|
303
|
+
* `CrispClient.website.listAnalyticsFilters(websiteID, pageNumber, pointType, pointMetric, dateFrom, dateTo)`
|
|
304
|
+
* **List Analytics Classifiers** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-analytics-classifiers)
|
|
305
|
+
* `CrispClient.website.listAnalyticsClassifiers(websiteID, pageNumber, pointType, pointMetric, dateFrom, dateTo)`
|
|
210
306
|
|
|
211
307
|
* **Website Batch**
|
|
212
|
-
* **Batch Resolve Conversations** [`user`]:
|
|
213
|
-
|
|
214
|
-
* **Batch
|
|
215
|
-
|
|
308
|
+
* **Batch Resolve Conversations** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-resolve-items)
|
|
309
|
+
* `CrispClient.website.batchResolveConversations(websiteID, sessions)`
|
|
310
|
+
* **Batch Read Conversations** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-read-items)
|
|
311
|
+
* `CrispClient.website.batchReadConversations(websiteID, sessions)`
|
|
312
|
+
* **Batch Remove Conversations** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-remove-items)
|
|
313
|
+
* `CrispClient.website.batchRemoveConversations(websiteID, sessions)`
|
|
314
|
+
* **Batch Remove People** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#batch-remove-items)
|
|
315
|
+
* `CrispClient.website.batchRemovePeople(websiteID, people)`
|
|
216
316
|
|
|
217
317
|
* **Website Verify**
|
|
218
|
-
* **Get Verify Settings** [`user`, `plugin`]:
|
|
219
|
-
|
|
220
|
-
* **
|
|
221
|
-
|
|
318
|
+
* **Get Verify Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-verify-settings)
|
|
319
|
+
* `CrispClient.website.getVerifySettings(websiteID)`
|
|
320
|
+
* **Update Verify Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-verify-settings)
|
|
321
|
+
* `CrispClient.website.updateVerifySettings(websiteID, settings)`
|
|
322
|
+
* **Get Verify Key** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-verify-key)
|
|
323
|
+
* `CrispClient.website.getVerifyKey(websiteID)`
|
|
324
|
+
* **Roll Verify Key** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#roll-verify-key)
|
|
325
|
+
* `CrispClient.website.rollVerifyKey(websiteID)`
|
|
222
326
|
|
|
223
327
|
* **Website Campaigns**
|
|
224
|
-
* **List Campaigns** [`user`]:
|
|
225
|
-
|
|
226
|
-
* **List Campaign
|
|
227
|
-
|
|
228
|
-
* **
|
|
229
|
-
|
|
230
|
-
* **
|
|
231
|
-
|
|
232
|
-
* **
|
|
328
|
+
* **List Campaigns** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-campaigns)
|
|
329
|
+
* `CrispClient.website.listCampaigns(websiteID, pageNumber)`
|
|
330
|
+
* **List Campaign Tags** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-campaign-tags)
|
|
331
|
+
* `CrispClient.website.listCampaignTags(websiteID)`
|
|
332
|
+
* **List Campaign Templates** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-campaign-templates)
|
|
333
|
+
* `CrispClient.website.listCampaignTemplates(websiteID, pageNumber)`
|
|
334
|
+
* **Create A New Campaign Template** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-a-new-campaign-template)
|
|
335
|
+
* `CrispClient.website.createNewCampaignTemplate(websiteID, templateFormat, templateName)`
|
|
336
|
+
* **Check If Campaign Template Exists** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-campaign-template-exists)
|
|
337
|
+
* `CrispClient.website.checkCampaignTemplateExists(websiteID, templateID)`
|
|
338
|
+
* **Get A Campaign Template** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-campaign-template)
|
|
339
|
+
* `CrispClient.website.getCampaignTemplate(websiteID, templateID)`
|
|
340
|
+
* **Save A Campaign Template** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-a-campaign-template)
|
|
341
|
+
* `CrispClient.website.saveCampaignTemplate(websiteID, templateID, template)`
|
|
342
|
+
* **Update A Campaign Template** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-a-campaign-template)
|
|
343
|
+
* `CrispClient.website.updateCampaignTemplate(websiteID, templateID, template)`
|
|
344
|
+
* **Remove A Campaign Template** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-a-campaign-template)
|
|
345
|
+
* `CrispClient.website.removeCampaignTemplate(websiteID, templateID)`
|
|
233
346
|
|
|
234
347
|
* **Website Campaign**
|
|
235
|
-
* **Create A New Campaign** [`user`]:
|
|
236
|
-
|
|
237
|
-
* **
|
|
238
|
-
|
|
239
|
-
* **
|
|
240
|
-
|
|
241
|
-
* **
|
|
242
|
-
|
|
243
|
-
* **
|
|
244
|
-
|
|
245
|
-
* **
|
|
246
|
-
|
|
348
|
+
* **Create A New Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-a-new-campaign)
|
|
349
|
+
* `CrispClient.website.createNewCampaign(websiteID, campaignType, campaignName)`
|
|
350
|
+
* **Check If Campaign Exists** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-campaign-exists)
|
|
351
|
+
* `CrispClient.website.checkCampaignExists(websiteID, campaignID)`
|
|
352
|
+
* **Get A Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-campaign)
|
|
353
|
+
* `CrispClient.website.getCampaign(websiteID, campaignID)`
|
|
354
|
+
* **Save A Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-a-campaign)
|
|
355
|
+
* `CrispClient.website.saveCampaign(websiteID, campaignID, campaign)`
|
|
356
|
+
* **Update A Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-a-campaign)
|
|
357
|
+
* `CrispClient.website.updateCampaign(websiteID, campaignID, campaign)`
|
|
358
|
+
* **Remove A Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-a-campaign)
|
|
359
|
+
* `CrispClient.website.removeCampaign(websiteID, campaignID)`
|
|
360
|
+
* **Dispatch A Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#dispatch-a-campaign)
|
|
361
|
+
* `CrispClient.website.dispatchCampaign(websiteID, campaignID)`
|
|
362
|
+
* **Resume A Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resume-a-campaign)
|
|
363
|
+
* `CrispClient.website.resumeCampaign(websiteID, campaignID)`
|
|
364
|
+
* **Pause A Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#pause-a-campaign)
|
|
365
|
+
* `CrispClient.website.pauseCampaign(websiteID, campaignID)`
|
|
366
|
+
* **Test A Campaign** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#test-a-campaign)
|
|
367
|
+
* `CrispClient.website.testCampaign(websiteID, campaignID)`
|
|
368
|
+
* **List Campaign Recipients** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-campaign-recipients)
|
|
369
|
+
* `CrispClient.website.listCampaignRecipients(websiteID, campaignID, pageNumber)`
|
|
370
|
+
* **List Campaign Statistics** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-campaign-statistics)
|
|
371
|
+
* `CrispClient.website.listCampaignStatistics(websiteID, campaignID, action, pageNumber)`
|
|
247
372
|
|
|
248
373
|
### Plugin
|
|
249
374
|
|
|
250
375
|
* **Plugin Connect**
|
|
251
|
-
*
|
|
252
|
-
|
|
253
|
-
*
|
|
376
|
+
* **⭐ Get Connect Account** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-connect-account)
|
|
377
|
+
* `CrispClient.plugin.getConnectAccount()`
|
|
378
|
+
* **⭐ Check Connect Session Validity** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-connect-session-validity)
|
|
379
|
+
* `CrispClient.plugin.checkConnectSessionValidity()`
|
|
380
|
+
* **⭐ List All Connect Websites** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-all-connect-websites)
|
|
381
|
+
* `CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured, dateSince)`
|
|
254
382
|
|
|
255
383
|
* **Plugin Subscription**
|
|
256
|
-
* **List All Active Subscriptions** [`user`]:
|
|
257
|
-
|
|
258
|
-
* **
|
|
259
|
-
|
|
260
|
-
* **
|
|
261
|
-
|
|
262
|
-
* **
|
|
263
|
-
|
|
264
|
-
* **
|
|
265
|
-
|
|
384
|
+
* **List All Active Subscriptions** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-all-active-subscriptions)
|
|
385
|
+
* `CrispClient.plugin.listAllActiveSubscriptions()`
|
|
386
|
+
* **List Subscriptions For A Website** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-subscriptions-for-a-website)
|
|
387
|
+
* `CrispClient.plugin.listSubscriptionsForWebsite(websiteID)`
|
|
388
|
+
* **Get Subscription Details** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-subscription-details)
|
|
389
|
+
* `CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID)`
|
|
390
|
+
* **Subscribe Website To Plugin** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#subscribe-website-to-plugin)
|
|
391
|
+
* `CrispClient.plugin.subscribeWebsiteToPlugin(websiteID, pluginID)`
|
|
392
|
+
* **Unsubscribe Plugin From Website** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#unsubscribe-plugin-from-website)
|
|
393
|
+
* `CrispClient.plugin.unsubscribePluginFromWebsite(websiteID, pluginID)`
|
|
394
|
+
* **Get Subscription Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-subscription-settings)
|
|
395
|
+
* `CrispClient.plugin.getSubscriptionSettings(websiteID, pluginID)`
|
|
396
|
+
* **Save Subscription Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-subscription-settings)
|
|
397
|
+
* `CrispClient.plugin.saveSubscriptionSettings(websiteID, pluginID, settings)`
|
|
398
|
+
* **Update Subscription Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-subscription-settings)
|
|
399
|
+
* `CrispClient.plugin.updateSubscriptionSettings(websiteID, pluginID, settings)`
|
|
400
|
+
* **Forward Plugin Payload To Channel** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#forward-plugin-payload-to-channel)
|
|
401
|
+
* `CrispClient.plugin.forwardPluginPayloadToChannel(websiteID, pluginID, payload)`
|
|
402
|
+
* **Dispatch Plugin Event** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#dispatch-plugin-event)
|
|
403
|
+
* `CrispClient.plugin.dispatchPluginEvent(websiteID, pluginID, payload)`
|
|
266
404
|
|
|
267
405
|
### Media
|
|
268
406
|
|
|
269
|
-
* **
|
|
270
|
-
* **List Animation Medias** [`user`]:
|
|
407
|
+
* **Media Animation**
|
|
408
|
+
* **List Animation Medias** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-animation-medias)
|
|
409
|
+
* `CrispClient.media.listAnimationMedias(pageNumber, listID, searchQuery)`
|
|
271
410
|
|
|
272
411
|
### Bucket
|
|
273
412
|
|
|
274
|
-
* **
|
|
275
|
-
* **Generate Bucket URL** [`user`, `plugin`]:
|
|
413
|
+
* **Bucket URL**
|
|
414
|
+
* **Generate Bucket URL** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#bucket-url)
|
|
415
|
+
* `CrispClient.bucket.generateBucketURL(data)`
|
|
276
416
|
|
|
277
417
|
## Realtime Events
|
|
278
418
|
|
|
@@ -282,97 +422,166 @@ You won't receive any event if you don't explicitly subscribe to realtime events
|
|
|
282
422
|
|
|
283
423
|
Available events are listed below:
|
|
284
424
|
|
|
285
|
-
* **Session Events
|
|
286
|
-
* **Session Update Availability** [`user`, `plugin`]:
|
|
287
|
-
|
|
288
|
-
* **Session
|
|
289
|
-
|
|
290
|
-
* **Session
|
|
291
|
-
|
|
292
|
-
* **Session Set
|
|
293
|
-
|
|
294
|
-
* **Session Set
|
|
295
|
-
|
|
296
|
-
* **Session
|
|
297
|
-
|
|
298
|
-
* **Session
|
|
299
|
-
|
|
300
|
-
* **Session
|
|
301
|
-
|
|
302
|
-
* **Session
|
|
303
|
-
|
|
304
|
-
* **Session
|
|
305
|
-
|
|
306
|
-
* **Session
|
|
307
|
-
|
|
308
|
-
* **Session
|
|
309
|
-
|
|
310
|
-
* **Session
|
|
311
|
-
|
|
312
|
-
* **Session
|
|
313
|
-
|
|
314
|
-
* **
|
|
315
|
-
|
|
316
|
-
* **
|
|
317
|
-
|
|
318
|
-
* **
|
|
319
|
-
|
|
320
|
-
* **
|
|
321
|
-
|
|
322
|
-
* **
|
|
323
|
-
|
|
324
|
-
* **
|
|
325
|
-
|
|
326
|
-
* **
|
|
327
|
-
|
|
328
|
-
* **
|
|
329
|
-
|
|
330
|
-
* **
|
|
331
|
-
|
|
332
|
-
* **
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
*
|
|
336
|
-
* **
|
|
337
|
-
|
|
338
|
-
* **
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
* **
|
|
343
|
-
|
|
344
|
-
* **
|
|
345
|
-
|
|
346
|
-
* **
|
|
347
|
-
|
|
348
|
-
* **
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
*
|
|
352
|
-
* **
|
|
353
|
-
|
|
354
|
-
* **
|
|
355
|
-
|
|
356
|
-
* **
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
*
|
|
360
|
-
* **
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
* **
|
|
365
|
-
|
|
366
|
-
* **
|
|
367
|
-
|
|
368
|
-
* **
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
*
|
|
372
|
-
* **
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
*
|
|
376
|
-
* **
|
|
377
|
-
|
|
378
|
-
|
|
425
|
+
* **Session Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#session-events)
|
|
426
|
+
* **Session Update Availability** [`user`, `plugin`]:
|
|
427
|
+
* `session:update_availability`
|
|
428
|
+
* **Session Update Verify** [`user`, `plugin`]:
|
|
429
|
+
* `session:update_verify`
|
|
430
|
+
* **Session Request Initiated** [`user`, `plugin`]:
|
|
431
|
+
* `session:request:initiated`
|
|
432
|
+
* **Session Set Email** [`user`, `plugin`]:
|
|
433
|
+
* `session:set_email`
|
|
434
|
+
* **Session Set Phone** [`user`, `plugin`]:
|
|
435
|
+
* `session:set_phone`
|
|
436
|
+
* **Session Set Address** [`user`, `plugin`]:
|
|
437
|
+
* `session:set_address`
|
|
438
|
+
* **Session Set Avatar** [`user`, `plugin`]:
|
|
439
|
+
* `session:set_avatar`
|
|
440
|
+
* **Session Set Nickname** [`user`, `plugin`]:
|
|
441
|
+
* `session:set_nickname`
|
|
442
|
+
* **Session Set Data** [`user`, `plugin`]:
|
|
443
|
+
* `session:set_data`
|
|
444
|
+
* **Session Sync Pages** [`user`, `plugin`]:
|
|
445
|
+
* `session:sync:pages`
|
|
446
|
+
* **Session Sync Events** [`user`, `plugin`]:
|
|
447
|
+
* `session:sync:events`
|
|
448
|
+
* **Session Sync Capabilities** [`user`, `plugin`]:
|
|
449
|
+
* `session:sync:capabilities`
|
|
450
|
+
* **Session Sync Geolocation** [`user`, `plugin`]:
|
|
451
|
+
* `session:sync:geolocation`
|
|
452
|
+
* **Session Sync System** [`user`, `plugin`]:
|
|
453
|
+
* `session:sync:system`
|
|
454
|
+
* **Session Sync Network** [`user`, `plugin`]:
|
|
455
|
+
* `session:sync:network`
|
|
456
|
+
* **Session Sync Timezone** [`user`, `plugin`]:
|
|
457
|
+
* `session:sync:timezone`
|
|
458
|
+
* **Session Sync Locales** [`user`, `plugin`]:
|
|
459
|
+
* `session:sync:locales`
|
|
460
|
+
* **Session Sync Rating** [`user`, `plugin`]:
|
|
461
|
+
* `session:sync:rating`
|
|
462
|
+
* **Session Set State** [`user`, `plugin`]:
|
|
463
|
+
* `session:set_state`
|
|
464
|
+
* **Session Set Block** [`user`, `plugin`]:
|
|
465
|
+
* `session:set_block`
|
|
466
|
+
* **Session Set Segments** [`user`, `plugin`]:
|
|
467
|
+
* `session:set_segments`
|
|
468
|
+
* **Session Set Opened** [`user`, `plugin`]:
|
|
469
|
+
* `session:set_opened`
|
|
470
|
+
* **Session Set Closed** [`user`, `plugin`]:
|
|
471
|
+
* `session:set_closed`
|
|
472
|
+
* **Session Set Participants** [`user`, `plugin`]:
|
|
473
|
+
* `session:set_participants`
|
|
474
|
+
* **Session Set Mentions** [`user`, `plugin`]:
|
|
475
|
+
* `session:set_mentions`
|
|
476
|
+
* **Session Set Routing** [`user`, `plugin`]:
|
|
477
|
+
* `session:set_routing`
|
|
478
|
+
* **Session Removed** [`user`, `plugin`]:
|
|
479
|
+
* `session:removed`
|
|
480
|
+
|
|
481
|
+
* **Message Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#message-events)
|
|
482
|
+
* **Message Updated** [`user`, `plugin`]:
|
|
483
|
+
* `message:updated`
|
|
484
|
+
* **Message Send** [`user`, `plugin`]:
|
|
485
|
+
* `message:send`
|
|
486
|
+
* **Message Received** [`user`, `plugin`]:
|
|
487
|
+
* `message:received`
|
|
488
|
+
* **Message Compose Send** [`user`, `plugin`]:
|
|
489
|
+
* `message:compose:send`
|
|
490
|
+
* **Message Compose Receive** [`user`, `plugin`]:
|
|
491
|
+
* `message:compose:receive`
|
|
492
|
+
* **Message Acknowledge Read Send** [`user`, `plugin`]:
|
|
493
|
+
* `message:acknowledge:read:send`
|
|
494
|
+
* **Message Acknowledge Read Received** [`user`, `plugin`]:
|
|
495
|
+
* `message:acknowledge:read:received`
|
|
496
|
+
* **Message Acknowledge Delivered** [`user`, `plugin`]:
|
|
497
|
+
* `message:acknowledge:delivered`
|
|
498
|
+
* **Message Notify Unread Send** [`user`, `plugin`]:
|
|
499
|
+
* `message:notify:unread:send`
|
|
500
|
+
* **Message Notify Unread Received** [`user`, `plugin`]:
|
|
501
|
+
* `message:notify:unread:received`
|
|
502
|
+
|
|
503
|
+
* **People Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#people-events)
|
|
504
|
+
* **People Profile Created** [`user`, `plugin`]:
|
|
505
|
+
* `people:profile:created`
|
|
506
|
+
* **People Profile Updated** [`user`, `plugin`]:
|
|
507
|
+
* `people:profile:updated`
|
|
508
|
+
* **People Profile Removed** [`user`, `plugin`]:
|
|
509
|
+
* `people:profile:removed`
|
|
510
|
+
* **People Bind Session** [`user`, `plugin`]:
|
|
511
|
+
* `people:bind:session`
|
|
512
|
+
* **People Sync Profile** [`user`, `plugin`]:
|
|
513
|
+
* `people:sync:profile`
|
|
514
|
+
* **People Import Progress** [`user`]:
|
|
515
|
+
* `people:import:progress`
|
|
516
|
+
* **People Import Done** [`user`]:
|
|
517
|
+
* `people:import:done`
|
|
518
|
+
|
|
519
|
+
* **Campaign Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#campaign-events)
|
|
520
|
+
* **Campaign Progress** [`user`]:
|
|
521
|
+
* `campaign:progress`
|
|
522
|
+
* **Campaign Dispatched** [`user`]:
|
|
523
|
+
* `campaign:dispatched`
|
|
524
|
+
* **Campaign Running** [`user`]:
|
|
525
|
+
* `campaign:running`
|
|
526
|
+
|
|
527
|
+
* **Browsing Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#browsing-events)
|
|
528
|
+
* **Browsing Request Initiated** [`user`, `plugin`]:
|
|
529
|
+
* `browsing:request:initiated`
|
|
530
|
+
* **Browsing Request Rejected** [`user`, `plugin`]:
|
|
531
|
+
* `browsing:request:rejected`
|
|
532
|
+
|
|
533
|
+
* **Call Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#call-events)
|
|
534
|
+
* **Call Request Initiated** [`user`, `plugin`]:
|
|
535
|
+
* `call:request:initiated`
|
|
536
|
+
* **Call Request Rejected** [`user`, `plugin`]:
|
|
537
|
+
* `call:request:rejected`
|
|
538
|
+
|
|
539
|
+
* **Widget Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#widget-events)
|
|
540
|
+
* **Widget Action Processed** [`user`]:
|
|
541
|
+
* `widget:action:processed`
|
|
542
|
+
|
|
543
|
+
* **Status Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#status-events)
|
|
544
|
+
* **Status Health Changed** [`user`]:
|
|
545
|
+
* `status:health:changed`
|
|
546
|
+
|
|
547
|
+
* **Website Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#website-events)
|
|
548
|
+
* **Website Update Visitors Count** [`user`, `plugin`]:
|
|
549
|
+
* `website:update_visitors_count`
|
|
550
|
+
* **Website Update Operators Availability** [`user`, `plugin`]:
|
|
551
|
+
* `website:update_operators_availability`
|
|
552
|
+
* **Website Users Available** [`user`, `plugin`]:
|
|
553
|
+
* `website:users:available`
|
|
554
|
+
|
|
555
|
+
* **Bucket Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#bucket-events)
|
|
556
|
+
* **Bucket URL Upload Generated** [`user`, `plugin`]:
|
|
557
|
+
* `bucket:url:upload:generated`
|
|
558
|
+
* **Bucket URL Avatar Generated** [`user`, `plugin`]:
|
|
559
|
+
* `bucket:url:avatar:generated`
|
|
560
|
+
* **Bucket URL Website Generated** [`user`, `plugin`]:
|
|
561
|
+
* `bucket:url:website:generated`
|
|
562
|
+
* **Bucket URL Campaign Generated** [`user`, `plugin`]:
|
|
563
|
+
* `bucket:url:campaign:generated`
|
|
564
|
+
* **Bucket URL Helpdesk Generated** [`user`, `plugin`]:
|
|
565
|
+
* `bucket:url:helpdesk:generated`
|
|
566
|
+
* **Bucket URL Status Generated** [`user`, `plugin`]:
|
|
567
|
+
* `bucket:url:status:generated`
|
|
568
|
+
* **Bucket URL Processing Generated** [`user`, `plugin`]:
|
|
569
|
+
* `bucket:url:processing:generated`
|
|
570
|
+
|
|
571
|
+
* **Media Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#media-events)
|
|
572
|
+
* **Media Animation Listed** [`user`]:
|
|
573
|
+
* `media:animation:listed`
|
|
574
|
+
|
|
575
|
+
* **Email Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#email-events)
|
|
576
|
+
* **Email Subscribe** [`user`, `plugin`]:
|
|
577
|
+
* `email:subscribe`
|
|
578
|
+
* **Email Track View** [`user`, `plugin`]:
|
|
579
|
+
* `email:track:view`
|
|
580
|
+
|
|
581
|
+
* **Plugin Events**: [Reference](https://docs.crisp.chat/references/rtm-api/v1/#plugin-events)
|
|
582
|
+
* **Plugin Channel** [`user`, `plugin`]:
|
|
583
|
+
* `plugin:channel`
|
|
584
|
+
* **Plugin Event** [`user`, `plugin`]:
|
|
585
|
+
* `plugin:event`
|
|
586
|
+
* **Plugin Settings Saved** [`user`, `plugin`]:
|
|
587
|
+
* `plugin:settings:saved`
|
package/package.json
CHANGED