Passer au contenu principal
POST
Send a message

Autorisations

Authorization
string
header
requis

Company API key, sent as Authorization: Bearer <key>. Create it in the dashboard (Developer > API Keys) with the permissions the integration needs.

Corps

application/json
channel
enum<string>
requis
Options disponibles:
whatsapp,
mail
Exemple:

"whatsapp"

contact
object
requis
from
string
requis

Id of the sending channel: WhatsApp phone id, mailbox id (mbx_...) or Shortext endpoint id (ste_...)

Exemple:

"1234567890"

message
object
requis

Réponse

200 - application/json

Message sent. The stored message is returned in body.

Envelope of every response (always HTTP 200): only body changes from one endpoint to another.

success
boolean
requis
Exemple:

true

code
enum<integer>
requis

Standard response codes defined by the system / Codes de réponse standard définis par le système.

Options disponibles:
-1,
-2,
-3,
-4,
-5,
1000,
-1001,
-1002,
-1003,
-1004,
-1005,
-1006,
-1007,
-1008,
-1009,
-1010,
-1100,
-1101,
-1102,
-1103,
1104,
-1105
Exemple:

1000

message
string
requis
Exemple:

"Request success"

body
object

The stored outbound message

token
string | null

Present only on authentication routes

trace_id
string | null

Present only when success=false. Give it to support.