Omnichannel (Livechat)

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/inquiries.list

GET

Retrieves a list of open inquiries.

​info​

/api/v1/livechat/inquiries.take

POST

Take an open inquiry.

​info​

/api/v1/livechat/inquiries.getOne

GET

Get one inquiry by room id.

​info​

/api/v1/livechat/integrations.settings

GET

Retrieves a list of integration settings.

​info​

/api/v1/livechat/sms-incoming/:service

POST

Send SMS messages to Rocket.Chat.

​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/agents/:agentId/departments

GET

Get the agent departments.

​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/custom-fields

GET

Get a list of Livechat custom fields.

​info​

/api/v1/livechat/custom-fields/:_id

GET

Get a Livechat custom field.

​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/office-hours

GET

Get a list of office hours.

​info​

/api/v1/livechat/offline.message

POST

Send a new Livechat offline message.

​info​

/api/v1/livechat/rooms

GET

Retrieves a list of livechat rooms.

​info​

/api/v1/livechat/queue

GET

Retrieves a list of queued chats.

​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.forward

POST

Allow Livechat Agents to forward a Livechat room to another agent, department or return it back to the Queue.

​info​

/api/v1/livechat/room.survey

POST

Send a Livechat survey to Rocket.Chat.

​info​

/api/v1/livechat/transcript

POST

Request a Livechat transcript.

​info​

/api/v1/livechat/triggers

GET

Get the Livechat triggers.

​info​

/api/v1/livechat/triggers/:_id

GET

Get a Livechat trigger.

​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/visitors.info

GET

Retrieve a visitor info.

​info​

/api/v1/livechat/page.visited

POST

Send visitor navigation history to Rocket.Chat.

​info​

/api/v1/livechat/appearance

GET

Get the settings about Livechat Widget Appearance.

​info​

/api/v1/livechat/visitors.pagesVisited

GET

Gets the visitor navigation history.

​info​

/api/v1/livechat/visitors.chatHistory/room/room-id/visitor/visitor-id

GET

Gets the visitor chat history.

​info​