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 returns the number of incoming chat requests assigned to the logged in agent and a link to accept the next chat request.


Method URL
GET 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


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

  • XML
  • JSON


Elements in the response

Name Description Type/Value
ringingCount Number of incoming requests to chat with an agent. numeric

Note: If there are no incoming chat requests, then the rel link will not appear.

Response Codes

Code Response
200 OK

Response example for JSON:

 "incomingRequests": {
   "ringingCount": "0"