SMS API

SMS API — Entrega Rápida e Confiável

Envie SMS com alta entregabilidade para qualquer operadora. Suporte a fragmentação automática de mensagens, relatórios de entrega em tempo real e callbacks para rastreamento completo.

Introdução

A SMS API da Yup Chat permite que você envie e receba mensagens SMS com alta entregabilidade, consulte o status de mensagens, gerencie templates pré-aprovados e acesse relatórios detalhados sobre suas operações. Com suporte a fragmentação automática, callbacks de status em tempo real e rastreamento completo, você pode integrar SMS em seus fluxos de negócio com confiança.

Envio de SMS

Envie mensagens individuais ou em massa com suporte a fragmentação automática de até 1600 caracteres.

Recebimento de SMS

Receba mensagens de entrada através de webhooks com informações completas do remetente e conteúdo.

Consulta de Mensagens

Consulte o status de mensagens individuais ou em lote com filtros por direção, data e outros parâmetros.

Relatórios

Acesse insights detalhados sobre taxa de entrega, custos, análise por operadora e período.

Autenticação

HTTP Basic Authentication

A SMS API utiliza autenticação HTTP Basic com seu ID e Token. Você deve enviar suas credenciais codificadas em Base64 no header Authorization.

Authorization: Basic <base64(ID:TOKEN)>

Exemplo: Se seu ID é "user123" e seu Token é "token456", você codifica "user123:token456" em Base64, resultando em "dXNlcjEyMzp0b2tlbjQ1Ng==".

Dica: Obtenha suas credenciais em "Informações da conta" no Dashboard da Yup Chat.

Exemplo de Autenticação

curl -u 'SEU_ID:SEU_TOKEN' \
  https://api.yup.chat/v1/sms/messages/msg_123

Base URL

Todos os endpoints da SMS API são acessados através da seguinte URL base:

https://api.yup.chat/v1/

Todos os exemplos de endpoints nesta documentação devem ser prefixados com esta URL base. Por exemplo, o endpoint GET /sms/messages/:id completo seria: https://api.yup.chat/v1/sms/messages/:id

Endpoints

GET/sms/messages/:id

Consulta um SMS único pelo seu ID e retorna informações completas sobre a mensagem.

Parâmetros

Parâmetro	Tipo	Descrição
`id`	String	ID único da mensagem SMS

Exemplo de Requisição

curl -u 'SEU_ID:SEU_TOKEN' \
  https://api.yup.chat/v1/sms/messages/msg_1234567890abcdef

Exemplo de Resposta (200 OK)

{
  "status": "delivered",
  "from": "YupChat",
  "to": "+5511999999999",
  "body": "Seu código de verificação é: 123456",
  "account_id": "acc_123456789",
  "direction": "outbound",
  "segments": 1,
  "price": 0.50,
  "carrier": "Vivo",
  "ext_id": null,
  "id": "msg_1234567890abcdef",
  "created_at": "2024-01-19T10:30:00Z",
  "updated_at": "2024-01-19T10:30:05Z"
}

POST/sms/messages

Envia um ou mais SMS. Suporta envio individual ou em massa com fragmentação automática.

Corpo da Requisição

Campo	Tipo	Descrição
`messages`*	Array	Array de mensagens a enviar
`to`*	String	Número em formato E.164 (ex: +5511999999999)
`body`*	String	Conteúdo da mensagem (máximo 612 caracteres)
`ext_id`	String	ID externo para rastreamento interno
`status_callback`	String	URL para callback de status
`normalize`	Boolean	Substituir caracteres Unicode especiais (padrão: false)

Exemplo de Requisição

curl -X POST https://api.yup.chat/v1/sms/messages \
  -u 'SEU_ID:SEU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "messages": [
      {
        "to": "+5511999999999",
        "body": "Seu código de verificação é: 123456",
        "ext_id": "user_123"
      }
    ]
  }'

Exemplo de Resposta (200 OK)

{
  "status": "accepted",
  "from": "YupChat",
  "to": "+5511999999999",
  "body": "Seu código de verificação é: 123456",
  "account_id": "acc_123456789",
  "direction": "outbound",
  "segments": 1,
  "price": 0.50,
  "carrier": "Vivo",
  "ext_id": "user_123",
  "id": "msg_1234567890abcdef",
  "created_at": "2024-01-19T10:30:00Z",
  "updated_at": "2024-01-19T10:30:00Z"
}

GET/sms/messages

Consulta SMS com filtros por direção, data e outros parâmetros. Retorna uma lista paginada de mensagens.

Parâmetros de Query

Parâmetro	Tipo	Descrição
`direction`	String	Filtrar por direção: "inbound" ou "outbound"
`sent_at`	String	Filtrar por data de envio (ISO 8601)
`status`	String	Filtrar por status: "sent", "delivered", "failed", "undelivered"
`limit`	Number	Número máximo de resultados (padrão: 50)

Exemplo de Requisição

curl -u 'SEU_ID:SEU_TOKEN' \
  'https://api.yup.chat/v1/sms/messages?direction=outbound&status=delivered&limit=10'

POST/sms/insights

Gera relatórios de insights com análise de período, taxa de entrega, custos e análise por operadora.

Corpo da Requisição

Campo	Tipo	Descrição
`start_date`*	String	Data de início (ISO 8601)
`end_date`*	String	Data de fim (ISO 8601)

POST/sms/templates

Cria um novo template de SMS pré-aprovado para uso em envios em massa.

Corpo da Requisição

Campo	Tipo	Descrição
`name`*	String	Nome do template
`body`*	String	Conteúdo do template com variáveis {variable}

GET/sms/templates

Lista todos os templates de SMS criados na conta.

DELETE/sms/templates/:id

Deleta um template de SMS. Nota: A documentação original lista este endpoint como /sms/messages, mas é utilizado para exclusão de templates.

Parâmetros

Parâmetro	Tipo	Descrição
`id`*	String	ID único do template a deletar

Status Retornados

Sent

A mensagem foi aceita e enviada para a operadora, mas ainda não foi entregue ao destinatário.

Delivered

A mensagem foi entregue com sucesso ao dispositivo do destinatário.

Undelivered

A mensagem não pôde ser entregue, mas a operadora pode tentar novamente mais tarde.

Failed

A mensagem falhou permanentemente. Pode ser devido a número inválido, bloqueio de operadora ou outro erro.

Accepted

A requisição foi aceita e a mensagem está na fila para envio.

Pending

A mensagem está aguardando processamento pela operadora.

Recursos Principais

Entrega Rápida

Mensagens entregues em milissegundos com taxa de sucesso de 99.9%

Fragmentação Automática

Suporte automático a fragmentação com até 1600 caracteres por envio

Rastreamento em Tempo Real

Acompanhe status de entrega, operadora e custos instantaneamente

Templates SMS

Crie e gerencie templates pré-aprovados para envios em massa

Callbacks de Status

Receba notificações instantâneas sobre status de mensagens via webhook

Relatórios Detalhados

Acesse insights sobre taxa de entrega, custos e análise por operadora

Casos de Uso

Autenticação 2FA

Envie códigos OTP seguros para verificação de usuários em tempo real

Confirmação de Pedidos

Notifique clientes sobre confirmação, processamento e entrega de pedidos

Lembretes de Agendamento

Reduza no-shows com lembretes automáticos de consultas e compromissos

Alertas de Segurança

Notifique usuários sobre atividades suspeitas ou mudanças de conta

Campanhas de Marketing

Distribua promoções, cupons e ofertas em massa com alta entregabilidade

Suporte ao Cliente

Comunique-se com clientes sobre status de tickets e resoluções

Pronto para Começar?

Integre a SMS API em minutos e comece a enviar mensagens com alta entregabilidade.