Livechat Methods
Manage Livechat related data:
| Url | HTTP Method | Short Description | Details Page |
|---|---|---|---|
/api/v1/livechat/users/:type |
GET |
Get a list of agents or managers. | info |
/api/v1/livechat/users/:type |
POST |
Create a new Livechat agent or manager. | info |
/api/v1/livechat/users/:type/:_id |
GET |
Retrieve agent or manager data. | info |
/api/v1/livechat/users/:type/:_id |
DELETE |
Removes a Livechat agent or manager. | info |
/api/v1/livechat/department |
GET |
Get a list of Livechat departments. | info |
/api/v1/livechat/department |
POST |
Creates a new Livechat department. | info |
/api/v1/livechat/department/:_id |
GET |
Retrieve a Livechat department data. | info |
/api/v1/livechat/department/:_id |
PUT |
Updates a Livechat department data. | info |
/api/v1/livechat/department/:_id |
DELETE |
Delete a Livechat department. | info |
/api/v1/livechat/sms-incoming/:service |
POST |
Send SMS messages to pimentaCHAT. | info |
/api/v1/livechat/agent.info/:rid/:token |
GET |
Retrieve the current Livechat agent data. | info |
/api/v1/livechat/agent.next/:token |
GET |
Request the next Livechat agent available. | info |
/api/v1/livechat/config/:token |
GET |
Get basic Livechat widget configuration info and additional visitor data. | info |
/api/v1/livechat/custom.field |
POST |
Send a Livechat custom field. | info |
/api/v1/livechat/custom.fields |
POST |
Send an array of Livechat custom fields. | info |
/api/v1/livechat/message |
POST |
Send a new Livechat message. | info |
/api/v1/livechat/message/:_id |
PUT |
Updates a Livechat message data. | info |
/api/v1/livechat/message/:_id |
DELETE |
Delete a Livechat message. | info |
/api/v1/livechat/messages.history/:rid |
GET |
Load Livechat messages history. | info |
/api/v1/livechat/offline.message |
POST |
Send a new Livechat offline message. | info |
/api/v1/livechat/room |
GET |
Get the Livechat room data or open a new room. | info |
/api/v1/livechat/room.close |
POST |
Close a Livechat room. | info |
/api/v1/livechat/room.transfer |
POST |
Transfer a Livechat room to another agent or department. | info |
/api/v1/livechat/room.survey |
POST |
Send a Livechat survey to pimentaCHAT. | info |
/api/v1/livechat/transcript |
POST |
Request a Livechat transcript. | info |
/api/v1/livechat/video.call/:token |
GET |
Request a new video call room. | info |
/api/v1/livechat/visitor |
POST |
Register a new Livechat visitor. | info |
/api/v1/livechat/visitor/:token |
GET |
Retrieve a visitor data. | info |
/api/v1/livechat/page.visited |
POST |
Send visitor navigation history to pimentaCHAT. | info |
