Skip to main content
POST
/
Agent
/
Xmpp
/
SendTextMessage
Send text message
curl --request POST \
  --url https://{host}/Agent/Xmpp/SendTextMessage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "bob@neuron.example.com",
  "message": "Hello!",
  "subject": "",
  "language": "en",
  "id": ""
}
'
{
  "sent": true,
  "id": "msg-12345"
}

Overview

Send a plain text chat message from the authenticated account to an XMPP recipient.

Authentication

Requires a valid JWT bearer token.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
to
string
required
message
string
required
subject
string
required
language
string
required
id
string
required

Response

200 - application/json

Success

sent
boolean
required
id
string
required