Enviar mensagem SMS

Sandbox

https://horizon-api-sb.app.rpe.tech

POST

/api/v1/broker/sms

Use este serviço para enviar mensagens para a fila de SMS.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK

application/json

Body

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/broker/sms' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mensagem": "Segue o valor da fatura de jan/2023: R$124,33",
    "numeroCelular": "83900000000",
    "dataAgendamento": "2023-10-26T19:31:45.248Z"
}'

Response Example

200 - Example 1

{
    "mensagem": "Segue o valor da fatura de jan/2023: R$124,33",
    "numeroCelular": "55839000000",
    "resposta": "Requisição recebida. O SMS será processado em instantes.",
    "idExterno": "ce4be97a-d0f1-4c52-89f2-918d4079c742"
}