Documentos

Envie sua primeira mensagem em uma tarde

Uma API REST simples para enviar, rastrear e receber SMS — autenticação de token, webhooks e SDKs em tempo real, sem nada exótico para aprender.

Início rápido

Três movimentos, comece a entregar

Cada integração é o mesmo arco curto: autentique, envie e rastreie.

01 · AutenticarToken: sk_live_9f2a7c10Tipo de conteúdo: application/json ✓

Envie sua chave de acesso como um cabeçalho Token, com Content-Type: application/json, em cada solicitação.

02 · EnviarPOST /externo/sms{ msgstr: "9f2a7c10", código de erro: 0 }

POSTAR um conteúdo de, para e. A resposta retorna com um msgid e um código de erro imediatamente.

03 · AcompanharGET /report?status=Entregar200 OK

POSTAMOS ou GET um relatório de status em seu URL de retorno de chamada no momento em que uma mensagem atinge seu estado final.

Enviar

Uma solicitação, no idioma que você já usa

POSTE seu remetente, destinatário e conteúdo com um cabeçalho Token. A resposta volta no momento em que a aceitamos.

01curl -X POST https://secure.smslocal.com/api/service/enterprise-service/external/sms \02  -H "Token: $SMSLOCAL_TOKEN" \03  -H "Content-Type: application/json" \04  -d '{05    "from": "SMSLOCAL",06    "to": "14155550123",07    "content": "Your code is 481920."08  }'
201 · Aceito

msgstr "9f2a7c10-4b2e-…"

direção "mt"

código de erro 0

Salve o msgstr – é como você rastreia esta mensagem daqui.

O objeto de mensagem

Ler uma mensagem de cima para baixo

Todos os eventos de envio, status e entrada retornam a mesma forma – aprenda uma vez.

01ID da mensagem

ID da mensagem

msgstr — criado no momento em que uma mensagem é criada. Este é o identificador que você usa para verificar seu status posteriormente.

02Remetente

Remetente

de — um número de telefone ou um ID alfanumérico de até 11 caracteres, qualquer que seja a identidade que seus destinatários vejam.

03Destinatário

Destinatário

para — o número para o qual a mensagem está indo, incluindo o código do país.

04Codificação

Codificação

codificação de dados – GSM7 acomoda 160 caracteres por parte; mude para Unicode e isso cai para 70. Vá até lá e ele se concatena em partes extras cobradas.

05Direção

Direção

direção - cada mensagem é mt (você a enviou) ou mo (você a recebeu), com o mesmo formato de qualquer maneira.

06Código de erro

Código de erro

código de erro – retornado na resposta de envio e em cada relatório de status. 0 significa aceito; qualquer outra coisa diz exatamente o que deu errado.

Referência

Um ponto final, dois verbos

POST para enviar, GET para verificar o status — o mesmo URL e o mesmo cabeçalho do token de qualquer maneira.

PUBLICAR

Enviar

Envie uma mensagem e receba imediatamente um msgid e um código de erro.

Devoluções msgstr + código de erro
PEGAR

Acompanhar

Procure uma mensagem que você já enviou para verificar seu status atual.

Devoluções mensagem + status
Webhooks

Relatórios de status, no momento em que acontecem

Defina um URL de retorno de chamada e cada entrega, falha e resposta de entrada chegará lá como um GET ou POST – sem necessidade de pesquisa.

entreguemsgstr 9f2a7c10 · status Entregue
entradaresposta recebida · direção mo
fracassadomsgstr 4c81e2 · status Falha
Seu ponto final200 OK
Comece

Obtenha sua chave API

Comece a integração em minutos com nossa API REST.

Respostas às suas perguntas

Documentos do desenvolvedor – perguntas frequentes

Passe sua chave de acesso em um cabeçalho Token em cada solicitação — Token: {accessKey} — junto com Content-Type: application/json.

Cada envio retorna uma msgid. Aponte-nos para um URL de retorno de chamada e nós POST ou GET um relatório de status no momento em que a mensagem atinge seu estado final - subdata, data concluída e o código de status resultante incluído.

mt (terminação móvel) é uma mensagem que você enviou; mo (originado em dispositivos móveis) é uma resposta que você recebeu. Ambos usam o mesmo formato de objeto de mensagem.

A entrega é repetida de acordo com a política de novas tentativas — nada é descartado silenciosamente, mas um endpoint que nunca reconhece continuará recebendo novas tentativas.

160 caracteres na codificação GSM7 ou 70 em Unicode. Ultrapasse o limite e a mensagem será concatenada em várias partes, cada uma cobrada separadamente.