WhatsApp - Mensagem de Sticker
Endpoint
Método |
Rota |
POST |
/api/whatsapp/message/send_sticker |
Parâmetros
{
"phone": "+5521992394998",
"message": "Teste mensagem de contato EasyChat",
"contact": {
"phone": "+5521992394998",
"first_name": "CloudHotels",
"last_name": "Brasil",
"site": "https://cloudhotels.com.br",
"company": "CloudHotels",
"email": "comercial@cloudhotels.com.br"
},
"send_at": "2022-01-01 00:00:00"
}
Campo |
Obrigatório |
Descrição |
phone |
Sim |
Número de telefone em formato internacional para qual deve ser enviada a mensagem |
message |
Não |
Mensagem de texto que deve ser enviada (se informado, seré enviado uma mensagem de texto antes do envio do contato) |
contact.phone |
Sim |
Telefone do contato em formato internacional |
contact.first_name |
Não |
Nome do contato |
contact.last_name |
Não |
Sobrenome do contato |
contact.site |
Não |
Site do contato |
contact.company |
Não |
Empresa do contato |
contact.email |
Não |
Email do contato |
send_at |
Não |
Data e hora (em UTC) que deseja que o envio seja feito, se oculto, o envio será imediato |
Sucesso
{success} Caso a requisição seja bem sucedida, a resposta terá a seguinte estrutura:
{
"status": "success",
"message": "Message successfully sent.",
"uuid": "329bfd62-51ab-4180-a1bd-1b4eccf90135",
"pending": false
}
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 |
uuid |
Identificador único da mensagem enviada |
pending |
Retorna false caso a mensagem já tenha sido enviada ou true caso tenha entrado para fila (se houver muitas mensagens enviadas simultaneamente, para evitar bloqueio) |
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) |
490 |
Número não registrado no WhatsApp |
498 |
API desconectada |
499 |
Saldo insuficiente para enviar mensagem |
500 |
Erro de servidor, caso receba este erro, por favor entre em contato com a equipe de suporte |