Gateway-API
  1. SMS
Gateway-API
  • Gateway - API
    • Contacts
      • List
    • Routes
      • Routes
    • Reports
      • Received Messages Report
      • Sent Messages Report
    • RCS
      • Send RCS (File) Message
      • Send RCS (Carrossel) Message
      • Send RCS (Card) Message
      • Send RCS (Basic) Message
    • SMS
      • Send SMS Message
        POST
    • Schemas
      • Core
        • CoreResult
      • Contacts
        • Contact
      • Routes
        • Routes
      • Reports
        • Received
        • Sent
      • RCS
        • Send RCS File
        • Send RCS Basic
        • Send RCS carousel
        • Send RCS card
      • SMS
        • Send Sms
  • Default module
    • Raiz
  1. SMS

Send SMS Message

POST
/messages/sms/send
Este endpoint permite o envio de mensagens SMS para contatos individuais ou grupos previamente cadastrados. O SMS continua sendo um dos canais mais diretos e eficazes para comunicação com clientes, especialmente para notificações, alertas, promoções e autenticações.
Com esta API, você pode personalizar o conteúdo da mensagem, definir o público-alvo e agendar o envio para uma data e hora futura, se necessário.

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

🟠400Bad Request
🟠401Unauthorized
🟠404Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/messages/sms/send' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "receivers": [
        5516988887777
    ],
    "contactGroups": [],
    "message": "Sms Teste",
    "route": 17,
    "tag": "API-sending",
    "custom": "Testes"
}'
Response Response Example
200 - Example 1
{
    "hasError": true,
    "message": "string",
    "totalRecords": 0,
    "errors": [
        "string"
    ],
    "object": null
}
Modified at 2025-11-06 13:42:14
Previous
Send RCS (Basic) Message
Next
CoreResult
Built with