SMS - Envio em Massa
Endpoint
Método |
Rota |
POST |
/api/sms/message/send_batch |
Parâmetros
{
"sender": "EasyChat",
"phones": ["+5521992394998"],
"message": "Teste SMS em massa EasyChat"
}
Campo |
Obrigatório |
Descrição |
sender |
Sim |
Nome ou identificador da aplicação que está enviando a mensagem |
phones |
Sim |
Array de números de telefone em formato internacional |
message |
Sim |
Mensagem de texto que deve ser enviada |
Sucesso
{success} Caso a requisição seja bem sucedida, a resposta terá a seguinte estrutura:
{
"status": "success",
"message": "Message successfully sent."
}
Campo |
Descrição |
status |
Em caso de sucesso, irá sempre retornar success |
message |
Mensagem de confirmação de que a requisição foi bem sucedida |
Erro
{danger} Caso apresente alguma falha na requisição, a resposta terá a seguinte estrutura:
{
"status": "error",
"message": "Error message goes here."
}
Possíveis respostas de erro com respectivos códigos:
Código |
Erro |
403 |
Não autenticado |
404 |
Não encontrado, verifique se está utilizando o método e a rota corretos |
422 |
Dados inválidos (uma tag errors acompanhará a resposta, relacionando os erros encontrados) |
499 |
Saldo insuficiente para enviar mensagem |
500 |
Erro de servidor, caso receba este erro, por favor entre em contato com a equipe de suporte |
Demo