Enviar mensagem
Veja detalhes de como realizar o envio de uma ou mais mensagens.
A partir deste serviço você poderá enviar mensagens individuais ou em massa, agendar envios, fracionar lotes de envios e muito mais.
Fique atento quanto ao rate-limit de requisições para o correto funcionamento da API.
Fluxo da mensagem
Hoje somos um gateway de mensageria com imenso know-how sobre as tecnologias e tipos de roteamento do mundo SMS. Por isso, mantemos o máximo de conexões disponíveis com brokers nacionais e internacionais para conseguirmos manter excelente qualidade de serviço com níveis extremamente reduzidos de incidências.
Desta forma, ofereceremos tarifas abaixo da média do mercado com periodicidade de reajustes extremamente reduzida para clientes de pequeno e médio porte que não conseguem boas tarifas aliadas a boa qualidade de serviço e atendimento.
Com isso conseguimos realizar diversos mixes de conexões no tráfego de nossos clientes de acordo com o tipo de envio, sendo eles para fins de marketing ou OTP.
HTTP Simplificado
GET
https://api-v2.smsfire.com.br/sms/send/individual
A partir de algumas propriedades aplicadas diretamente na URL é possível o envio individual de uma mensagem ao seu destinatário.
Atenção: Campos com * (asterisco) são obrigatórios
Query Parameters
Headers
O parâmetro
customId
aceita caracteres alfanuméricos, hífen, underline/underscore e ponto sem espaços ou quebra de linha.
Exemplo de requisição
Envio com parâmetros mínimos
GET https://api-v2.smsfire.com.br/sms/send/individual?to=5511944556677&text=Ola
Envio com todos os parâmetros
GET https://api-v2.smsfire.com.br/sms/send/individual?to=5511944556677&text=Ola&from=SMSFIRE&allowReply=true&flash=true&campaignId=0001&scheduleTime=2021-12-25T10:00:00
Para o correto funcionamento é imprescindível realizar o encoding da URL para que não haja distorções no conteúdo da mensagem.
REST (JSON)
POST
https://api-v2.smsfire.com.br/sms/send/bulk
Realize envios a múltiplos destinatários numa única requisição de forma personalizada para cada um dos números.
Atenção: Campos com * (asterisco) são obrigatórios
Headers
Request Body
O parâmetro
customId
aceita caracteres alfanuméricos, hífen, underline/underscore e ponto sem espaços ou quebra de linha.
É possível enviar no máximo 1.000 destinatários por requisição
Exemplos de requisição
Exemplo simplificado de requisição com parâmetros mínimos obrigatórios:
Exemplo de JSON com agendamento e id personalizado definido pelo cliente:
O parâmetro
from
tem efetividade apenas a alguns países de destino. No caso do Brasil ele é apenas uma informação adicional, já que as operadoras sempre entregam a mensagem com um remetente numérico definido por elas mesmas.
Exemplo de JSON com fracionamento de mensagem:
Na forma demonstrada, os
destinations
serão divididos em 2 lotes onde o primeiro será enviado imediatamente e o segundo será enviado após 10 minutos.
Exemplo de JSON com agendamento e fracionamento de mensagem:
Na forma demonstrada, os
destinations
serão divididos em 2 lotes onde o primeiro será enviado na data descrita emscheduleTime
e o segundo será enviado 10 minutos após.
Exemplo de JSON permitindo a captação de respostas:
Informações adicionais
Destacamos a importância da leitura das seções apresentadas abaixo. Nessas seções você terá o detalhamento sobre caracteres acentuados e especiais, concatenação de mensagem, fracionamento de lote, agendamento e possíveis códigos HTTP que a nossa API poderá gerar em situações de erro da requisição ou interno.
Last updated