Considerações sobre o uso

Essa API é apenas para usuários devidamente cadastrados e com um plano PREMIUM na ferramenta, logo a mesma não é liberada para clientes em teste.

Como obter o token da API

Para obter seu Token da API basta ir na guia lateral esquerda no botão módulos, em seguida dentro do Módulo API clique em configurar, feito isso na tela que abrir basta clicar no botão COPIAR TOKEN API

Lista dos códigos de erro implementados:

Abaixo temos uma lista completa dos atuais erros que a API pode retornar, é uma boa prática que as validações de erro nunca sejam atreladas a descrição do erro em si mas sim ao seu código que no caso dessa API corresponde ao campo errorCode presente no objeto de retorno.

errorCode : Código único do erro.
status : StatusCode HTTP ao qual será retornado.
msg : Mensagem resumida do problema.

[
 {"errorCode" : "body_01","status" : "400" , "msg" : "Body não informado" },
 {"errorCode" : "body_02","status" : "400" , "msg" : "Um ou mais campos obrigatórios não foram fornecidos, campos: {resultMsg}" },
 {"errorCode" : "auth_01","status" : "400" , "msg" : "Token do canal não informado" },
 {"errorCode" : "auth_02","status" : "400" , "msg" : "Token de canal inválido" },
 {"errorCode" : "auth_03","status" : "400" , "msg" : "Módulo incompatível com seu plano" },
 {"errorCode" : "send_01","status" : "400" , "msg" : "Campo 'number' não informado" },
 {"errorCode" : "send_02","status" : "400" , "msg" : "Campo 'texto' não informado" },
 {"errorCode" : "send_03","status" : "400" , "msg" : "Campo 'base64' e ou 'linkUrl' não informado, é obrigatório informar um ou outro" },
 {"errorCode" : "send_04","status" : "400" , "msg" : "Campo 'extension' não informado" },
 {"errorCode" : "send_05","status" : "400" , "msg" : "Ocorreu um erro ao tentar baixar o conteúdo informado no campo 'linkUrl'" },
 {"errorCode" : "api_01","status" : "400" , "msg" : "Nenhuma usuário/canal online para executar a ação" },
 {"errorCode" : "api_02","status" : "400" , "msg" : "Enviado ao usuário/canal porém sem confirmação de processamento" },
 {"errorCode" : "api_03","status" : "400" , "msg" : "Enviado ao usuário/canal e processado com erro, retorno: {resultMsg}" },
 {"errorCode" : "cript_01","status" : "400" , "msg" : "Erro durante tentativa de decriptação, retorno: {resultMsg}" },

 {"errorCode" : "fatal_01","status" : "500" , "msg" : "Ocorreu um erro interno na aplicação" },
]

Variáveis disponíveis para uso

@nome : É substituída pelo nome do contato.(Nome que o contato deu a sí próprio no seu Whatsapp)