API de Mensageria — Short Code

Introdução

Base URL: https://api.shortcode.com.br

Autenticação:

Authorization: Bearer SEU_TOKEN_AQUI

Envio de SMS

Permite o envio de até 1000 mensagens por requisição.

Corpo da Requisição (JSON)

[{
  "external_id": "001",
  "number": "41999999999",
  "message": "Olá, esta é uma mensagem."
}]

Resposta de sucesso (201)

[{
  "external_id": "001",
  "number": "41999999999",
  "operadora": "CLARO",
  "status": "accepted"
},
{
  "external_id": "002",
  "number": "41988888888",
  "operadora": "invalido",
  "status": "failed",
  "reason": "Número com operadora inválida"
}]

Status Disponíveis

• accepted – envio aceito com sucesso
• failed – envio não aceito (ver reason)

Códigos de Erro

• 400 – JSON inválido, campos ausentes ou limite excedido
• 401 – Token ausente ou IP não autorizado
• 402 – Saldo insuficiente
• 403 – Token inválido
• 404 – Usuário não encontrado
• 423 – Usuário bloqueado

Webhook: DLR

Notificação de entrega da mensagem.

{
  "dlrs": [
    {
      "date": "2021-07-14 08:00:07",
      "external_id": "1525",
      "number": "41992375284",
      "operadora": "VIVO",
      "id_status": 1,
      "status": "Entregue no Celular",
      "message": "Envio de Teste 01"
    }
  ]
}

Status possíveis

• 2 – Entregue sem confirmação
• 3 – Entregue com confirmação
• 4 – Celular indisponível
• 6 – Recusado pela operadora

Webhook: MO (Resposta do Cliente)

Notificação quando o cliente responde um SMS.

{
  "mos": [
    {
      "date": "2021-07-14 10:33:47",
      "external_id": "",
      "number": "41992375284",
      "operadora": "VIVO",
      "message": "Me liga por favor"
    }
  ]
}