ASasksyllable
agents.test

Send New Message

Changed on

Send a new message

post/api/v1/agents/test/messages

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/agents/test/messages
  • Auth
    API key in header Syllable-API-Key

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 required

The text of the message; use an empty string to start a session without text

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

responseunknown required
response_textstring

The text of the response

Changes

  • 5aa18f69bd3cRevision changes
    • breaking

      the request property became required

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

  • befc919dec10Revision changes
    • breaking

      added the pattern ^[1-9][0-9]*$ to the request property