DocumentationAPI ReferenceRelease Notes
API Reference

Send chat message to session

post
https://sespog-rs.qabeyondtrustcloud.com/api/command/v2/chat-message/session/

Send a chat message to all members of an existing session. The chat message can be sent on behalf of an existing member of the session, such as a customer or a representative, or it can be sent as a system message. A chat bot can use this API to forward the end user's chat messages to the representative.

Logging

Chat messages sent via this API include a special attribute in reports indicating which API Account originally sent the message. End users and representatives do not know the chat message came from an API Account unless they are in the session and see that the chat message is sent on their own behalf.

Real-time chat translations

Chat messages sent with this API are not affected by the Real-Time Chat Translations feature. All chat messages sent by this API will be rendered to both customers and representatives exactly as they were specified in the API call. No real-time translation is performed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[0-9a-fA-F]{32}$

A string which uniquely identifies the session.

Body Params
string
required
length ≤ 2048

The chat message body, which can be formatted with a subset of BBCode:

  • [b]bolded text[/b]
  • [color=blue]blue text[/color]OR[color=#0000FF]blue text[/color]
  • [i]italicized text[/i]
  • [u]underlined text[/u]
  • [ul][li]list element 1[/li][li]list element 2[/li][/ul]
  • [url]https://www.beyondtrust.com[/url]
string
^(customer|rep:\d+|rep_username:\S+)$

This is a string identifying the user in the session from which the message appears to be sent. Valid values are:

  • "customer": The message will appear to come from the customer who is in the session.
  • "rep:": The message will appear to come from the representative with the given <id> who is in the session.
  • "rep_username:": The message will appear to come from the representative with the given <username> who is in the session.

If this parameter is not provided, the chat message is rendered as a system chat message.

date-time

The date-time at which the chat message was originally sent. It must be in the past according to the appliance's clock. If not specified, chat messages are sent with the current time.

Responses

Updated 2 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.