v66

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04176310979.2 KB

agents.test

Send New Message

Send a new message

post/api/v1/agents/test/messages

Request body

service_namestring required

Name of the service producing the message

sourcestring required

Name of the source of the message - identifies the user, like an email or username.

textstring nullable

The text of the message

test_idstring required

Channel-manager-side ID of the session (see Session.channel_manager_sid)

agent_idstring required

ID of the agent with which the chat is taking place

org_namestring nullable

Unused: Name of the organization associated with the agent

override_timestampstring nullable

Override for the timestamp of the message

session_startboolean

Whether this message is the start of a new session

Example request

{
  "source": "user@email.com",
  "text": "Hello"
}

Response

Successful Response

test_idstring required

Channel-manager-side ID of the session (see Session.channel_manager_sid)

agent_idstring required

ID of the agent with which the chat is taking place

textstring

The text of the message that elicited the response

{"stackTrail":"components:schemas:TestMessageResponse:properties:response:anyOf","oasType":"schema","type":"unknown","title":"Response","description":"The response from the agent","nullable":true}

response_textstring

The text of the response