Livechat Endpoints

Agent

Url
Short Description
Details Page
livechat/agent.info/:rid/:token
Retrieves the current omnichannel agent data
Link
livechat/agent.next/:token
Retrieves the data of the next available agent
Link

Configuration

Url
Short Description
Details Page
livechat/config
Retrieves LiveChat widget configuration info and additional visitor data.
Link

Contacts

Url
Short Description
Details Page
omnichannel/contact
Registers a guest user as a new omnichannel contact
Link
omnichannel/contact
Retrieves a contact information
Link
omnichannel/contact.search
Searches a contact information
Link

Custom Field

Url
Short Description
Details Page
livechat/custom.field
Sends a custom field
Link
livechat/custom.fields
Sends an array of custom field
Link
livechat/custom-fields
Retrieves a list of omnichannel custom fields
Link
livechat/custom-fields/:_id
Retrieves info about a custom field
Link

Message

Url
Short Description
Details Page
livechat/message
Sends a new omnichannel message
Link
livechat/message/:_id
Retrieves a specific message
Link
livechat/message/:_id
Updates an omnichannel message
Link
livechat/message/:_id
Removes an omnichannel message
Link
livechat/messages.history/:rid
Retrieves omnichannel messages history
Link
livechat/messages
Sends array of messages
Link

Offline Message

Url
Short Description
Details Page
livechat/offline.message
Sends an offline message when no agent is available
Link

Page Visited

Url
Short Description
Details Page
livechat/page.visited
Retrieves the pages your omnichannel user navigated on your website.
Link

Room

Url
Short Description
Details Page
livechat/room
GetRetrievesthe omnichannel room data or open a new conversation.
Link
livechat/room.close
Closes an omnichannel conversation
Link
livechat/room.transfer
Transfers an omnichannel conversation
Link
livechat/room.forward
Chatbot agent forwards the chat to a human agent
Link
livechat/room.visitor
Updates room visitor's information
Link

Transcript

Url
Short Description
Details Page
livechat/transcript
Requests a Livechat transcript
Link

Transfer

Url
Short Description
Details Page
livechat/transfer.history/:rid
Retrieves the conversation transfer history
Link

Visitor

Url
Short Description
Details Page
livechat/visitor
Registers a new visitor
Link
livechat/visitor/:token
Retrieves a visitor
Link
livechat/visitor/:token
Deletes a visitor
Link
livechat/visitor/:token/room
Retrieves open conversation of a visitor
Link
livechat/visitor.status
Sets visitor status
Link