Please note that this API relates to LivePersons legacy chat product which receives limited support and will be deprecated in the future.

It is recommended to build future integrations on top of LivePersons Messaging Platform SDK instead.

This method accepts the next chat request.

Note: You should verify the results to see if there are any chat requests before accessing the resource.

Note: If an assigned chat is not accepted within 20 seconds, the system will assume the agent being idle and set the agent status to "away".

Request

Method URL
POST https://{domain}/api/account/{accountId}/agentSession/{agentSessionId}/incomingRequests?v=1&NC=true

Request Headers

Header Description
Authorization Bearer {bearer-from-login}
Content-Type application/json
Accept application/json

Formats

The body media type must have one of the following formats:

  • XML
  • JSON

Body

For backwards compatibility purposes, you must include the following empty request body:

{}

Response

If a chat request exists, the request will return an existing chat session.

Elements in the response

Name Description Type/Value Notes
chatId The ID of the agent chat string Found in the @href element

Response Codes

Code Response
201 Created

Response example for JSON:

{
 "chatLocation": {
   "link": {
     "@href": "https://{domain}/api/account/{accountId}/agentSession/{agentSessionId}/chat/{chatId}",
     "@rel": "location"
   }
 }
}