Ir para o conteúdo

Enviar mensagem

Envie mensagens por meio da API SMSBAT usando o endpoint /bat/messagelist.

Ponto final

POST /bat/messagelist

Estrutura da solicitação

O corpo da solicitação é uma matriz JSON de objetos de mensagem:

{
  "messages": [
    {
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "type": "sms",
      "text": "Your message text",
      "customerMessageId": "your-internal-id",
      "ttl": 3600
    }
  ]
}

Parâmetros

Parâmetros Obrigatórios

Parâmetro Tipo Descrição
de corda ID alfanumérico do remetente
para corda Número de telefone do destinatário no formato E.164 (por exemplo, +380XXXXXXXXX)
tipo corda Tipo de mensagem: sms, viber_promo, viber_trans, viber_carousel, viber_survey, viber_otp, rcs, flashcall
texto corda Conteúdo da mensagem (obrigatório para a maioria dos tipos, opcional para alguns)

Parâmetros Opcionais

Parâmetro Tipo Descrição
customerMessageId corda Seu identificador interno para rastreamento
ttl inteiro Tempo de vida em segundos
messageData objeto Configuração específica do tipo (varia de acordo com o tipo de mensagem)

Autenticação

Escolha um dos três métodos de autenticação:

curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -H "X-Authorization-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [{
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "type": "sms",
      "text": "Hello from SMSBAT!"
    }]
  }'

CODE_BLOCO_3

curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -u "@:your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [{
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "type": "sms",
      "text": "Hello from SMSBAT!"
    }]
  }'

Resposta

Resposta de sucesso

CODE_BLOCO_5

Campos de resposta

Campo Tipo Descrição
lista de mensagensId inteiro Identificador único da lista de mensagens
mensagemId corda Identificador único para cada mensagem
estado corda Status da mensagem: aceita, rejeitada, falha
partes inteiro Número de partes da mensagem (para SMS)
customerMessageId corda O seu identificador interno (se fornecido)
para corda Número de telefone do destinatário

Tipos de mensagens

SMS

Mensagens de texto simples:

{
  "from": "YourSender",
  "to": "+380XXXXXXXXX",
  "type": "sms",
  "text": "Your SMS message text"
}

Promoção Viber

Mensagens promocionais com rich media:

{
  "from": "YourSender",
  "to": "+380XXXXXXXXX",
  "type": "viber_promo",
  "text": "Check out our new product!",
  "messageData": {
    "image": "https://example.com/image.jpg",
    "button": {
      "text": "View Product",
      "url": "https://example.com/product"
    }
  }
}

Viber Transacional

Notificações de transação:

{
  "from": "YourSender",
  "to": "+380XXXXXXXXX",
  "type": "viber_trans",
  "text": "Your order #12345 has been confirmed"
}

Viber OTP

Notificações de senha única:

CODE_BLOCO_9

Tratamento de erros

Códigos de status HTTP

Código Descrição
200 Solicitação bem-sucedida
400 Solicitação incorreta - parâmetros inválidos
401 Não autorizado - falha na autenticação
429 Muitas solicitações - limite de taxa excedido
500 Erro interno do servidor

Resposta de erro

{
  "error": {
    "code": "INVALID_RECIPIENT",
    "message": "Invalid phone number format"
  }
}

Melhores práticas

Formato do número de telefone

Sempre use o formato E.164 para números de telefone:

  • ✅ Correto: +380XXXXXXXXX
  • ❌ Incorreto: 380XXXXXXXXX, 0XXXXXXXXX

Texto da mensagem

  • Mantenha o SMS com menos de 160 caracteres para evitar várias partes
  • Use codificação UTF-8 para caracteres internacionais
  • Teste caracteres especiais antes do envio em massa

TTL (tempo de vida)

  • Defina o TTL apropriado para mensagens urgentes
  • Mensagens OTP: 300-600 segundos (5-10 minutos)
  • Mensagens promocionais: 3600-86400 segundos (1-24 horas)

ID da mensagem do cliente

  • Use identificadores exclusivos para cada mensagem
  • Ajuda no rastreamento e depuração
  • Útil para correlacionar com os registros do seu sistema

Limites de taxa

Entre em contato com seu gerente de conta para obter informações sobre:

  • Mensagens por segundo
  • Mensagens por dia
  • Conexões simultâneas

Próximas etapas