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 Connector API and Messaging Window API instead.

Initiates a request to chat. If successful, a new chat session will be created, and the session will be placed in the queue until an agent accepts the chat. This URI returns a "session-URI" which uniquely identifies this session, and can be used for further interaction with the session.

Note: The URI of the chat session is returned in the Location header. This URI is referred to as the chat-session-uri in the rest of the document.

Chat Request

For Visitor Authentication flow please collect necessary parameters from the following method first.

Request

Formats

• XML
• JSON

Request Headers

Body Parameters

Note that we expect you to send the parameters under the "request" key — see the Request Body Example.

Survey Body Parameters

Request Body Example

{
    "request":{
        "skill":"Sales",
        "interactionTimeout":40,
        "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36",
        "preChatLines": {
          "line": [
            "This is a pre-chat line 1",
            "This is a pre-chat line 2"
          ]
        },
        "LETagVisitorId":"rloXnVgEQ-iQuoOytvKNqA",
        "LETagSessionId":"rN82d4rATN6EuiA4cJwaPg",
        "LETagContextId":"2",
        "engagementId":27469613,
        "campaignId":26948813,
        "language":"en-US"
    }
}

Notes:

• If the userAgent parameter is in the standard "User-Agent" header format, the relevant browser will be shown in the "Browser" parameter in the Agent Workspace.
• If the userAgent parameter is NOT in the standard header format, the userAgent parameter itself will be shown (unless its value includes a space character, in which case only the first word will be shown).

Response

Response Codes

Visitor Authentication Request

Request

Formats

• XML
• JSON

Request Headers

Body Parameters

Request Body Example

{
    "authChatConnId":568046210,
    "ssoKey":"k12197",
    "engagementId":567609310,
    "LETagContextId":"2",
    "LETagSessionId":"90o5l5twRUGu1rN7bzwNMA",
    "LETagVisitorId":"RiM2JlOTcwOGIxZmNiNTk4"
}

Response

Response Codes

This method returns an empty response body. Instead, all the info you require is received via the response headers. Most crucially, the "Location" header contains the chatId (sometimes known as "chat key") as part of its URL. See example screenshot below.