Endpoints
Analytics
Method | Endpoint | Description |
---|---|---|
GET | /api/analytics/chat/bot_funnels | A list of chat bot funnel statistics from a date range |
GET | /api/analytics/chat/info | A list of chats from a date range |
GET | /api/analytics/chat/survey/info | A list of chat surveys from a date range |
GET | /api/analytics/chat/survey/info/{id} | Details for the specified survey |
GET | /api/analytics/operators/activity | Online and offline activity for operators |
GET | /api/analytics/operator/{id}/activity | Online and offline activity for the operator |
GET | /api/analytics/operators/stats | Daily operators statistics |
GET | /api/analytics/operator/{id}/stats | Daily operator statistics |
Attachment
Method | Endpoint | Description |
---|---|---|
PUT | /api/attachment/{system} | Upload a new attachment |
POST | /api/attachment/{id} | Update an attachment |
PUT | /api/attachment/{system}/{id} | Upload a new attachment |
Callback
Method | Endpoint | Description |
---|---|---|
GET | /api/callbacks | A list of callbacks |
GET | /api/callback_filters | A list of callback filters for an operator |
GET | /api/callback_filters/options | The available options for a new callback filter |
PUT | /api/callback | Create a new callback with the specified data |
GET | /api/callback/search | Generic search for callbacks |
GET | /api/callback/{id} | Get the information for the specified callback |
DELETE | /api/callback/{id} | Delete the specified callback |
POST | /api/callback/{id}/accept | An operator accepts the callback |
POST | /api/callback/{id}/assign | Assign an operator or department to the specified callback |
POST | /api/callback/{id}/reassign | Reassign the specified callback to an operator or department |
POST | /api/callback/{id}/comment | Add a comment to the specified callback |
Canned Responses
Method | Endpoint | Description |
---|---|---|
GET | /api/canned_sets | A list of available canned sets |
GET | /api/canned_sets/{id}/items | A list of the canned set items |
Chat
Method | Endpoint | Description |
---|---|---|
POST | /api/chat/create | Start a new chat |
POST | /api/chat/{id}/accept | Accept the specified chat |
POST | /api/chat/{id}/email_transcript | Email the current transcript for the specified chat |
POST | /api/chat/{id}/history | Get previous messages for a specific chat |
POST | /api/chat/{id}/message | Insert a message into the specified chat |
POST | /api/chat/proactive_invite | Send a proactive invitation to a visitor |
POST | /api/chat/{id}/reassign | Reassign the specified chat to a department or operator |
POST | /api/chat/{id}/set_typing_status | Update the typing status for the specified chat |
POST | /api/chat/{id}/terminate | Terminate the specified chat |
POST | /api/chat/offline | Submit a new offline message |
Client
Method | Endpoint | Description |
---|---|---|
PUT | /api/client | Creates a Client Account |
GET | /api/client/status | Get the current online/offline status for the client |
Departments
Method | Endpoint | Description |
---|---|---|
GET | /api/departments | A list of departments |
GET | /api/department/{id} | Information for a specific department |
GET | /api/department/{id}/status | Online status for a specific department |
Filter
Method | Endpoint | Description |
---|---|---|
DELETE | /api/filter/{id}/ | Delete an existing system filter |
GET | /api/filter/{id} | Get filter details |
POST | /api/filter/{id} | Update filter content |
PUT | /api/filter/{system}/create | Create a new filter |
Knowledge Base
Method | Endpoint | Description |
---|---|---|
PUT | /api/kb/article | Create a new knowledge base article |
DELETE | /api/kb/article/{id} | Delete a knowledge base article |
POST | /api/kb/article/{id} | Update a knowledge base article |
GET | /api/kb/articles | A list of knowledge base articles |
GET | /api/kb/article/search | Generic search knowledge base articles |
GET | /api/kb/category/{id} | Information for the specific category |
GET | /api/kb/categories | A list of knowledge base categories |
GET | /api/kb/article/search | Generic search knowledge base articles |
GET | /api/kb_filters | A list of knowledge filters available for an operator |
GET | /api/kb_filters/options | The available options for a new knowledge filter |
Operators
Method | Endpoint | Description |
---|---|---|
GET | /api/operators | A list of operators |
PUT | /api/operator/device_token | Create new operator device token |
DELETE | /api/operator/device_token | Delete operator device token |
GET | /api/operator/{id} | Information for a specific operator |
GET | /api/operator/{id}/status | Online status for a specific operator |
POST | /api/operator/{id}/status/{status} | Set the online status for an operator(s) |
Survey
Method | Endpoint | Description |
---|---|---|
PUT | /api/survey | Insert a new survey |
Tickets
Method | Endpoint | Description |
---|---|---|
GET | /api/tickets | Obtain a list of tickets |
PUT | /api/ticket | Create a new ticket |
DELETE | /api/ticket/{id} | Delete the provided ticket |
GET | /api/ticket/{id} | Get the ticket details |
POST | /api/ticket/{id} | Update the provided ticket |
POST | /api/ticket/{id}/accept | Accept the provided ticket |
POST | /api/ticket/{id}/acknowledge | Acknowledge the provided ticket |
POST | /api/ticket/{id}/assign | Assign the provided ticket |
POST | /api/ticket/{id}/comment | Add comment to the provided ticket |
POST | /api/ticket/{id}/reassign | Reassign the provided ticket |
POST | /api/ticket/{id}/resolve | Resolve the provided ticket |
POST | /api/ticket/{id}/tag | Tag the provided ticket |
GET | /api/ticket/categories | Obtain a list of available ticket categories |
GET | /api/ticket/priorities | Obtain a list of available ticket priorites |
GET | /api/ticket/search | Generic search for tickets |
GET | /api/ticket_filters | Obtain a list of available ticket filter |
GET | /api/ticket_filters/options | Obtain a list of available ticket filter options |
Visitors
Method | Endpoint | Description |
---|---|---|
GET | /api/visitors | A list of current visitors based on filter |
GET | /api/visitor_filters | A list of visitors filters allowed for the operator |
POST | /api/visitor/init | Initalize a visitor (Track browsing and general information) |
POST | /api/visitor/create | Create a new visitor |
GET | /api/visitor/{id} | Information for a specific visitor |
GET | /api/visitor/{id}/call_history | Information for a specific visitor's previous communications |
POST | /api/visitor/{id}/custom_info | Update the visitors custom information |
GET | /api/visitor/{id}/nav_history | Information for a specific visitor's previous navigation |
PUT | /api/visitor/{id}/note | Supply a new visitor note |