Connection Establishment

From lp-shell:

wscat -k 60 -H "Authorization:jwt $LP_JWT" -c "wss://$LP_ASYNCMESSAGINGENT/ws_api/account/$LP_ACCOUNT/messaging/consumer?v=3"

Client properties can be added to the connection URL as query params. The full list of supported client properties can be found here.

Where LP_JWT is your token.

Interaction Commands

You can use the message builder to build and explore the structure of the API messages. The following table summarizes the API messages and provides some examples .

Category Name Request Response Notifications
Message Builder
Conversations RequestConversation N/A
Close, update CSAT, TTR,
Conversation Metadata SubscribeExConversations
UnsubscribeExConversations N/A
Messages PublishEvent
Send text, read/accept and presence events.
Browser Connection InitConnection N/A

Agent Public Profile

In order to retrieve the Agent's public profile during a conversation (which is useful if you're looking to display specific agent details, like agent name or picture, during the conversation), please see this method.


These methods are subject to Rate-Limiting policies. This means that the maximum number of concurrent requests is limited on the server side. As most incoming requests are measured in seconds, the likelihood of your requests actually encountering an issue is rare; however, if you do encounter a limit, you can expect to receive a 429 status code in an error response from the server.

If your request is throttled in this manner, it is recommended that you provide a window of at least 1 second in between subsequent request retries. Clients who submit "bursty" traffic patterns to UMS may face rate-limiting issues, so it is recommended to smoothen traffic to a more distributed pattern whenever possible.

Other APIs