Referência da API

Cobertura de duas chamadas a maioria das integrações

POST para enviar uma mensagem, GET para verificar seu status. Mesmo host, mesmo cabeçalho de token, JSON por toda parte.

Pontos finais

O que você pode chamar

POST /externo/sms

Envie uma mensagem. Corpo: de, para e conteúdo. Retorna uma msgid e um código de erro.

OBTER/relatório

Leia o status de uma mensagem, por exemplo status=Delivrd para mensagens entregues.

Direção

mt é uma mensagem que você enviou; mo é uma resposta que você recebeu. Ambos usam o mesmo formato de mensagem.

Codificação e comprimento

160 caracteres no GSM7, 70 no Unicode. Mensagens mais longas são divididas e cobradas por parte.

Status de entrega

Ler uma mensagem estado final

Consulte por status ou deixe-nos enviar o mesmo relatório para seu URL de retorno de chamada.

OBTER/relatório
GET /report?status=Delivrd
Token: $SMSLOCAL_TOKEN

# → 200 OK
# { msgid: "9f2a7c10", status: "Delivrd" }
Veja também

Guias relacionados

Início rápido

Um primeiro pedido guiado.

Webhooks

Push em vez de enquete.

Documentos do desenvolvedor

A referência completa.

Comece

Comece a construir

Obtenha sua chave de acesso e faça uma solicitação.

Respostas às suas perguntas

Referência da API — perguntas frequentes

JSON, com Content-Type: application/json em cada solicitação.

Após o limite de caracteres, uma mensagem é unida em várias partes e cada parte é cobrada separadamente.