A HalloAPI segue os termos de serviço do WhatsApp. É de sum importância que a leitura deste termo seja lido com devid atenção. Não nos responsabilizamos pelas consequências do mau uso das ferramentes disponibilizadas pela HalloAPI . Nosso serviço não é destinado para a prática de SPAM e de envio de mensagens indesejadas, não buscamos violar os termos de serviço do WhatsApp, nossa missão é facilitar a integração com este serviço, fazendo assim, uma melhor experiência com o nosso parceiro que estará realizando a integração.
\nPortanto, a violação dos termos pode acarretar no bloqueio e banimento definitivo de sua conta no WhatsApp.
\n*Retorno de mensagens ér feito pelo WEBHOOK da instância configurado no sistema, esse recebe as mensagens via POST no URL adicionado, vai receber os seguintes campos no retorno:
\nAcesse o nosso manual com detalhes dos retornos do WEBHOOK:
\n\n*(i) Em casos críticos de operação do servidor de requisições, pode existir retornos de \"OCUPADO\" ou falha em atender a requisição, nesses casos temos o seguinte retorno abaixo.
\n{\n \"isValid\": \"false\",\n \"message\": \"SERVER_BUSY\"\n}\n\nPossibilita realizar uma manutenção na instância, reiniciando seu motor de envio. Ação passiva de ser realizada em casos de instabilidades.
\n{\n \"result\": [],\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nA mensagem não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPossibilita conectar à uma instância através das credenciais. Receber aqui os dados da imagem de código QR de pareamento.
\n{\n \"result\": {\n \"qrCode\": \"image base64\",\n \"state\": \"disconnected\"\n },\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nCaso esse retorno seja visualizado, aguarde 1min e tente novamente, ele indica que os arquivos de criptografia do whatsapp form corrompidos e o nosso sistema iniciou um processo de reparação automático aplicando uma manutenção.
\n{\n \"result\": {\n \"qrCode\": \"IMAGE_ERROR\",\n \"state\": \"activaction\",\n \"restart\": true\n },\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nSUCESS ALREADY CONNECTED - STATUS CODE 200**
\n{\n \"result\": {\n \"state\": \"connected\",\n \"number\": \"5599999999999\",\n \"name\": \"NAME APP\"\n },\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\n{\n \"result\": {\n \"state\": \"inactive\"\n },\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\n{\n \"result\": {\n \"state\": \"activaction\"\n },\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\n{\n \"result\": {},\n \"message\": \"INVALID_ACCESS_TOKEN\",\n \"isValid\": false\n}\n\n*Retorno de confirmações para webhook sobre as alterações de status da instância. Importante ter como referência também os métodos de envios de mensagens, etc. Que tem seu retorno de não conectado em caso de uso de recursos como envio de mensagens que dependem dessa conexão!
\nLEGENDA DO ACTION DE RETORNO DO STATUS DA INSTÂNCIA:
CONFIRM_ONLINE - Retorno que confirma alteração do status paca CONECTADO;
CONFIRM_DISCONNECT - Retorno que confirma alteração do status paca DESCONECTADO;
CONFIRM_BANNED - Retorno que confirma alteração do status para NÚMERO BANIDO;
CONFIRM_ACTIVATED - Retorno que confirma alteração do status para INSTÂNCIA ATIVADA;
CONFIRM_DISABLED - Retorno que confirma alteração do status para INSTÂNCIA DESATIVADA;
SUPPORT_ACTIVATED - Retorno alteração do status de manutenção aplicada para INSTÂNCIA ATIVADA;
SUPPORT_DISABLED - Retorno alteração do status de manutenção aplicada para INSTÂNCIA DESATIVADA;
\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_DISCONNECT\",\n \"instance_key\": \"Key da instância que enviou a mensagem (message_id)\",\n \"instance_id\": \"ID da instância que enviou a mensagem (message_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\"\n}\n\nPossibilita obter o status de conexão da instância.
\n{\n \"result\": {\n \"state\": \"disconnected\",\n \"reading\": \"0 ler automático, 1 nao está marcando como lido\"\n },\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\n{\n \"result\": {\n \"state\": \"connected\",\n \"number\": \"5599999999999\",\n \"name\": \"NAME APP\",\n \"reading\": \"0 ler automático, 1 nao está marcando como lido\"\n },\n \"isValid\": true,,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\n{\n \"result\": {\n \"state\": \"inactive\"\n },\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\n{\n \"result\": {\n \"state\": \"activaction\"\n },\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\n{\n \"result\": {},\n \"message\": \"INVALID_ACCESS_TOKEN\",\n \"isValid\": false\n}\n\n*Retorno de confirmações para webhook sobre as alterações de status da instância. Importante ter como referência também os métodos de envios de mensagens, etc. Que tem seu retorno de não conectado em caso de uso de recursos como envio de mensagens que dependem dessa conexão!
\nLEGENDA DO ACTION DE RETORNO DO STATUS DA INSTÂNCIA:
CONFIRM_ONLINE - Retorno que confirma alteração do status paca CONECTADO;
CONFIRM_DISCONNECT - Retorno que confirma alteração do status paca DESCONECTADO;
CONFIRM_BANNED - Retorno que confirma alteração do status paca NÚMERO BANIDO;
CONFIRM_ACTIVATED - Retorno que confirma alteração do status para INSTÂNCIA ATIVADA;
CONFIRM_DISABLED - Retorno que confirma alteração do status para INSTÂNCIA DESATIVADA;
SUPPORT_ACTIVATED - Retorno alteração do status de manutenção aplicada para INSTÂNCIA ATIVADA;
SUPPORT_DISABLED - Retorno alteração do status de manutenção aplicada para INSTÂNCIA DESATIVADA;
\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_DISCONNECT\",\n \"instance_key\": \"Key da instância que enviou a mensagem (message_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (message_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\"\n}\n\nPossibilita desconectar uma instância conectada.
\n{\n \"result\": {\n \"state\": \"disconnected\"\n },\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPossibilita alterar a url do webhook de uma instância.
\nJSON
\n{\n \"result\": {\n \"status\": \"connected ou disconnected\",\n \"name\": \"string\",\n \"createdAt\": \"DATE_ATOM\",\n \"expiresAt\": \"DATE_ATOM\"\n },\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nJSON
\n{\n \"result\": {},\n \"message\": \"INVALID_WEBHOOK_URL\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nJSON
\n{\n \"result\": {},\n \"message\": \"INVALID_ACCESS_TOKEN\",\n \"isValid\": false\n}\n\nPossibilita alterar o nome da conexão que fica aparente nos dispositvos no app Whatsapp de uma instância.
+ESSE NOME SÓ ALTERA NO APARELHO AO DESPAREAR E PAREAR NOVAMENTE!
JSON
\n{\n \"result\": {\n \"status\": \"connected ou disconnected\",\n \"name\": \"string\",\n \"createdAt\": \"DATE_ATOM\",\n \"expiresAt\": \"DATE_ATOM\"\n },\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nJSON
\n{\n \"result\": {},\n \"message\": \"INVALID_NAME\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nJSON
\n{\n \"result\": {},\n \"message\": \"INVALID_ACCESS_TOKEN\",\n \"isValid\": false\n}\n\nDefinição sobre auto leitura de mensagens, tem como função ao receber uma mensagem em seu aparelho, a mensagem é marcada automáticamente como MENSAGEM LIDA, removento o ícone de pendências/notificação do aparelho. IMPORTANTE QUE TEM DUAS OPÇÕES DISPONÍVEIS: MENSAGEM DE CONTATOS, MENSAGEM DE GRUPOS.
\nJSON
\n{\n \"result\": {\n \"self\": \"true\"\n },\n \"isValid\": \"true\",\n \"instance_id\": \"3\",\n \"instance_id_reffer\": \"1235\"\n}\n\nJSON
\n{\n \"result\": {},\n \"message\": \"INVALID_ACCESS_TOKEN\",\n \"isValid\": false\n}\n\nLEGENDA DODOS CAMPOS DE AÇÃO PARA APLICAÇÃO NA INSTÂNCIA:
self:
true ou 1 - Significa ativar a leitura automática das mensagens de contatos diretos, todos, ESSE VEM COMO PADRÃO CASO NÃO SEJA DEFINIDO;
false ou 0 - Significa ativar a leitura automática das mensagens de contatos diretos, todos;
self_group:
true ou 1 - Significa ativar a leitura automática das mensagens em grupos de conversas, todos, ESSE VEM COMO PADRÃO CASO NÃO SEJA DEFINIDO;
false ou 0 - Significa ativar a leitura automática das mensagens em grupos de conversas, todos;
**ESSE RECURSO MARCA A MENSAGEM COMO LIDA DEIXANDO O APP SEM AVISOS E ALERTAS DE LEITURA!
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","instance"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"bdb02b6e-392d-44df-af46-02eba2608929","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"READING","type":"text"},{"key":"self","value":"true","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/instance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 26 Sep 2022 20:14:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-jsRTE+c513zT/Zdp2/KzzTo+Sdc\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"self\": \"true\"\n },\n \"isValid\": \"true\",\n \"instance_id\": \"3\",\n \"instance_id_reffer\": \"1235\"\n}"}],"_postman_id":"fbcad572-648a-4c3e-94a5-6122d57f938d"}],"id":"33622823-0797-45e4-bc03-64530a7c4da4","description":"Responsável pela gestão das instâncias adquiridas.
\nToda ação é necessário que seja informado as chaves de acesso para a instância, sendo elas:
\n{{instanceKey}} - Chave de identificação da instância.
{{instanceToken}} - Chave de acesso à instância.
Ambas chaves não devem ser compartilhadas, qualquer um poderá acessar a sua instância caso tenha as chaves acima.
\nAs chaves de acesso estarão disponíveis na sua conta, na página de detalhes da instância, basta acessar:
\n\nVARIÁVEIS DE CONTROLE
instance_id - ID de controle do painel de sua instância.
instance_id_reffer - ID de referância de sua instância, um id único atemporal (tem mesmo efeito do instance_id), caso seja útil para controle em sua ferramenta.
Permite enviar uma mensagem de texto.
\nA mensagem será enviada para a fila de envio, garantimos o envio da mensagem.
\n{\n \"result\": {\n \"message_id\": \"id da fila de envio\"\n },\n \"message\": \"MESSAGE_SCHEDULED\",\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 586,//Mostra a quantidade de mensagens que estão em fila aguardando envio\n}\n\nApós a mensagem ser enviada, é retornado um id de registro da fila de envio, no qual será confirmado postariormente será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da mensagem enviada anteriormente está vinculada ao \"message_id\" retornado no envio da mensagem, utilize este identificador para aplicar ações em seu webhook de retorno.
\nLEGENDA STATUS A RETORNAR DAS MENSAGENS:
NUMBER_NOT_WHATSAPP - Retornar status para número de envio não está no Whatsapp.
SENT - Confirma mensagem foi enviada (V).(Importante que nem todos permite deixar essa opção ativa)
\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_MESSAGE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (message_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (message_id)\",\n \"message_id\": \"id da fila de envio\",\n \"whats_id\": \"id criado no aplicativo Whatsapp após o envio\",\n \"status\": \"status da mensagem\",\n \"result\": {}\n}\n\nA mensagem não foi enviada pois a instância está com uma fila de sobrecarga.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"buffer_count\": 586//Mostra a quantidade de mensagens que estão em fila aguardando envio\n}\n\nA mensagem não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false,\n \"instance_id\": \"5\"\n}\n\nA mensagem não foi enviada pois o destinatário ou mensagem não estão válidos ou vazios.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA\",\n \"isValid\": false,\n \"instance_id\": \"5\"\n}\n\nPermite usar o recurso de responder, onde marca uma mensagem e define um texto de comentário.
\nA mensagem será enviada para a fila de envio, garantimos o envio da mensagem.
\n{\n \"result\": {\n \"message_id\": \"id da fila de envio\"\n },\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\",\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nApós a mensagem ser enviada, é retornado um id de registro da fila de envio, no qual será confirmado postariormente será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da mensagem enviada anteriormente está vinculada ao \"message_id\" retornado no envio da mensagem, utilize este identificador para aplicar ações em seu webhook de retorno.
\nLEGENDA STATUS A RETORNAR DAS MENSAGENS:
NUMBER_NOT_WHATSAPP - Retornar status para número de envio não está no Whatsapp.
SENT - Confirma mensagem foi enviada (V).(Importante que nem todos permite deixar essa opção ativa)
\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_MESSAGE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (message_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (message_id)\",\n \"message_id\": \"id da fila de envio\",\n \"whats_id\": \"id criado no aplicativo Whatsapp após o envio\",\n \"status\": \"status da mensagem\",\n \"result\": {}\n}\n\nA mensagem não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false,\n \"instance_id\": \"5\"\n}\n\nA mensagem não foi enviada pois o destinatário ou mensagem não estão válidos ou vazios.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA\",\n \"isValid\": false,\n \"instance_id\": \"5\"\n}\n\nPermite usar o recurso de editar mensagem anterior enviada, onde envia uma nova mensagem e define um texto novo para substituir o anterior.
\n*Importante observar que as regras que definem qual mensagem pode ser editada devem ser consultadas na documentação oficial do Whatsapp. Onde hoje na versão atual dessa documentação o memso permite até 15min após o envio.
\nA mensagem será enviada para a fila de envio, garantimos o envio da mensagem.
\n{\n \"result\": {\n \"message_id\": \"id da fila de envio\"\n },\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_ACTION_SCHEDULED\",\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nApós a mensagem ser enviada, é retornado um id de registro da fila de envio, no qual será confirmado postariormente será disparado uma requisição para a url do webhook (verifique na documentação) configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da mensagem enviada anteriormente está vinculada ao \"message_id\" retornado no envio da mensagem, utilize este identificador para aplicar ações em seu webhook de retorno.
\nLEGENDA STATUS A RETORNAR DAS MENSAGENS:
NUMBER_NOT_WHATSAPP - Retornar status para número de envio não está no Whatsapp.
SENT - Confirma mensagem foi enviada (V).(Importante que nem todos permite deixar essa opção ativa)
\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"9UBAELV8-PIJGhT-VU5b6tKf-O304HOZ3YLUD\",\n \"ACTION\": \"CONFIRM_MESSAGE_EDIT\",\n \"instance_key\": \"UQ6R-000003-oHOs-FpZL-5QZ6861CA2JK\",\n \"instance_id\": \"3\",\n \"instance_id_reffer\": \"1233\",\n \"source\": 1,\n \"destino\": \"USER\",\n \"number\": \"5511111111111\",\n \"pushName\": \"JOAO CARLOS\",\n \"number_lid\": \"139965656565656565\", (É CONDICIONAL, NEM SEMPRE RETORNA É UMA IMPLEMENTAÇÃO NOVA DO WHATSAPP) \n \"message_id\": \"4568\",\n \"whats_id\": \"BAE54B8E5659F9D3\",\n \"editMessageId\": \"FHGFG3423FHFHG3243FHF32\",\n \"editTextMessage\": \"Mensagem enviada para edição\",\n \"time\": \"1674651262\",\n \"result\": {}\n}\n\nA mensagem não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false,\n \"instance_id\": \"5\"\n}\n\nA mensagem não foi enviada pois o destinatário ou mensagem não estão válidos ou vazios.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA\",\n \"isValid\": false,\n \"instance_id\": \"5\"\n}\n\nPermite encaminhar uma mensagem usando whats_id de envio anterior.
\nA mensagem será enviada para a fila de envio, garantimos o envio da mensagem.
\n{\n \"result\": {\n \"message_id\": \"id da fila de envio\"\n },\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\",\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nApós a mensagem ser enviada, é retornado um id de registro da fila de envio, no qual será confirmado postariormente será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da mensagem enviada anteriormente está vinculada ao \"message_id\" retornado no envio da mensagem, utilize este identificador para aplicar ações em seu webhook de retorno.
\nLEGENDA STATUS A RETORNAR DAS MENSAGENS:
NUMBER_NOT_WHATSAPP - Retornar status para número de envio não está no Whatsapp.
SENT - Confirma mensagem foi enviada (V).(Importante que nem todos permite deixar essa opção ativa)
CACHE ERROR - Não é enviado devido falhas na criptografia e cache do Whatsapp, não envia e retorna o erro.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_MESSAGE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (message_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (message_id)\",\n \"message_id\": \"id da fila de envio\",\n \"whats_id\": \"id criado no aplicativo Whatsapp após o envio\",\n \"status\": \"status da mensagem\",\n \"result\": {}\n}\n\nA mensagem não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false,\n \"instance_id\": \"5\"\n}\n\nA mensagem não foi enviada pois o destinatário ou mensagem não estão válidos ou vazios.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA\",\n \"isValid\": false,\n \"instance_id\": \"5\"\n}\n\nA mensagem não foi enviada pois o destinatário ou mensagem não estão válidos ou vazios.
\n{\n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"INVALID_CACHE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (message_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (message_id)\",\n \"message_id\": \"id da fila de envio\",\n \"whats_id\": \"id criado no aplicativo Whatsapp após o envio\",\n \"isValid\": false,\n \"result\": {}\n}\n\nPermite enviar uma mensagem com link personalizado de compartilhamento, com ícone e informções.
\nA mensagem será enviada para a fila de envio, garantimos o envio da mensagem.
\n{\n \"result\": {\n \"message_id\": \"id da fila de envio\"\n },\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\",\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nApós a mensagem ser enviada, é retornado um id de registro da fila de envio, no qual será confirmado postariormente será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da mensagem enviada anteriormente está vinculada ao \"message_id\" retornado no envio da mensagem, utilize este identificador para aplicar ações em seu webhook de retorno.
\nLEGENDA STATUS A RETORNAR DAS MENSAGENS:
NUMBER_NOT_WHATSAPP - Retornar status para número de envio não está no Whatsapp.
SENT - Confirma mensagem foi enviada (V).
\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_MESSAGE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (message_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (message_id)\",\n \"message_id\": \"id da fila de envio\",\n \"whats_id\": \"id criado no aplicativo Whatsapp após o envio\",\n \"status\": \"status da mensagem\",\n \"result\": {}\n}\n\nA mensagem não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nStartFragment
\nA mensagem não foi enviada pois o destinatário ou mensagem não estão válido ou vazios. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA\",\n \"isValid\": false,\n \"instance_id\": \"5\"\n}\n\nPermite enviar uma mensagem com localização.
\nA mensagem será enviada para a fila de envio, garantimos o envio da mensagem.
\n{\n \"result\": {\n \"message_id\": \"id da fila de envio\"\n },\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a mensagem ser enviada, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado ou recebido uma nova mensagem, preste atenção na propriedade \"key\", ele é o identificador principal da mensagem.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_MESSAGE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (message_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (message_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"message_id\": \"id da fila de envio\",\n \"whats_id\": \"id criado no aplicativo Whatsapp após o envio\",\n \"status\": \"status da mensagem\",\n \"result\": {}\n}\n\nA mensagem não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA mensagem não foi enviada pois o destinatário ou mensagem não estão válido ou vazios. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPermite enviar uma ação de deletar mensagem enviada anteriormente.
\nA ação de deletar mensagem será enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de envio\"\n },\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de deletar a mensagem ser enviada, é retornado um id de registro da ação e o whats_id criado no envio da mensagem, no qual será confirmado postariormente será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na mensagem enviada anteriormente está vinculada ao \"action_id\" ou \"whats_id\" retornado no envio da mensagem, utilize este identificador para aplicar ações em seu webhook de retorno.
\nLEGENDA STATUS A RETORNAR DAS AÇÕES DE DELETAR MENSAGENS:
MESSAGE_NOT_LOCALIZED - Retornar status para mensagem não localizada para ser removida.
JUST_JUST_ME - Só foi possível apagar para mim mesmo.
DELETED_ALL - Confirma mensagem deletada para todos.
\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_MESSAGE_DELETE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\",\n \"whats_id\": \"id criado no aplicativo Whatsapp após o envio\",\n \"status\": \"status da mensagem\",\n \"result\": {}\n}\n\nA ação da mensagem não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação da mensagem não foi enviada pois o destinatário ou whats_id não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nEnvio de mensagem com imagem, utilizando BASE64 ENCODE para envio dos arquivos de imagem de forma codificada.
\nNão se esqueça! As politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","message"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"b100bc1d-cb6a-4d41-9214-974a9366c142","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"IMAGE","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"text","value":"\"Uma mensagem com imagem direto da HalloAPI :)\"","type":"text"},{"key":"image_name","value":"opcional (image name.png)","type":"text"},{"key":"image_base64","value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAARQAAAEUCAYAAADqcMl5AAAAAklEQVR4AewaftIAABH6SURBVO3BQY4YybLgQDJR978yR0tfBZDIqJbeHzezP1hrrQse1lrrkoe11rrkYa21LnlYa61LHtZa65KHtda65GGttS55WGutSx7WWuuSh7XWuuRhrbUueVhrrUse1lrrkoe11rrkYa21LvnhI5X/UsUbKjdVTConFV+oTBVvqJxUTCr/pYpJ5aTiROWkYlJ5o2JSOamYVE4qJpX/UsUXD2utdcnDWmtd8rDWWpf8cFnFTSpfVLyhcqIyVZyonFScVEwqv6liUpkqTlSmiptUTipOVE4qJpVJ5aTiN1XcpHLTw1prXfKw1lqXPKy11iU//DKVNypuUpkqJpWpYlKZKk5UvlCZKk4q3lD5QmWq+ELljYpJ5YuKSWWqmFSmihOV36TyRsVvelhrrUse1lrrkoe11rrkh//PqJyovKEyVZyonFRMKlPFTSpTxVQxqbyhMlVMFZPKGxWTyknFGypTxRcVk8r/JQ9rrXXJw1prXfKw1lqX/PB/jMpUMalMFScqk8obKlPFpPKGylQxqXyh8obKFypTxU0VJypvqEwVk8qJylTxf8nDWmtd8rDWWpc8rLXWJT/8sorfpPJGxaQyVZxU3FTxhspvqnhD5aTiDZWTikllqjhRmSomlanijYpJZaq4qeJf8rDWWpc8rLXWJQ9rrXXJD5ep/E0Vk8pUcZPKVPGGylQxqUwVk8pUMalMFZPKicpUcVIxqUwVJxWTyhcqU8WkMlVMKlPFpDJVvKEyVZyo/Mse1lrrkoe11rrkYa21Lvnho4q/qeKk4g2VE5Wp4g2Vmyp+U8UXFb+pYlKZKt5QOVGZKk4qJpWp4qTif8nDWmtd8rDWWpc8rLXWJfYHH6hMFScqU8WkclIxqUwVk8pU8YXKScUbKlPFGyonFZPKv6ziDZWTikllqvhCZar4QmWqmFSmin/Jw1prXfKw1lqXPKy11iU//GUqU8UXKlPFpHJSMalMFScqv0llqphUJpWTijdU3qiYVKaKmyr+l1W8ofJFxU0Pa611ycNaa13ysNZal/zwUcWJylRxovJGxX9J5aTi/7KKSWWqmFTeUDmpmCpuUvlCZao4UTmp+KJiUplUpoovHtZa65KHtda65GGttS754TKVqWJSmSpOKr5Q+aLiRGVSOamYVKaKk4pJ5aTiDZWp4g2VqeJEZaqYVG6q+KJiUpkqJpWbKk5UTiomlZse1lrrkoe11rrkYa21LrE/+EBlqphU3qiYVE4qvlA5qXhDZap4Q+WLikllqjhROamYVP4lFScqb1RMKjdVfKFyUvFfelhrrUse1lrrkoe11rrE/uAvUjmpmFROKt5QOamYVE4qJpWpYlL5omJSeaNiUpkqJpWTiknlpGJSmSr+JpWp4kRlqjhROan4QmWqmFSmii8e1lrrkoe11rrkYa21LvnhI5Wp4kRlqjhROak4UZkqpopJ5Y2KmypOVCaVNyomlanipOJE5YuKSeWkYlKZKk5Ubqo4UTmp+F/2sNZalzystdYlD2utdYn9wS9SmSpOVKaKm1SmiknljYovVKaKSeWmiptU3qj4TSpTxRsqU8WkMlVMKlPFFypvVJyoTBU3Pay11iUPa611ycNaa11if/AfUvmiYlKZKiaVk4oTlaniROWk4kTlpOINlaniX6JyUvGFyhcVJyonFZPKVPGFyk0VXzystdYlD2utdcnDWmtd8sNHKicVU8UXKm9UvKEyVUwqU8UXKicVb6hMFV+onFS8oTJVnKhMFScqU8WJylRxojJVnKhMFScqU8UXFZPKb3pYa61LHtZa65KHtda65IePKr5QuUllqphUpoqp4qaKNyomlanipGJSmSreqJhUJpWTiqliUvlC5URlqjhRmSreUJkqTlSmiknljYqTiknlpoe11rrkYa21LnlYa61L7A8+UJkqTlTeqJhUporfpHJScaIyVZyovFExqUwVJypTxYnKScWkclIxqUwVk8pUMalMFScqU8WkclJxojJVTCpvVLyhMlX8poe11rrkYa21LnlYa61LfvjLKiaVSeVEZao4UZkqJpWp4g2VqWJSOak4UTmpOFGZKiaVqWKqOFGZKk5Upoo3VL6oeKNiUnlDZao4UZlUpoo3VKaKmx7WWuuSh7XWuuRhrbUu+eGjit9UcaIyqUwVb1RMKlPFf0nlRGWqOKmYVKaKSWWqmFSmit9UcaJyU8VJxU0qU8WkMqlMFVPFf+lhrbUueVhrrUse1lrrEvuDi1SmihOVNyomlaliUpkqJpWTiknli4pJZap4Q+WLijdU3qg4UTmpOFE5qfhC5W+qOFE5qZhUTiq+eFhrrUse1lrrkoe11rrkh49Upoo3Kt5QOVGZKt6o+KJiUrlJ5aRiUnlD5aTiROVEZaqYVCaVNypOVN6omFROKiaVqeJE5Y2KLypuelhrrUse1lrrkoe11rrE/uADlZOKE5WpYlI5qXhDZap4Q2WqmFSmiknlX1YxqUwVJyq/qWJS+ZdUnKicVEwqb1ScqEwVNz2stdYlD2utdcnDWmtd8sNlFZPKScVJxaQyqbxRMam8UTGpTBWTyknFicpJxaTyhcrfVHFTxaQyVUwqb1RMKlPFVDGpnFScqLxR8Zse1lrrkoe11rrkYa21LvnhP1YxqUwVk8pU8YXKFypTxUnFicobFZPKFxWTylQxqdxUMalMFZPKVHGiMlX8SyomlaniN6lMFV88rLXWJQ9rrXXJw1prXfLDL6uYVKaKk4oTlanipOINlTdUpoqTijdUpopJZar4l6lMFScVk8pJxaQyVZxUnKicqJxUnKi8oTJVTCpTxU0Pa611ycNaa13ysNZal9gf/CKVqWJS+V9WMalMFV+onFScqPxLKiaVk4pJZaqYVE4qJpWp4g2VqeINlf9SxaQyVXzxsNZalzystdYlD2utdckPl6lMFZPKScUbKlPFicpJxU0qU8VvUjmpmFSmijdUTiomlaliUplUTlROKiaVqWJSmSomlaliUjmpOKl4Q+Wk4qTipoe11rrkYa21LnlYa61LfvhIZaqYVKaKSeVEZao4UZkqTipOVE4qpoo3VE4qJpVJ5Q2VN1Smit9U8YbKVPGbKt6omFTeUJkqvlA5qfjiYa21LnlYa61LHtZa65IfflnFFxVvVEwqJypTxVQxqUwqJxWTylTxRsWkMlVMKlPFpHJS8UbFpPKGylQxqZyoTBUnKlPFpPI3VbxRMalMFb/pYa21LnlYa61LHtZa65IfLlM5qThR+U0Vk8oXFZPKpDJVTCpTxaQyVUwVJxVvqPymiknlROWNipOKE5Wp4kTlJpXfpDJV3PSw1lqXPKy11iUPa611if3BBypTxaRyUvGFyhsVJypTxYnKVDGpvFFxk8pUMalMFZPKVDGpnFTcpDJVTCpTxU0qU8UXKlPFFyonFb/pYa21LnlYa61LHtZa65If/jEqX1RMKl+oTBVTxaQyVUwqJyonFX+TyhsqU8UbKlPFpPKGyhsVX6hMFVPFpHJScVJxonJS8cXDWmtd8rDWWpc8rLXWJT98VHFTxYnKGxWTyknFpPJGxU0Vk8obFW+oTBUnKlPFb1KZKv4mlZOKSeULlZOKNypuelhrrUse1lrrkoe11rrkh19WMamcqJxUvKEyVUwqk8qJyhsVJxWTyk0qU8VJxaQyVUwVJyonFTepTBUnFZPKpDJVTCpTxaQyVbyhclLxL3lYa61LHtZa65KHtda6xP7gA5XfVDGpTBWTylRxojJVvKEyVUwqb1T8JpWp4kTlpGJS+aLiRGWq+EJlqphUpopJ5aTiRGWqmFSmihOVk4rf9LDWWpc8rLXWJQ9rrXXJD5dV3KTyL6t4o2JSmVSmihOVNyq+qJhUTiq+UHlD5TepfKHyhcpUMVVMKv+lh7XWuuRhrbUueVhrrUvsDz5QOak4UTmpOFH5l1VMKlPFpPJfqjhROam4SeWkYlKZKt5QOamYVE4qJpU3Kr5QmSomlanipoe11rrkYa21LnlYa61LfvioYlKZVKaKqeJEZaq4qeINlaniRGWqmFSmikllqphUpooTld+kMlVMKm9UTCpTxaQyVUwqf1PFpHKiMlVMKicqU8WkMlV88bDWWpc8rLXWJQ9rrXWJ/cEHKicVJypTxRsqb1RMKlPFpPJGxRcqv6niROWkYlKZKm5S+aJiUjmp+ELljYpJ5aRiUpkq/qaHtda65GGttS55WGutS374qGJSmVROKk5U3qiYVN5QOak4UTmpmFROKt5Q+U0qU8WkMlVMKr+p4m+qeENlqphUJpUTlaliUjmp+OJhrbUueVhrrUse1lrrkh9+WcWJyknFicqkMlVMKlPFicqkclIxqUwqU8UXKlPFpHJTxUnFScWk8kbFGyo3qZxUnKhMFW9UTCpTxaQyVUwqNz2stdYlD2utdcnDWmtd8sNHKlPFpHJSMalMKv+SijcqblKZKiaVqWJSOamYVCaVqeKmiknlROWk4qaKSWVSOamYVKaKE5V/2cNaa13ysNZalzystdYlP3xUcVIxqUwqU8WJym9SOVF5o+ILlanipOKmiknlDZWTipsqJpU3KiaVLyp+U8Wk8jc9rLXWJQ9rrXXJw1prXfLDP07ljYq/qeJE5aTiC5Wp4qTiROVEZaqYKiaVE5U3Kr6oOKmYVKaKN1SmiknlDZWp4m96WGutSx7WWuuSh7XWusT+4CKVqWJSmSq+UJkq3lCZKiaV/yUVb6icVJyonFRMKm9UnKicVEwqJxVvqEwVk8pUMalMFW+oTBV/08Naa13ysNZalzystdYlP3ykMlWcVJyonFT8lypOVKaKE5U3Kt5Q+aJiUpkqTipOKiaVf4nKVDGpnKhMFf8/eVhrrUse1lrrkoe11rrkh48qTlSmiknlpGJS+U0qX6h8UXFTxYnKScUXKlPFVDGpnKicVJxUTCpTxaRyk8pUMam8UTGpTBX/pYe11rrkYa21LnlYa61L7A9+kcpNFZPKScVvUpkqvlA5qZhUpopJZao4UZkqJpWpYlI5qfhCZaqYVH5TxRcqJxWTylRxonJSMalMFV88rLXWJQ9rrXXJw1prXfLDRypvVEwqU8WJyv8ylTcqJpUTlaliUvmXqUwVU8VJxRsqJxWTylTxRsWkMqlMFZPKScWJym96WGutSx7WWuuSh7XWuuSH/5jKVHGi8kbFpDJVnKhMFScVk8obFScqJxUnKlPFpHKicqJyUjGpnFRMKicVJypTxUnFpHKiMlXcpPK/5GGttS55WGutSx7WWusS+4P/YSpTxRsqU8WkclLxhspU8YbKVPGGyknFGypTxRsqv6liUpkq3lA5qZhUpopJZap4Q2WqmFSmit/0sNZalzystdYlD2utdckPH6n8lyqmikllqvhNKlPFpHKiclJxonJS8YXKVHGiMlV8UTGpnFRMKlPFGypfVHyhMlWcqEwVk8pJxRcPa611ycNaa13ysNZal/xwWcVNKicqU8WkMlW8UXGiclIxqUwVk8obFZPKpDJVTConFV+oTBVTxaQyqUwVk8pJxaQyVfzLKt6omFSmit/0sNZalzystdYlD2utdckPv0zljYo3KiaVqWJSmSomlaliUpkqJpUvKk4qJpWTijdUbqqYVH6TylQxVXxRMancpPKFyonKVHHTw1prXfKw1lqXPKy11iU//I9TmSq+qDipeKNiUplUpopJZaqYKiaVSWWqmComlaniDZWTipsqflPFScUbKlPFpHJS8YXKb3pYa61LHtZa65KHtda65If/cRWTyknFGypTxaTyRsUbFScqX6hMFScqb6hMFZPKScUbKlPFpHJSMalMFZPKTRWTyonKVDGpTBWTylTxxcNaa13ysNZalzystdYlP/yyin+ZylQxVZxU3KRyUjFVnKi8oTJVTBUnKlPFpHKTylRxUvFGxUnFGyqTyknFFxUnFTc9rLXWJQ9rrXXJw1prXfLDZSr/JZWTin+JylRxUjGpnFScqJxUvKEyVdyk8obKScWkclIxqbxRMVVMKl9UvKFyUvHFw1prXfKw1lqXPKy11iX2B2utdcHDWmtd8rDWWpc8rLXWJQ9rrXXJw1prXfKw1lqXPKy11iUPa611ycNaa13ysNZalzystdYlD2utdcnDWmtd8rDWWpc8rLXWJf8PebNhbhnTaLsAAAAASUVORK5CYII=","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"92afef44-03c0-4f33-822e-644fb0138324"},{"name":"Enviar uma mensagem com imagem URL PÚBLICA","id":"e074b8e0-b8f4-4796-b2fc-34ddab191b64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"IMAGE","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"text","value":"\"Uma mensagem com imagem direto da HalloAPI :)\"","type":"text"},{"key":"image_name","value":"opcional (image name.png)","type":"text"},{"key":"image_url","value":"https://images.all-free-download.com/images/graphiclarge/iphone_6_sample_photo_566464.jpg","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message","description":"Envio de mensagem com imagem, utilizando URL PÚBLICA para envio dos arquivos de imagem recuperada pelo sistema HalloAPI utilizando a URL informada para fazer o downaload do arquivo.
\nNão se esqueça! As politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","message"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"c239711a-d0af-45da-9158-971f334c1a53","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"IMAGE","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"text","value":"\"Uma mensagem com imagem direto da HalloAPI :)\"","type":"text"},{"key":"image_name","value":"opcional (image name.png)","type":"text"},{"key":"image_url","value":"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b3/Wikipedia-logo-v2-en.svg/1200px-Wikipedia-logo-v2-en.svg.png","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"e074b8e0-b8f4-4796-b2fc-34ddab191b64"},{"name":"Enviar uma mensagem com sticker BASE64","id":"e57134e1-fc55-484f-ae09-5025a8d4a1fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"STICKER","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"sticker_base64","value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAARQAAAEUCAYAAADqcMl5AAAAAklEQVR4AewaftIAABH6SURBVO3BQY4YybLgQDJR978yR0tfBZDIqJbeHzezP1hrrQse1lrrkoe11rrkYa21LnlYa61LHtZa65KHtda65GGttS55WGutSx7WWuuSh7XWuuRhrbUueVhrrUse1lrrkoe11rrkYa21LvnhI5X/UsUbKjdVTConFV+oTBVvqJxUTCr/pYpJ5aTiROWkYlJ5o2JSOamYVE4qJpX/UsUXD2utdcnDWmtd8rDWWpf8cFnFTSpfVLyhcqIyVZyonFScVEwqv6liUpkqTlSmiptUTipOVE4qJpVJ5aTiN1XcpHLTw1prXfKw1lqXPKy11iU//DKVNypuUpkqJpWpYlKZKk5UvlCZKk4q3lD5QmWq+ELljYpJ5YuKSWWqmFSmihOV36TyRsVvelhrrUse1lrrkoe11rrkh//PqJyovKEyVZyonFRMKlPFTSpTxVQxqbyhMlVMFZPKGxWTyknFGypTxRcVk8r/JQ9rrXXJw1prXfKw1lqX/PB/jMpUMalMFScqk8obKlPFpPKGylQxqXyh8obKFypTxU0VJypvqEwVk8qJylTxf8nDWmtd8rDWWpc8rLXWJT/8sorfpPJGxaQyVZxU3FTxhspvqnhD5aTiDZWTikllqjhRmSomlanijYpJZaq4qeJf8rDWWpc8rLXWJQ9rrXXJD5ep/E0Vk8pUcZPKVPGGylQxqUwVk8pUMalMFZPKicpUcVIxqUwVJxWTyhcqU8WkMlVMKlPFpDJVvKEyVZyo/Mse1lrrkoe11rrkYa21Lvnho4q/qeKk4g2VE5Wp4g2Vmyp+U8UXFb+pYlKZKt5QOVGZKk4qJpWp4qTif8nDWmtd8rDWWpc8rLXWJfYHH6hMFScqU8WkclIxqUwVk8pU8YXKScUbKlPFGyonFZPKv6ziDZWTikllqvhCZar4QmWqmFSmin/Jw1prXfKw1lqXPKy11iU//GUqU8UXKlPFpHJSMalMFScqv0llqphUJpWTijdU3qiYVKaKmyr+l1W8ofJFxU0Pa611ycNaa13ysNZal/zwUcWJylRxovJGxX9J5aTi/7KKSWWqmFTeUDmpmCpuUvlCZao4UTmp+KJiUplUpoovHtZa65KHtda65GGttS754TKVqWJSmSpOKr5Q+aLiRGVSOamYVKaKk4pJ5aTiDZWp4g2VqeJEZaqYVG6q+KJiUpkqJpWbKk5UTiomlZse1lrrkoe11rrkYa21LrE/+EBlqphU3qiYVE4qvlA5qXhDZap4Q+WLikllqjhROamYVP4lFScqb1RMKjdVfKFyUvFfelhrrUse1lrrkoe11rrE/uAvUjmpmFROKt5QOamYVE4qJpWpYlL5omJSeaNiUpkqJpWTiknlpGJSmSr+JpWp4kRlqjhROan4QmWqmFSmii8e1lrrkoe11rrkYa21LvnhI5Wp4kRlqjhROak4UZkqpopJ5Y2KmypOVCaVNyomlanipOJE5YuKSeWkYlKZKk5Ubqo4UTmp+F/2sNZalzystdYlD2utdYn9wS9SmSpOVKaKm1SmiknljYovVKaKSeWmiptU3qj4TSpTxRsqU8WkMlVMKlPFFypvVJyoTBU3Pay11iUPa611ycNaa11if/AfUvmiYlKZKiaVk4oTlaniROWk4kTlpOINlaniX6JyUvGFyhcVJyonFZPKVPGFyk0VXzystdYlD2utdcnDWmtd8sNHKicVU8UXKm9UvKEyVUwqU8UXKicVb6hMFV+onFS8oTJVnKhMFScqU8WJylRxojJVnKhMFScqU8UXFZPKb3pYa61LHtZa65KHtda65IePKr5QuUllqphUpoqp4qaKNyomlanipGJSmSreqJhUJpWTiqliUvlC5URlqjhRmSreUJkqTlSmiknljYqTiknlpoe11rrkYa21LnlYa61L7A8+UJkqTlTeqJhUporfpHJScaIyVZyovFExqUwVJypTxYnKScWkclIxqUwVk8pUMalMFScqU8WkclJxojJVTCpvVLyhMlX8poe11rrkYa21LnlYa61LfvjLKiaVSeVEZao4UZkqJpWp4g2VqWJSOak4UTmpOFGZKiaVqWKqOFGZKk5Upoo3VL6oeKNiUnlDZao4UZlUpoo3VKaKmx7WWuuSh7XWuuRhrbUu+eGjit9UcaIyqUwVb1RMKlPFf0nlRGWqOKmYVKaKSWWqmFSmit9UcaJyU8VJxU0qU8WkMqlMFVPFf+lhrbUueVhrrUse1lrrEvuDi1SmihOVNyomlaliUpkqJpWTiknli4pJZap4Q+WLijdU3qg4UTmpOFE5qfhC5W+qOFE5qZhUTiq+eFhrrUse1lrrkoe11rrkh49Upoo3Kt5QOVGZKt6o+KJiUrlJ5aRiUnlD5aTiROVEZaqYVCaVNypOVN6omFROKiaVqeJE5Y2KLypuelhrrUse1lrrkoe11rrE/uADlZOKE5WpYlI5qXhDZap4Q2WqmFSmiknlX1YxqUwVJyq/qWJS+ZdUnKicVEwqb1ScqEwVNz2stdYlD2utdcnDWmtd8sNlFZPKScVJxaQyqbxRMam8UTGpTBWTyknFicpJxaTyhcrfVHFTxaQyVUwqb1RMKlPFVDGpnFScqLxR8Zse1lrrkoe11rrkYa21LvnhP1YxqUwVk8pU8YXKFypTxUnFicobFZPKFxWTylQxqdxUMalMFZPKVHGiMlX8SyomlaniN6lMFV88rLXWJQ9rrXXJw1prXfLDL6uYVKaKk4oTlanipOINlTdUpoqTijdUpopJZar4l6lMFScVk8pJxaQyVZxUnKicqJxUnKi8oTJVTCpTxU0Pa611ycNaa13ysNZal9gf/CKVqWJS+V9WMalMFV+onFScqPxLKiaVk4pJZaqYVE4qJpWp4g2VqeINlf9SxaQyVXzxsNZalzystdYlD2utdckPl6lMFZPKScUbKlPFicpJxU0qU8VvUjmpmFSmijdUTiomlaliUplUTlROKiaVqWJSmSomlaliUjmpOKl4Q+Wk4qTipoe11rrkYa21LnlYa61LfvhIZaqYVKaKSeVEZao4UZkqTipOVE4qpoo3VE4qJpVJ5Q2VN1Smit9U8YbKVPGbKt6omFTeUJkqvlA5qfjiYa21LnlYa61LHtZa65IfflnFFxVvVEwqJypTxVQxqUwqJxWTylTxRsWkMlVMKlPFpHJS8UbFpPKGylQxqZyoTBUnKlPFpPI3VbxRMalMFb/pYa21LnlYa61LHtZa65IfLlM5qThR+U0Vk8oXFZPKpDJVTCpTxaQyVUwVJxVvqPymiknlROWNipOKE5Wp4kTlJpXfpDJV3PSw1lqXPKy11iUPa611if3BBypTxaRyUvGFyhsVJypTxYnKVDGpvFFxk8pUMalMFZPKVDGpnFTcpDJVTCpTxU0qU8UXKlPFFyonFb/pYa21LnlYa61LHtZa65If/jEqX1RMKl+oTBVTxaQyVUwqJyonFX+TyhsqU8UbKlPFpPKGyhsVX6hMFVPFpHJScVJxonJS8cXDWmtd8rDWWpc8rLXWJT98VHFTxYnKGxWTyknFpPJGxU0Vk8obFW+oTBUnKlPFb1KZKv4mlZOKSeULlZOKNypuelhrrUse1lrrkoe11rrkh19WMamcqJxUvKEyVUwqk8qJyhsVJxWTyk0qU8VJxaQyVUwVJyonFTepTBUnFZPKpDJVTCpTxaQyVbyhclLxL3lYa61LHtZa65KHtda6xP7gA5XfVDGpTBWTylRxojJVvKEyVUwqb1T8JpWp4kTlpGJS+aLiRGWq+EJlqphUpopJ5aTiRGWqmFSmihOVk4rf9LDWWpc8rLXWJQ9rrXXJD5dV3KTyL6t4o2JSmVSmihOVNyq+qJhUTiq+UHlD5TepfKHyhcpUMVVMKv+lh7XWuuRhrbUueVhrrUvsDz5QOak4UTmpOFH5l1VMKlPFpPJfqjhROam4SeWkYlKZKt5QOamYVE4qJpU3Kr5QmSomlanipoe11rrkYa21LnlYa61LfvioYlKZVKaKqeJEZaq4qeINlaniRGWqmFSmikllqphUpooTld+kMlVMKm9UTCpTxaQyVUwqf1PFpHKiMlVMKicqU8WkMlV88bDWWpc8rLXWJQ9rrXWJ/cEHKicVJypTxRsqb1RMKlPFpPJGxRcqv6niROWkYlKZKm5S+aJiUjmp+ELljYpJ5aRiUpkq/qaHtda65GGttS55WGutS374qGJSmVROKk5U3qiYVN5QOak4UTmpmFROKt5Q+U0qU8WkMlVMKr+p4m+qeENlqphUJpUTlaliUjmp+OJhrbUueVhrrUse1lrrkh9+WcWJyknFicqkMlVMKlPFicqkclIxqUwqU8UXKlPFpHJTxUnFScWk8kbFGyo3qZxUnKhMFW9UTCpTxaQyVUwqNz2stdYlD2utdcnDWmtd8sNHKlPFpHJSMalMKv+SijcqblKZKiaVqWJSOamYVCaVqeKmiknlROWk4qaKSWVSOamYVKaKE5V/2cNaa13ysNZalzystdYlP3xUcVIxqUwqU8WJym9SOVF5o+ILlanipOKmiknlDZWTipsqJpU3KiaVLyp+U8Wk8jc9rLXWJQ9rrXXJw1prXfLDP07ljYq/qeJE5aTiC5Wp4qTiROVEZaqYKiaVE5U3Kr6oOKmYVKaKN1SmiknlDZWp4m96WGutSx7WWuuSh7XWusT+4CKVqWJSmSq+UJkq3lCZKiaV/yUVb6icVJyonFRMKm9UnKicVEwqJxVvqEwVk8pUMalMFW+oTBV/08Naa13ysNZalzystdYlP3ykMlWcVJyonFT8lypOVKaKE5U3Kt5Q+aJiUpkqTipOKiaVf4nKVDGpnKhMFf8/eVhrrUse1lrrkoe11rrkh48qTlSmiknlpGJS+U0qX6h8UXFTxYnKScUXKlPFVDGpnKicVJxUTCpTxaRyk8pUMam8UTGpTBX/pYe11rrkYa21LnlYa61L7A9+kcpNFZPKScVvUpkqvlA5qZhUpopJZao4UZkqJpWpYlI5qfhCZaqYVH5TxRcqJxWTylRxonJSMalMFV88rLXWJQ9rrXXJw1prXfLDRypvVEwqU8WJyv8ylTcqJpUTlaliUvmXqUwVU8VJxRsqJxWTylTxRsWkMqlMFZPKScWJym96WGutSx7WWuuSh7XWuuSH/5jKVHGi8kbFpDJVnKhMFScVk8obFScqJxUnKlPFpHKicqJyUjGpnFRMKicVJypTxUnFpHKiMlXcpPK/5GGttS55WGutSx7WWusS+4P/YSpTxRsqU8WkclLxhspU8YbKVPGGyknFGypTxRsqv6liUpkq3lA5qZhUpopJZap4Q2WqmFSmit/0sNZalzystdYlD2utdckPH6n8lyqmikllqvhNKlPFpHKiclJxonJS8YXKVHGiMlV8UTGpnFRMKlPFGypfVHyhMlWcqEwVk8pJxRcPa611ycNaa13ysNZal/xwWcVNKicqU8WkMlW8UXGiclIxqUwVk8obFZPKpDJVTConFV+oTBVTxaQyqUwVk8pJxaQyVfzLKt6omFSmit/0sNZalzystdYlD2utdckPv0zljYo3KiaVqWJSmSomlaliUpkqJpUvKk4qJpWTijdUbqqYVH6TylQxVXxRMancpPKFyonKVHHTw1prXfKw1lqXPKy11iU//I9TmSq+qDipeKNiUplUpopJZaqYKiaVSWWqmComlaniDZWTipsqflPFScUbKlPFpHJS8YXKb3pYa61LHtZa65KHtda65If/cRWTyknFGypTxaTyRsUbFScqX6hMFScqb6hMFZPKScUbKlPFpHJSMalMFZPKTRWTyonKVDGpTBWTylTxxcNaa13ysNZalzystdYlP/yyin+ZylQxVZxU3KRyUjFVnKi8oTJVTBUnKlPFpHKTylRxUvFGxUnFGyqTyknFFxUnFTc9rLXWJQ9rrXXJw1prXfLDZSr/JZWTin+JylRxUjGpnFScqJxUvKEyVdyk8obKScWkclIxqbxRMVVMKl9UvKFyUvHFw1prXfKw1lqXPKy11iX2B2utdcHDWmtd8rDWWpc8rLXWJQ9rrXXJw1prXfKw1lqXPKy11iUPa611ycNaa13ysNZalzystdYlD2utdcnDWmtd8rDWWpc8rLXWJf8PebNhbhnTaLsAAAAASUVORK5CYII=","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message","description":"Envio de mensagem com imagem, utilizando BASE64 ENCODE para envio dos arquivos de imagem de forma codificada.
\nNão se esqueça! As politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","message"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"0f8f6331-6ace-472f-a495-9065d48f6c45","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"IMAGE","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"text","value":"\"Uma mensagem com imagem direto da HalloAPI :)\"","type":"text"},{"key":"image_name","value":"opcional (image name.png)","type":"text"},{"key":"image_base64","value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAARQAAAEUCAYAAADqcMl5AAAAAklEQVR4AewaftIAABH6SURBVO3BQY4YybLgQDJR978yR0tfBZDIqJbeHzezP1hrrQse1lrrkoe11rrkYa21LnlYa61LHtZa65KHtda65GGttS55WGutSx7WWuuSh7XWuuRhrbUueVhrrUse1lrrkoe11rrkYa21LvnhI5X/UsUbKjdVTConFV+oTBVvqJxUTCr/pYpJ5aTiROWkYlJ5o2JSOamYVE4qJpX/UsUXD2utdcnDWmtd8rDWWpf8cFnFTSpfVLyhcqIyVZyonFScVEwqv6liUpkqTlSmiptUTipOVE4qJpVJ5aTiN1XcpHLTw1prXfKw1lqXPKy11iU//DKVNypuUpkqJpWpYlKZKk5UvlCZKk4q3lD5QmWq+ELljYpJ5YuKSWWqmFSmihOV36TyRsVvelhrrUse1lrrkoe11rrkh//PqJyovKEyVZyonFRMKlPFTSpTxVQxqbyhMlVMFZPKGxWTyknFGypTxRcVk8r/JQ9rrXXJw1prXfKw1lqX/PB/jMpUMalMFScqk8obKlPFpPKGylQxqXyh8obKFypTxU0VJypvqEwVk8qJylTxf8nDWmtd8rDWWpc8rLXWJT/8sorfpPJGxaQyVZxU3FTxhspvqnhD5aTiDZWTikllqjhRmSomlanijYpJZaq4qeJf8rDWWpc8rLXWJQ9rrXXJD5ep/E0Vk8pUcZPKVPGGylQxqUwVk8pUMalMFZPKicpUcVIxqUwVJxWTyhcqU8WkMlVMKlPFpDJVvKEyVZyo/Mse1lrrkoe11rrkYa21Lvnho4q/qeKk4g2VE5Wp4g2Vmyp+U8UXFb+pYlKZKt5QOVGZKk4qJpWp4qTif8nDWmtd8rDWWpc8rLXWJfYHH6hMFScqU8WkclIxqUwVk8pU8YXKScUbKlPFGyonFZPKv6ziDZWTikllqvhCZar4QmWqmFSmin/Jw1prXfKw1lqXPKy11iU//GUqU8UXKlPFpHJSMalMFScqv0llqphUJpWTijdU3qiYVKaKmyr+l1W8ofJFxU0Pa611ycNaa13ysNZal/zwUcWJylRxovJGxX9J5aTi/7KKSWWqmFTeUDmpmCpuUvlCZao4UTmp+KJiUplUpoovHtZa65KHtda65GGttS754TKVqWJSmSpOKr5Q+aLiRGVSOamYVKaKk4pJ5aTiDZWp4g2VqeJEZaqYVG6q+KJiUpkqJpWbKk5UTiomlZse1lrrkoe11rrkYa21LrE/+EBlqphU3qiYVE4qvlA5qXhDZap4Q+WLikllqjhROamYVP4lFScqb1RMKjdVfKFyUvFfelhrrUse1lrrkoe11rrE/uAvUjmpmFROKt5QOamYVE4qJpWpYlL5omJSeaNiUpkqJpWTiknlpGJSmSr+JpWp4kRlqjhROan4QmWqmFSmii8e1lrrkoe11rrkYa21LvnhI5Wp4kRlqjhROak4UZkqpopJ5Y2KmypOVCaVNyomlanipOJE5YuKSeWkYlKZKk5Ubqo4UTmp+F/2sNZalzystdYlD2utdYn9wS9SmSpOVKaKm1SmiknljYovVKaKSeWmiptU3qj4TSpTxRsqU8WkMlVMKlPFFypvVJyoTBU3Pay11iUPa611ycNaa11if/AfUvmiYlKZKiaVk4oTlaniROWk4kTlpOINlaniX6JyUvGFyhcVJyonFZPKVPGFyk0VXzystdYlD2utdcnDWmtd8sNHKicVU8UXKm9UvKEyVUwqU8UXKicVb6hMFV+onFS8oTJVnKhMFScqU8WJylRxojJVnKhMFScqU8UXFZPKb3pYa61LHtZa65KHtda65IePKr5QuUllqphUpoqp4qaKNyomlanipGJSmSreqJhUJpWTiqliUvlC5URlqjhRmSreUJkqTlSmiknljYqTiknlpoe11rrkYa21LnlYa61L7A8+UJkqTlTeqJhUporfpHJScaIyVZyovFExqUwVJypTxYnKScWkclIxqUwVk8pUMalMFScqU8WkclJxojJVTCpvVLyhMlX8poe11rrkYa21LnlYa61LfvjLKiaVSeVEZao4UZkqJpWp4g2VqWJSOak4UTmpOFGZKiaVqWKqOFGZKk5Upoo3VL6oeKNiUnlDZao4UZlUpoo3VKaKmx7WWuuSh7XWuuRhrbUu+eGjit9UcaIyqUwVb1RMKlPFf0nlRGWqOKmYVKaKSWWqmFSmit9UcaJyU8VJxU0qU8WkMqlMFVPFf+lhrbUueVhrrUse1lrrEvuDi1SmihOVNyomlaliUpkqJpWTiknli4pJZap4Q+WLijdU3qg4UTmpOFE5qfhC5W+qOFE5qZhUTiq+eFhrrUse1lrrkoe11rrkh49Upoo3Kt5QOVGZKt6o+KJiUrlJ5aRiUnlD5aTiROVEZaqYVCaVNypOVN6omFROKiaVqeJE5Y2KLypuelhrrUse1lrrkoe11rrE/uADlZOKE5WpYlI5qXhDZap4Q2WqmFSmiknlX1YxqUwVJyq/qWJS+ZdUnKicVEwqb1ScqEwVNz2stdYlD2utdcnDWmtd8sNlFZPKScVJxaQyqbxRMam8UTGpTBWTyknFicpJxaTyhcrfVHFTxaQyVUwqb1RMKlPFVDGpnFScqLxR8Zse1lrrkoe11rrkYa21LvnhP1YxqUwVk8pU8YXKFypTxUnFicobFZPKFxWTylQxqdxUMalMFZPKVHGiMlX8SyomlaniN6lMFV88rLXWJQ9rrXXJw1prXfLDL6uYVKaKk4oTlanipOINlTdUpoqTijdUpopJZar4l6lMFScVk8pJxaQyVZxUnKicqJxUnKi8oTJVTCpTxU0Pa611ycNaa13ysNZal9gf/CKVqWJS+V9WMalMFV+onFScqPxLKiaVk4pJZaqYVE4qJpWp4g2VqeINlf9SxaQyVXzxsNZalzystdYlD2utdckPl6lMFZPKScUbKlPFicpJxU0qU8VvUjmpmFSmijdUTiomlaliUplUTlROKiaVqWJSmSomlaliUjmpOKl4Q+Wk4qTipoe11rrkYa21LnlYa61LfvhIZaqYVKaKSeVEZao4UZkqTipOVE4qpoo3VE4qJpVJ5Q2VN1Smit9U8YbKVPGbKt6omFTeUJkqvlA5qfjiYa21LnlYa61LHtZa65IfflnFFxVvVEwqJypTxVQxqUwqJxWTylTxRsWkMlVMKlPFpHJS8UbFpPKGylQxqZyoTBUnKlPFpPI3VbxRMalMFb/pYa21LnlYa61LHtZa65IfLlM5qThR+U0Vk8oXFZPKpDJVTCpTxaQyVUwVJxVvqPymiknlROWNipOKE5Wp4kTlJpXfpDJV3PSw1lqXPKy11iUPa611if3BBypTxaRyUvGFyhsVJypTxYnKVDGpvFFxk8pUMalMFZPKVDGpnFTcpDJVTCpTxU0qU8UXKlPFFyonFb/pYa21LnlYa61LHtZa65If/jEqX1RMKl+oTBVTxaQyVUwqJyonFX+TyhsqU8UbKlPFpPKGyhsVX6hMFVPFpHJScVJxonJS8cXDWmtd8rDWWpc8rLXWJT98VHFTxYnKGxWTyknFpPJGxU0Vk8obFW+oTBUnKlPFb1KZKv4mlZOKSeULlZOKNypuelhrrUse1lrrkoe11rrkh19WMamcqJxUvKEyVUwqk8qJyhsVJxWTyk0qU8VJxaQyVUwVJyonFTepTBUnFZPKpDJVTCpTxaQyVbyhclLxL3lYa61LHtZa65KHtda6xP7gA5XfVDGpTBWTylRxojJVvKEyVUwqb1T8JpWp4kTlpGJS+aLiRGWq+EJlqphUpopJ5aTiRGWqmFSmihOVk4rf9LDWWpc8rLXWJQ9rrXXJD5dV3KTyL6t4o2JSmVSmihOVNyq+qJhUTiq+UHlD5TepfKHyhcpUMVVMKv+lh7XWuuRhrbUueVhrrUvsDz5QOak4UTmpOFH5l1VMKlPFpPJfqjhROam4SeWkYlKZKt5QOamYVE4qJpU3Kr5QmSomlanipoe11rrkYa21LnlYa61LfvioYlKZVKaKqeJEZaq4qeINlaniRGWqmFSmikllqphUpooTld+kMlVMKm9UTCpTxaQyVUwqf1PFpHKiMlVMKicqU8WkMlV88bDWWpc8rLXWJQ9rrXWJ/cEHKicVJypTxRsqb1RMKlPFpPJGxRcqv6niROWkYlKZKm5S+aJiUjmp+ELljYpJ5aRiUpkq/qaHtda65GGttS55WGutS374qGJSmVROKk5U3qiYVN5QOak4UTmpmFROKt5Q+U0qU8WkMlVMKr+p4m+qeENlqphUJpUTlaliUjmp+OJhrbUueVhrrUse1lrrkh9+WcWJyknFicqkMlVMKlPFicqkclIxqUwqU8UXKlPFpHJTxUnFScWk8kbFGyo3qZxUnKhMFW9UTCpTxaQyVUwqNz2stdYlD2utdcnDWmtd8sNHKlPFpHJSMalMKv+SijcqblKZKiaVqWJSOamYVCaVqeKmiknlROWk4qaKSWVSOamYVKaKE5V/2cNaa13ysNZalzystdYlP3xUcVIxqUwqU8WJym9SOVF5o+ILlanipOKmiknlDZWTipsqJpU3KiaVLyp+U8Wk8jc9rLXWJQ9rrXXJw1prXfLDP07ljYq/qeJE5aTiC5Wp4qTiROVEZaqYKiaVE5U3Kr6oOKmYVKaKN1SmiknlDZWp4m96WGutSx7WWuuSh7XWusT+4CKVqWJSmSq+UJkq3lCZKiaV/yUVb6icVJyonFRMKm9UnKicVEwqJxVvqEwVk8pUMalMFW+oTBV/08Naa13ysNZalzystdYlP3ykMlWcVJyonFT8lypOVKaKE5U3Kt5Q+aJiUpkqTipOKiaVf4nKVDGpnKhMFf8/eVhrrUse1lrrkoe11rrkh48qTlSmiknlpGJS+U0qX6h8UXFTxYnKScUXKlPFVDGpnKicVJxUTCpTxaRyk8pUMam8UTGpTBX/pYe11rrkYa21LnlYa61L7A9+kcpNFZPKScVvUpkqvlA5qZhUpopJZao4UZkqJpWpYlI5qfhCZaqYVH5TxRcqJxWTylRxonJSMalMFV88rLXWJQ9rrXXJw1prXfLDRypvVEwqU8WJyv8ylTcqJpUTlaliUvmXqUwVU8VJxRsqJxWTylTxRsWkMqlMFZPKScWJym96WGutSx7WWuuSh7XWuuSH/5jKVHGi8kbFpDJVnKhMFScVk8obFScqJxUnKlPFpHKicqJyUjGpnFRMKicVJypTxUnFpHKiMlXcpPK/5GGttS55WGutSx7WWusS+4P/YSpTxRsqU8WkclLxhspU8YbKVPGGyknFGypTxRsqv6liUpkq3lA5qZhUpopJZap4Q2WqmFSmit/0sNZalzystdYlD2utdckPH6n8lyqmikllqvhNKlPFpHKiclJxonJS8YXKVHGiMlV8UTGpnFRMKlPFGypfVHyhMlWcqEwVk8pJxRcPa611ycNaa13ysNZal/xwWcVNKicqU8WkMlW8UXGiclIxqUwVk8obFZPKpDJVTConFV+oTBVTxaQyqUwVk8pJxaQyVfzLKt6omFSmit/0sNZalzystdYlD2utdckPv0zljYo3KiaVqWJSmSomlaliUpkqJpUvKk4qJpWTijdUbqqYVH6TylQxVXxRMancpPKFyonKVHHTw1prXfKw1lqXPKy11iU//I9TmSq+qDipeKNiUplUpopJZaqYKiaVSWWqmComlaniDZWTipsqflPFScUbKlPFpHJS8YXKb3pYa61LHtZa65KHtda65If/cRWTyknFGypTxaTyRsUbFScqX6hMFScqb6hMFZPKScUbKlPFpHJSMalMFZPKTRWTyonKVDGpTBWTylTxxcNaa13ysNZalzystdYlP/yyin+ZylQxVZxU3KRyUjFVnKi8oTJVTBUnKlPFpHKTylRxUvFGxUnFGyqTyknFFxUnFTc9rLXWJQ9rrXXJw1prXfLDZSr/JZWTin+JylRxUjGpnFScqJxUvKEyVdyk8obKScWkclIxqbxRMVVMKl9UvKFyUvHFw1prXfKw1lqXPKy11iX2B2utdcHDWmtd8rDWWpc8rLXWJQ9rrXXJw1prXfKw1lqXPKy11iUPa611ycNaa13ysNZalzystdYlD2utdcnDWmtd8rDWWpc8rLXWJf8PebNhbhnTaLsAAAAASUVORK5CYII=","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"e57134e1-fc55-484f-ae09-5025a8d4a1fb"},{"name":"Enviar uma mensagem com sticker URL PÚBLICA","id":"7c736e46-b9fe-40f9-afcf-dbac9706babd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"STICKER","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"sticker_url","value":"https://dayax.net/Media/sticker_mv.webp","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message","description":"Envio de mensagem com imagem, utilizando URL PÚBLICA para envio dos arquivos de imagem recuperada pelo sistema HalloAPI utilizando a URL informada para fazer o downaload do arquivo.
\nNão se esqueça! As politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","message"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"4c9ef67d-7f20-4fb7-8c6b-92152f34a9d7","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"IMAGE","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"text","value":"\"Uma mensagem com imagem direto da HalloAPI :)\"","type":"text"},{"key":"image_name","value":"opcional (image name.png)","type":"text"},{"key":"image_url","value":"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b3/Wikipedia-logo-v2-en.svg/1200px-Wikipedia-logo-v2-en.svg.png","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"7c736e46-b9fe-40f9-afcf-dbac9706babd"},{"name":"Enviar uma mensagem com video BASE64","id":"cdd2df8d-9068-4775-bce9-7b94cce06f57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"VIDEO","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"text","value":"\"Uma mensagem com video direto da HalloAPI :)\"","type":"text"},{"key":"video_name","value":"opcional (video name.mp4)","type":"text"},{"key":"video_base64","value":"data:video/mp4;base64,DAAYXJ0eHJlZgIGZ0eHDQyAAg3NDINCiUlRUAAAG1wNDJtcD.......","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message","description":"Envio de mensagem com vídeo, utilizando BASE64 ENCODE para envio dos arquivos de vídeo de forma codificada.
\nNão se esqueça! As politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","message"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"77b49f52-466f-4bf4-8c68-3c721c528a3f","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"VIDEO","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"text","value":"\"Uma mensagem com video direto da HalloAPI :)\"","type":"text"},{"key":"video_name","value":"opcional (image name.png)","type":"text"},{"key":"video_base64","value":"data:video/mp4;base64,DAAYXJ0eHJlZgIGZ0eHDQyAAg3NDINCiUlRUAAAG1wNDJtcD.......","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"cdd2df8d-9068-4775-bce9-7b94cce06f57"},{"name":"Enviar uma mensagem com video URL PÚBLICA","id":"5ede45ab-03a5-493d-81d8-7145a2f4059a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"VIDEO","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"text","value":"\"Uma mensagem com video direto da HalloAPI :)\"","type":"text"},{"key":"video_name","value":"opcional (image name.png)","type":"text"},{"key":"video_url","value":"https://github.com/intel-iot-devkit/sample-videos/raw/master/people-detection.mp4","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message","description":"Envio de mensagem com vídeo, utilizando URL PÚBLICA para envio dos arquivos de vídeo recuperada pelo sistema HalloAPI utilizando a URL informada para fazer o downaload do arquivo.
\nNão se esqueça! As politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","message"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"f69f3d98-9de7-418e-bac1-0019aeeeeeef","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"VIDEO","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"text","value":"\"Uma mensagem com video direto da HalloAPI :)\"","type":"text"},{"key":"video_name","value":"opcional (image name.png)","type":"text"},{"key":"video_url","value":"https://github.com/intel-iot-devkit/sample-videos/raw/master/people-detection.mp4","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"5ede45ab-03a5-493d-81d8-7145a2f4059a"},{"name":"Enviar uma mensagem com áudio BASE64","id":"781006cc-3a0b-4474-975c-de5b7b2af6bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"AUDIO","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"audio_name","value":"opcional (audio name.mp3)","type":"text"},{"key":"audio_base64","value":"data:audio/mp3;base64,DAAYXJ0eHJlZgIGZ0eHDQyAAg3NDINCiUlRUAAAG1wNDJtcD.......","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message","description":"Envio de mensagem com áudio, utilizando BASE64 ENCODE para envio dos arquivos de áudio de forma codificada.
\nNão se esqueça! As politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","message"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"a82d8cc2-6112-4776-95a5-ada92a8270e2","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"AUDIO","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"audio_name","value":"opcional (audio name.mp3)","type":"text"},{"key":"audio_base64","value":"data:audio/mp3;base64,DAAYXJ0eHJlZgIGZ0eHDQyAAg3NDINCiUlRUAAAG1wNDJtcD.......","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"781006cc-3a0b-4474-975c-de5b7b2af6bc"},{"name":"Enviar uma mensagem com áudio URL PÚBLICA","id":"329d3bac-cc70-4814-b6fc-ba45ee09a05b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"AUDIO","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"audio_name","value":"opcional (audio name.ogg)","type":"text"},{"key":"audio_url","value":"https://upload.wikimedia.org/wikipedia/en/a/ab/03_Maroon_5_Daylight.ogg","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message","description":"Envio de mensagem com áudio, utilizando URL PÚBLICA para envio dos arquivos de áudio recuperada pelo sistema HalloAPI utilizando a URL informada para fazer o downaload do arquivo.
\nNão se esqueça! As politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","message"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"75da4328-2ecc-48a7-b364-30e01e43d0ae","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"AUDIO","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"audio_name","value":"opcional (audio name.ogg)","type":"text"},{"key":"audio_url","value":"https://upload.wikimedia.org/wikipedia/en/a/ab/03_Maroon_5_Daylight.ogg","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"329d3bac-cc70-4814-b6fc-ba45ee09a05b"},{"name":"Enviar uma mensagem com documento BASE64","id":"183c1450-b835-4d28-a5bc-bfcdecfbf816","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"DOCUMENT","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"text","value":"\"Uma mensagem com documento direto da HalloAPI :)\"","type":"text"},{"key":"document_name","value":"opcional (document name.pdf)","type":"text"},{"key":"document_base64","value":"data:application/pdf;base64,DAAYXJ0eHJlZgIGZ0eHDQyAAg3NDINCiUlRUAAAG1wNDJtcD.......","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message","description":"Envio de mensagem com documento, utilizando BASE64 ENCODE para envio dos arquivos de documentos de forma codificada.
\nNão se esqueça! A extensão/tipo do aquivo que deseja enviar ! Teóricamente este método deve suportar todos tipos de documentos, desde que eles estejam dentro das politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui).
\nO Whatsapp limita o tamanho de arquivos e sua politica muda constantemente, por isso sempre recomendamos a verificação direto no site do próprio Whatsapp.
\nNeste link você encontra tudo que precisa saber sobre formatos e tamanhos de arquivos.
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","message"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"7e0be3a5-fda4-482b-ba99-f8b23993457f","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"DOCUMENT","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"text","value":"\"Uma mensagem com documento direto da HalloAPI :)\"","type":"text"},{"key":"document_name","value":"opcional (document name.pdf)","type":"text"},{"key":"document_base64","value":"data:application/pdf;base64,DAAYXJ0eHJlZgIGZ0eHDQyAAg3NDINCiUlRUAAAG1wNDJtcD.......","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"183c1450-b835-4d28-a5bc-bfcdecfbf816"},{"name":"Enviar uma mensagem com documento URL PÚBLICA","id":"c08a48ff-2e20-4d6d-895e-3011b473ef9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"DOCUMENT","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"text","value":"\"Uma mensagem com documento direto da HalloAPI :)\"","type":"text"},{"key":"document_name","value":"opcional (document name.pdf)","type":"text"},{"key":"document_url","value":"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message","description":"Envio de mensagem com documento, utilizando URL PÚBLICA para envio dos arquivos de documentos recuperado pelo sistema HalloAPI utilizando a URL informada para fazer o downaload do arquivo.
\nNão se esqueça! A extensão/tipo do aquivo que deseja enviar ! Teóricamente este método deve suportar todos tipos de documentos, desde que eles estejam dentro das politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui).
\nO Whatsapp limita o tamanho de arquivos e sua politica muda constantemente, por isso sempre recomendamos a verificação direto no site do próprio Whatsapp.
\nNeste link você encontra tudo que precisa saber sobre formatos e tamanhos de arquivos.
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","message"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"98a9c728-f1ac-460a-9bb4-a5ad69449dc6","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"DOCUMENT","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"text","value":"\"Uma mensagem com documento direto da HalloAPI :)\"","type":"text"},{"key":"document_name","value":"opcional (document name.pdf)","type":"text"},{"key":"document_url","value":"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"c08a48ff-2e20-4d6d-895e-3011b473ef9d"},{"name":"Enviar mensagem com lista para enquete/pesquisa","id":"74704bab-3818-46ce-91ce-088187ccd49c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"POLLS","type":"text"},{"key":"destination","value":"{{phoneNumber}}","type":"text"},{"key":"text","value":" Uma mensagem de lista de seleção para enquete direto da HalloAPI :)","type":"text"},{"key":"options[0]","value":"Item 1","type":"text"},{"key":"options[1]","value":"Item 2","type":"text"},{"key":"options[2]","value":"Item 3","type":"text"},{"key":"options[3]","value":"Item 4","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/message","description":"Permite enviar uma mensagem com uma lista de opções em uma enquete/pesquisa, retornando a opção selecionada no webhook.
\nSUCCESS - STATUS CODE 200
\nA mensagem será enviada para a fila de envio, garantimos o envio da mensagem.
\n{\n \"result\": {\n \"message_id\": \"id da fila de envio\"\n },\n \"message\": \"MESSAGE_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a mensagem ser enviada, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado ou recebido uma nova mensagem, preste atenção na propriedade \"key\", ele é o identificador principal da mensagem.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_MESSAGE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (message_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (message_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"message_id\": \"id da fila de envio\",\n \"whats_id\": \"id criado no aplicativo Whatsapp após o envio\",\n \"status\": \"status da mensagem\",\n \"result\": {}\n}\n\nA mensagem não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA mensagem não foi enviada pois o destinatário ou mensagem não estão válido ou vazios. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPermite enviar uma mensagem com uma lista de opções em uma enquete/pesquisa, retornando a opção selecionada no webhook.
\nSUCCESS - STATUS CODE 200
\nA mensagem será enviada para a fila de envio, garantimos o envio da mensagem.
\n{\n \"result\": {\n \"message_id\": \"id da fila de envio\"\n },\n \"message\": \"MESSAGE_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a mensagem ser enviada, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado ou recebido uma nova mensagem, preste atenção na propriedade \"key\", ele é o identificador principal da mensagem.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_MESSAGE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (message_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (message_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"message_id\": \"id da fila de envio\",\n \"whats_id\": \"id criado no aplicativo Whatsapp após o envio\",\n \"status\": \"status da mensagem\",\n \"result\": {}\n}\n\nA mensagem não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA mensagem não foi enviada pois o destinatário ou mensagem não estão válido ou vazios. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPermite criar um novo grupo com diversos participantes.
\nA ação de criação do grupo será enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"group_id\": \"id da fila de criação\"\n },\n \"message\": \"MESSAGE_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de criar novo grupo ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na mensagem enviada anteriormente está vinculada ao \"group_id\" retornado na ação de criar, junto é retornado \"whats_id\" utilizado para operações futuras com o grupo, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSOBRE O SUCESSO DA OPERAÇÃO:
whats_id For diferente de VAZIO, retornando o id gerado a operação deve sucesso.
STATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_GROUP_CREATED\",\n \"instance_key\": \"Key da instância que enviou a mensagem (group_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (group_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"group_id\": \"id da fila de ações\",\n \"whats_id\": \"id criado no aplicativo Whatsapp após o envio, SE RETORNA VAZIO NÃO FOI CRIADO\",\n \"status\": \"SUCCESS\",\n \"result\": {}\n}\n\nA ação da criação do grupo não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de criar o grupo não foi enviada pois o nome do grupo ou números não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPossibilita alterar o nome de um grupo criado anteriormente.
\nO número conectado na instância deve ser administrador do grupo para a ação.
\nA ação de alterar o nome do grupo será enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_UPDATE_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de alterar nome do grupo ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na ação de alterar o nome enviada anteriormente está vinculada ao \"action_id\" retornado na ação de criar ou no \"whats_id\" retornado na criação do grupo, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_GROUP_NAME\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\",\n \"whats_id\": \"id criado no aplicativo Whatsapp\",\n \"status\": \"SUCCESS\",\n \"result\": {}\n}\n\nA ação da mensagem não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de alterar o nome do grupo não foi enviada pois o nome ou whats_id não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPossibilita alterar a descrição de um grupo criado anteriormente.
\nO número conectado na instância deve ser administrador do grupo para a ação.
\nA ação de alterar a descrição do grupo será enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_UPDATE_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de alterar descrição do grupo ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na ação de alterar a descrição enviada anteriormente está vinculada ao \"action_id\" retornado na ação de criar ou no \"whats_id\" retornado na criação do grupo, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_GROUP_DESCRIPTION\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\",\n \"whats_id\": \"id criado no aplicativo Whatsapp\",\n \"status\": \"SUCCESS\",\n \"result\": {}\n}\n\nA ação não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de alterar a descrição do grupo não foi enviada pois a descrição ou whats_id não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nEnvio de ação de solicitação de alteração de imagem de capa do grupo, a imagem, envie utilizando BASE64 ENCODE para envio do arquivo de imagem de forma codificada.
\nNão se esqueça! As politícas de tamanho e formatos aquivos do proprio Whatsaspp, geralmente o mais comum é enviar JPG (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são enviados com o processamento da ação.
\nObservação: Esse webhook é disparado quando é confirmado o processamento da ação, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na ação de alterar a imagem enviada anteriormente está vinculada ao \"action_id\" retornado na ação de criar ou no \"whats_id\" retornado na criação do grupo, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_GROUP_IMAGE_UPDATE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\",\n \"whats_id\": \"id criado no aplicativo Whatsapp\",\n \"status\": \"SUCCESS\",\n \"result\": {}\n}\n\nEnvio de ação de solicitação de alteração de imagem de capa do grupo, a imagem, envie utilizando um URL PÚBLICO que deve estar acessível por nossa API que vai realizar o anexo automático dessa imegem.
\nNão se esqueça! As politícas de tamanho e formatos aquivos do proprio Whatsaspp, geralmente o mais comum é enviar JPG (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são enviados com o processamento da ação.
\nObservação: Esse webhook é disparado quando é confirmado o processamento da ação, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na ação de alterar a imagem enviada anteriormente está vinculada ao \"action_id\" retornado na ação de criar ou no \"whats_id\" retornado na criação do grupo, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_GROUP_IMAGE_UPDATE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\",\n \"whats_id\": \"id criado no aplicativo Whatsapp\",\n \"status\": \"SUCCESS\",\n \"result\": {}\n}\n\nPossibilita buscar informações de um grupo criado anteriormente.
\nO número conectado na instância deve ser administrador do grupo para a ação.
\nA ação de buscar informações do grupo será enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de solicitar informações do grupo ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na ação de alterar a descrição enviada anteriormente está vinculada ao \"action_id\" retornado na ação de criar ou no \"whats_id\" retornado na criação do grupo, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{\n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_GROUP_METADATA\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\", \n \"whats_id\": \"id criado no aplicativo Whatsapp na criação do grupo\",\n \"result\": {\n \"description\": \"Grupo HALLOAPI\",\n \"owner\": \"5511999999999\",\n \"subject\": \"Meu grupo no HALLOAPI\",\n \"creation\": \"1588721491000\",\n \"invitationLink\": \"https://chat.whatsapp.com/50Aasd6af5\",\n \"subjectTime\": \"1617805323000\",\n \"subjectOwner\": \"554497050785\",\n \"participants\": {\n {\n \"phone\": \"5511888888888\",\n \"isAdmin\": \"true\",\n \"isSuperAdmin\": \"false\",\n \"short\": \"HALLOAPIs\",\n \"name\": \"HALLOAPIs Boys\"\n },\n {\n \"phone\": \"5511888888888\",\n \"isAdmin\": \"false\",\n \"isSuperAdmin\": \"false\",\n \"short\": \"Carlos\",\n \"name\": \"Carlos Andrade\"\n },\n {\n \"phone\": \"5511888888888\",\n \"isAdmin\": \"false\",\n \"isSuperAdmin\": \"false\",\n \"short\": \"Joao\",\n \"name\": \"Joao Pedro\"\n }\n }\n }\n}\n\nA ação não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de solicitar informações do grupo não foi enviada pois o whats_id não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPossibilita gerar o código de convite para um determinado grupo.
\nO número conectado na instância deve ser administrador do grupo para a ação.
\nA ação de buscar código de convite do grupo será enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de solicitar código do convite do grupo ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na ação de alterar a descrição enviada anteriormente está vinculada ao \"action_id\" retornado na ação de criar ou no \"whats_id\" retornado na criação do grupo, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{\n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_GROUP_INVITECODE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\", \n \"whats_id\": \"id criado no aplicativo Whatsapp na criação do grupo\",\n \"invitationCode\": \"50Aasd6af5\",\n \"status\": \"SUCCESS\"\n \"result\": {}\n}\n\nA ação não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de solicitar o código do convite do grupo não foi enviada pois a o whats_id não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPossibilita buscar informações de um grupo com código de convite.
\nA ação de buscar informações do grupo será enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de solicitar informações do grupo ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na ação de alterar a descrição enviada anteriormente está vinculada ao \"action_id\" retornado na ação de criar ou no \"whats_id\" retornado na criação do grupo, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{\n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_GROUP_INVITEINFO\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\", \n \"whats_id\": \"id criado no aplicativo Whatsapp na criação do grupo\",\n \"result\": {\n \"description\": \"Grupo HALLOAPI\",\n \"owner\": \"5511999999999\",\n \"subject\": \"Meu grupo no HALLOAPI\",\n \"creation\": \"1588721491000\",\n \"invitationLink\": \"https://chat.whatsapp.com/50Aasd6af5\",\n \"subjectTime\": \"1617805323000\",\n \"subjectOwner\": \"554497050785\",\n \"participants\": {\n {\n \"phone\": \"5511888888888\",\n \"isAdmin\": \"true\",\n \"isSuperAdmin\": \"false\",\n \"short\": \"HALLOAPIs\",\n \"name\": \"HALLOAPIs Boys\"\n },\n {\n \"phone\": \"5511888888888\",\n \"isAdmin\": \"false\",\n \"isSuperAdmin\": \"false\",\n \"short\": \"Carlos\",\n \"name\": \"Carlos Andrade\"\n },\n {\n \"phone\": \"5511888888888\",\n \"isAdmin\": \"false\",\n \"isSuperAdmin\": \"false\",\n \"short\": \"Joao\",\n \"name\": \"Joao Pedro\"\n }\n }\n }\n}\n\nA ação não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de solicitar informações do grupo não foi enviada pois o whats_id não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPossibilita ingressar em um grupo com código de convite para um determinado grupo.
\nA ação de buscar código de convite do grupo será enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de solicitar entrada em grupo com código do convite do grupo ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na ação de ingresso no grupo com código enviada anteriormente está vinculada ao \"action_id\" retornado na ação de criar ou no \"whats_id\" retornado na criação do grupo, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{\n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_GROUP_INVITECODE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\", \n \"whats_id\": \"id criado no aplicativo Whatsapp na criação do grupo\",\n \"invite\": \"50Aasd6af5\",\n \"status\": \"SUCCESS\",\n \"result\": {}\n}\n\nA ação não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de aceitar convite com do grupo não foi enviada pois o whats_id não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPermite adicionar, remover, promover um usuário à administrador e retirar o título de adminstrador de um determinado grupo.
\nParâmetro apply pode contêr as opções:
\nadd: adicionar participantes.
\npromote: promover à administrador.
\ndemote: remover privilégio de administrador.
\nremove: remover participantes do grupo.
\nA ação de alterar participantes de grupo será enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de solicitar entrada em grupo com alteração do grupo ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na ação de alteração de participante no grupo com código enviada anteriormente está vinculada ao \"action_id\" retornado na ação de criar ou no \"whats_id\" retornado na criação do grupo, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{\n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_GROUP_PARTICIPANT\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\", \n \"whats_id\": \"id criado no aplicativo Whatsapp na criação do grupo\",\n \"apply\": \"retorna o parametro enviado: add, remove, etc\",\n \"status\": \"SUCCESS\",\n \"result\": {}\n}\n\nA ação não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de adicionar ou remover participantes do grupo não foi enviada pois a ação ou whats_id não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPermite alterar configurações de um grupo.
\nParâmetro apply pode contêr as opções:
\nannouncement: definir que apenas administradores mandem mensagem.
\nnot_announcement: permitir que todos os participantes enviem mensagem.
\nunlocked: permitir que todos participantes possam editar dados do grupo.
\nlocked: apenas administradores podem editar dados do grupo.
\nA ação de alterar participantes de grupo será enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de configuração do grupo com alteração no grupo ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na ação de configuração do grupo com código enviada anteriormente está vinculada ao \"action_id\" retornado na ação de criar ou no \"whats_id\" retornado na criação do grupo, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{\n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_GROUP_SETTING\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\", \n \"whats_id\": \"id criado no aplicativo Whatsapp na criação do grupo\",\n \"apply\": \"retorna o parametro enviado: locked, unlocked, etc\",\n \"status\": \"SUCCESS\",\n \"result\": {}\n}\n\nA ação não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de configuração do grupo não foi enviada pois a ação ou whats_id não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPermite sair de um grupo.
\nA ação de alterar participantes de grupo será enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de sair do grupo com alteração no grupo ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação de sair do grupo com código enviada anteriormente está vinculada ao \"action_id\" retornado na ação de criar ou no \"whats_id\" retornado na criação do grupo, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{\n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_GROUP_EXIT\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\", \n \"whats_id\": \"id criado no aplicativo Whatsapp na criação do grupo\",\n \"status\": \"SUCCESS\",\n \"result\": {}\n}\n\nA ação não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de sair do grupo não foi enviada pois o whats_id não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPermite remover um grupo.
\nImportante que você deve ser administrador do grupo.
\nA ação de remover grupo será enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de remover o grupo com ação no grupo ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na saida do grupo com código enviada anteriormente está vinculada ao \"action_id\" retornado na ação de criar ou no \"whats_id\" retornado na criação do grupo, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{\n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_GROUP_DELETE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\", \n \"whats_id\": \"id criado no aplicativo Whatsapp na criação do grupo\", \n \"status\": \"SUCCESS\",\n \"result\": {}\n}\n\nA ação não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de remover o grupo não foi enviada pois o whats_id não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPermite enviar uma mensagem de texto.
\nA mensagem será enviada para a fila de envio, garantimos o envio da mensagem.
\n{\n \"result\": {\n \"message_id\": \"id da fila de envio\"\n },\n \"message\": \"MESSAGE_SCHEDULED\",\n \"isValid\": true,\n \"instance_id\": \"5\",\n \"buffer_count\": 959,//Mostra a quantidade de mensagens que estão em fila aguardando envio\n}\n\nApós a mensagem ser enviada, é retornado um id de registro da fila de envio, no qual será confirmado postariormente será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da mensagem enviada anteriormente está vinculada ao \"message_id\" retornado no envio da mensagem, utilize este identificador para aplicar ações em seu webhook de retorno.
\nLEGENDA STATUS A RETORNAR DAS MENSAGENS:
NUMBER_NOT_WHATSAPP - Retornar status para número de envio não está no Whatsapp.
SENT - Confirma mensagem foi enviada (V).
CONFIRMED_DEVICE - Confirma mensagem chegou no app de destino (VV).
CONFIRMED_READING - Confirma se mensagem teve a leitura confirmada pelo dispositivo de destino (Importante que nem todos permite deixar essa opção ativa)
\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_MESSAGE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (message_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (message_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"message_id\": \"id da fila de envio\",\n \"whats_id\": \"id criado no aplicativo Whatsapp após o envio\",\n \"status\": \"status da mensagem\",\n \"result\": { }\n}\n\nA mensagem não foi enviada pois a instância está com uma sobrecarga de fila.
\n{\n \"result\": {},\n \"message\": \"BUFFER_EXCEEDED\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"buffer_count\": 959//Mostra a quantidade de mensagens que estão em fila aguardando envio\n}\n\nA mensagem não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false,\n \"instance_id\": \"5\"\n}\n\nA mensagem não foi enviada pois o destinatário ou mensagem não estão válidos ou vazios.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPermite enviar uma mensagem com link personalizado de compartilhamento, com ícone e informções.
\nA mensagem será enviada para a fila de envio, garantimos o envio da mensagem.
\n{\n \"result\": {\n \"message_id\": \"id da fila de envio\"\n },\n \"message\": \"MESSAGE_SCHEDULED\",\n \"isValid\": true,\n \"instance_id\": \"5\"\n}\n\nApós a mensagem ser enviada, é retornado um id de registro da fila de envio, no qual será confirmado postariormente será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da mensagem enviada anteriormente está vinculada ao \"message_id\" retornado no envio da mensagem, utilize este identificador para aplicar ações em seu webhook de retorno.
\nLEGENDA STATUS A RETORNAR DAS MENSAGENS:
NUMBER_NOT_WHATSAPP - Retornar status para número de envio não está no Whatsapp.
SENT - Confirma mensagem foi enviada (V).
\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_MESSAGE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (message_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (message_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"message_id\": \"id da fila de envio\",\n \"whats_id\": \"id criado no aplicativo Whatsapp após o envio\",\n \"status\": \"status da mensagem\",\n \"result\": {}\n}\n\nA mensagem não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nStartFragment
\nA mensagem não foi enviada pois o destinatário ou mensagem não estão válido ou vazios. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPermite enviar uma mensagem com localização.
\nA mensagem será enviada para a fila de envio, garantimos o envio da mensagem.
\n{\n \"result\": {\n \"message_id\": \"id da fila de envio\"\n },\n \"message\": \"MESSAGE_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a mensagem ser enviada, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado ou recebido uma nova mensagem, preste atenção na propriedade \"key\", ele é o identificador principal da mensagem.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_MESSAGE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (message_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (message_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"message_id\": \"id da fila de envio\",\n \"whats_id\": \"id criado no aplicativo Whatsapp após o envio\",\n \"status\": \"status da mensagem\",\n \"result\": {}\n}\n\nA mensagem não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA mensagem não foi enviada pois o destinatário ou mensagem não estão válido ou vazios. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPermite enviar uma ação de deletar mensagem enviada anteriormente.
\nA ação de deletar mensagem será enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de envio\"\n },\n \"message\": \"MESSAGE_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de deletar a mensagem ser enviada, é retornado um id de registro da ação e o whats_id criado no envio da mensagem, no qual será confirmado postariormente será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou recebido uma nova mensagem, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na mensagem enviada anteriormente está vinculada ao \"action_id\" ou \"whats_id\" retornado no envio da mensagem, utilize este identificador para aplicar ações em seu webhook de retorno.
\nLEGENDA STATUS A RETORNAR DAS AÇÕES DE DELETAR MENSAGENS:
MESSAGE_NOT_LOCALIZED - Retornar status para mensagem não localizada para ser removida.
JUST_JUST_ME - Só foi possível apagar para mim mesmo.
DELETED_ALL - Confirma mensagem deletada para todos.
\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_MESSAGE_DELETE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\",\n \"whats_id\": \"id criado no aplicativo Whatsapp após o envio\",\n \"status\": \"status da mensagem\",\n \"result\": {}\n}\n\nA ação da mensagem não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação da mensagem não foi enviada pois o destinatário ou whats_id não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nEnvio de mensagem com imagem, utilizando BASE64 ENCODE para envio dos arquivos de imagem de forma codificada.
\nNão se esqueça! As politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","group"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"a56c01fb-58e2-4457-9d15-478df65e6ad4","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"IMAGE","type":"text"},{"key":"destination","value":"{{groupIDwhats}}","type":"text"},{"key":"text","value":"\"Uma mensagem com imagem direto da HalloAPI :)\"","type":"text"},{"key":"image_name","value":"opcional (image name.png)","type":"text"},{"key":"image_base64","value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAARQAAAEUCAYAAADqcMl5AAAAAklEQVR4AewaftIAABH6SURBVO3BQY4YybLgQDJR978yR0tfBZDIqJbeHzezP1hrrQse1lrrkoe11rrkYa21LnlYa61LHtZa65KHtda65GGttS55WGutSx7WWuuSh7XWuuRhrbUueVhrrUse1lrrkoe11rrkYa21LvnhI5X/UsUbKjdVTConFV+oTBVvqJxUTCr/pYpJ5aTiROWkYlJ5o2JSOamYVE4qJpX/UsUXD2utdcnDWmtd8rDWWpf8cFnFTSpfVLyhcqIyVZyonFScVEwqv6liUpkqTlSmiptUTipOVE4qJpVJ5aTiN1XcpHLTw1prXfKw1lqXPKy11iU//DKVNypuUpkqJpWpYlKZKk5UvlCZKk4q3lD5QmWq+ELljYpJ5YuKSWWqmFSmihOV36TyRsVvelhrrUse1lrrkoe11rrkh//PqJyovKEyVZyonFRMKlPFTSpTxVQxqbyhMlVMFZPKGxWTyknFGypTxRcVk8r/JQ9rrXXJw1prXfKw1lqX/PB/jMpUMalMFScqk8obKlPFpPKGylQxqXyh8obKFypTxU0VJypvqEwVk8qJylTxf8nDWmtd8rDWWpc8rLXWJT/8sorfpPJGxaQyVZxU3FTxhspvqnhD5aTiDZWTikllqjhRmSomlanijYpJZaq4qeJf8rDWWpc8rLXWJQ9rrXXJD5ep/E0Vk8pUcZPKVPGGylQxqUwVk8pUMalMFZPKicpUcVIxqUwVJxWTyhcqU8WkMlVMKlPFpDJVvKEyVZyo/Mse1lrrkoe11rrkYa21Lvnho4q/qeKk4g2VE5Wp4g2Vmyp+U8UXFb+pYlKZKt5QOVGZKk4qJpWp4qTif8nDWmtd8rDWWpc8rLXWJfYHH6hMFScqU8WkclIxqUwVk8pU8YXKScUbKlPFGyonFZPKv6ziDZWTikllqvhCZar4QmWqmFSmin/Jw1prXfKw1lqXPKy11iU//GUqU8UXKlPFpHJSMalMFScqv0llqphUJpWTijdU3qiYVKaKmyr+l1W8ofJFxU0Pa611ycNaa13ysNZal/zwUcWJylRxovJGxX9J5aTi/7KKSWWqmFTeUDmpmCpuUvlCZao4UTmp+KJiUplUpoovHtZa65KHtda65GGttS754TKVqWJSmSpOKr5Q+aLiRGVSOamYVKaKk4pJ5aTiDZWp4g2VqeJEZaqYVG6q+KJiUpkqJpWbKk5UTiomlZse1lrrkoe11rrkYa21LrE/+EBlqphU3qiYVE4qvlA5qXhDZap4Q+WLikllqjhROamYVP4lFScqb1RMKjdVfKFyUvFfelhrrUse1lrrkoe11rrE/uAvUjmpmFROKt5QOamYVE4qJpWpYlL5omJSeaNiUpkqJpWTiknlpGJSmSr+JpWp4kRlqjhROan4QmWqmFSmii8e1lrrkoe11rrkYa21LvnhI5Wp4kRlqjhROak4UZkqpopJ5Y2KmypOVCaVNyomlanipOJE5YuKSeWkYlKZKk5Ubqo4UTmp+F/2sNZalzystdYlD2utdYn9wS9SmSpOVKaKm1SmiknljYovVKaKSeWmiptU3qj4TSpTxRsqU8WkMlVMKlPFFypvVJyoTBU3Pay11iUPa611ycNaa11if/AfUvmiYlKZKiaVk4oTlaniROWk4kTlpOINlaniX6JyUvGFyhcVJyonFZPKVPGFyk0VXzystdYlD2utdcnDWmtd8sNHKicVU8UXKm9UvKEyVUwqU8UXKicVb6hMFV+onFS8oTJVnKhMFScqU8WJylRxojJVnKhMFScqU8UXFZPKb3pYa61LHtZa65KHtda65IePKr5QuUllqphUpoqp4qaKNyomlanipGJSmSreqJhUJpWTiqliUvlC5URlqjhRmSreUJkqTlSmiknljYqTiknlpoe11rrkYa21LnlYa61L7A8+UJkqTlTeqJhUporfpHJScaIyVZyovFExqUwVJypTxYnKScWkclIxqUwVk8pUMalMFScqU8WkclJxojJVTCpvVLyhMlX8poe11rrkYa21LnlYa61LfvjLKiaVSeVEZao4UZkqJpWp4g2VqWJSOak4UTmpOFGZKiaVqWKqOFGZKk5Upoo3VL6oeKNiUnlDZao4UZlUpoo3VKaKmx7WWuuSh7XWuuRhrbUu+eGjit9UcaIyqUwVb1RMKlPFf0nlRGWqOKmYVKaKSWWqmFSmit9UcaJyU8VJxU0qU8WkMqlMFVPFf+lhrbUueVhrrUse1lrrEvuDi1SmihOVNyomlaliUpkqJpWTiknli4pJZap4Q+WLijdU3qg4UTmpOFE5qfhC5W+qOFE5qZhUTiq+eFhrrUse1lrrkoe11rrkh49Upoo3Kt5QOVGZKt6o+KJiUrlJ5aRiUnlD5aTiROVEZaqYVCaVNypOVN6omFROKiaVqeJE5Y2KLypuelhrrUse1lrrkoe11rrE/uADlZOKE5WpYlI5qXhDZap4Q2WqmFSmiknlX1YxqUwVJyq/qWJS+ZdUnKicVEwqb1ScqEwVNz2stdYlD2utdcnDWmtd8sNlFZPKScVJxaQyqbxRMam8UTGpTBWTyknFicpJxaTyhcrfVHFTxaQyVUwqb1RMKlPFVDGpnFScqLxR8Zse1lrrkoe11rrkYa21LvnhP1YxqUwVk8pU8YXKFypTxUnFicobFZPKFxWTylQxqdxUMalMFZPKVHGiMlX8SyomlaniN6lMFV88rLXWJQ9rrXXJw1prXfLDL6uYVKaKk4oTlanipOINlTdUpoqTijdUpopJZar4l6lMFScVk8pJxaQyVZxUnKicqJxUnKi8oTJVTCpTxU0Pa611ycNaa13ysNZal9gf/CKVqWJS+V9WMalMFV+onFScqPxLKiaVk4pJZaqYVE4qJpWp4g2VqeINlf9SxaQyVXzxsNZalzystdYlD2utdckPl6lMFZPKScUbKlPFicpJxU0qU8VvUjmpmFSmijdUTiomlaliUplUTlROKiaVqWJSmSomlaliUjmpOKl4Q+Wk4qTipoe11rrkYa21LnlYa61LfvhIZaqYVKaKSeVEZao4UZkqTipOVE4qpoo3VE4qJpVJ5Q2VN1Smit9U8YbKVPGbKt6omFTeUJkqvlA5qfjiYa21LnlYa61LHtZa65IfflnFFxVvVEwqJypTxVQxqUwqJxWTylTxRsWkMlVMKlPFpHJS8UbFpPKGylQxqZyoTBUnKlPFpPI3VbxRMalMFb/pYa21LnlYa61LHtZa65IfLlM5qThR+U0Vk8oXFZPKpDJVTCpTxaQyVUwVJxVvqPymiknlROWNipOKE5Wp4kTlJpXfpDJV3PSw1lqXPKy11iUPa611if3BBypTxaRyUvGFyhsVJypTxYnKVDGpvFFxk8pUMalMFZPKVDGpnFTcpDJVTCpTxU0qU8UXKlPFFyonFb/pYa21LnlYa61LHtZa65If/jEqX1RMKl+oTBVTxaQyVUwqJyonFX+TyhsqU8UbKlPFpPKGyhsVX6hMFVPFpHJScVJxonJS8cXDWmtd8rDWWpc8rLXWJT98VHFTxYnKGxWTyknFpPJGxU0Vk8obFW+oTBUnKlPFb1KZKv4mlZOKSeULlZOKNypuelhrrUse1lrrkoe11rrkh19WMamcqJxUvKEyVUwqk8qJyhsVJxWTyk0qU8VJxaQyVUwVJyonFTepTBUnFZPKpDJVTCpTxaQyVbyhclLxL3lYa61LHtZa65KHtda6xP7gA5XfVDGpTBWTylRxojJVvKEyVUwqb1T8JpWp4kTlpGJS+aLiRGWq+EJlqphUpopJ5aTiRGWqmFSmihOVk4rf9LDWWpc8rLXWJQ9rrXXJD5dV3KTyL6t4o2JSmVSmihOVNyq+qJhUTiq+UHlD5TepfKHyhcpUMVVMKv+lh7XWuuRhrbUueVhrrUvsDz5QOak4UTmpOFH5l1VMKlPFpPJfqjhROam4SeWkYlKZKt5QOamYVE4qJpU3Kr5QmSomlanipoe11rrkYa21LnlYa61LfvioYlKZVKaKqeJEZaq4qeINlaniRGWqmFSmikllqphUpooTld+kMlVMKm9UTCpTxaQyVUwqf1PFpHKiMlVMKicqU8WkMlV88bDWWpc8rLXWJQ9rrXWJ/cEHKicVJypTxRsqb1RMKlPFpPJGxRcqv6niROWkYlKZKm5S+aJiUjmp+ELljYpJ5aRiUpkq/qaHtda65GGttS55WGutS374qGJSmVROKk5U3qiYVN5QOak4UTmpmFROKt5Q+U0qU8WkMlVMKr+p4m+qeENlqphUJpUTlaliUjmp+OJhrbUueVhrrUse1lrrkh9+WcWJyknFicqkMlVMKlPFicqkclIxqUwqU8UXKlPFpHJTxUnFScWk8kbFGyo3qZxUnKhMFW9UTCpTxaQyVUwqNz2stdYlD2utdcnDWmtd8sNHKlPFpHJSMalMKv+SijcqblKZKiaVqWJSOamYVCaVqeKmiknlROWk4qaKSWVSOamYVKaKE5V/2cNaa13ysNZalzystdYlP3xUcVIxqUwqU8WJym9SOVF5o+ILlanipOKmiknlDZWTipsqJpU3KiaVLyp+U8Wk8jc9rLXWJQ9rrXXJw1prXfLDP07ljYq/qeJE5aTiC5Wp4qTiROVEZaqYKiaVE5U3Kr6oOKmYVKaKN1SmiknlDZWp4m96WGutSx7WWuuSh7XWusT+4CKVqWJSmSq+UJkq3lCZKiaV/yUVb6icVJyonFRMKm9UnKicVEwqJxVvqEwVk8pUMalMFW+oTBV/08Naa13ysNZalzystdYlP3ykMlWcVJyonFT8lypOVKaKE5U3Kt5Q+aJiUpkqTipOKiaVf4nKVDGpnKhMFf8/eVhrrUse1lrrkoe11rrkh48qTlSmiknlpGJS+U0qX6h8UXFTxYnKScUXKlPFVDGpnKicVJxUTCpTxaRyk8pUMam8UTGpTBX/pYe11rrkYa21LnlYa61L7A9+kcpNFZPKScVvUpkqvlA5qZhUpopJZao4UZkqJpWpYlI5qfhCZaqYVH5TxRcqJxWTylRxonJSMalMFV88rLXWJQ9rrXXJw1prXfLDRypvVEwqU8WJyv8ylTcqJpUTlaliUvmXqUwVU8VJxRsqJxWTylTxRsWkMqlMFZPKScWJym96WGutSx7WWuuSh7XWuuSH/5jKVHGi8kbFpDJVnKhMFScVk8obFScqJxUnKlPFpHKicqJyUjGpnFRMKicVJypTxUnFpHKiMlXcpPK/5GGttS55WGutSx7WWusS+4P/YSpTxRsqU8WkclLxhspU8YbKVPGGyknFGypTxRsqv6liUpkq3lA5qZhUpopJZap4Q2WqmFSmit/0sNZalzystdYlD2utdckPH6n8lyqmikllqvhNKlPFpHKiclJxonJS8YXKVHGiMlV8UTGpnFRMKlPFGypfVHyhMlWcqEwVk8pJxRcPa611ycNaa13ysNZal/xwWcVNKicqU8WkMlW8UXGiclIxqUwVk8obFZPKpDJVTConFV+oTBVTxaQyqUwVk8pJxaQyVfzLKt6omFSmit/0sNZalzystdYlD2utdckPv0zljYo3KiaVqWJSmSomlaliUpkqJpUvKk4qJpWTijdUbqqYVH6TylQxVXxRMancpPKFyonKVHHTw1prXfKw1lqXPKy11iU//I9TmSq+qDipeKNiUplUpopJZaqYKiaVSWWqmComlaniDZWTipsqflPFScUbKlPFpHJS8YXKb3pYa61LHtZa65KHtda65If/cRWTyknFGypTxaTyRsUbFScqX6hMFScqb6hMFZPKScUbKlPFpHJSMalMFZPKTRWTyonKVDGpTBWTylTxxcNaa13ysNZalzystdYlP/yyin+ZylQxVZxU3KRyUjFVnKi8oTJVTBUnKlPFpHKTylRxUvFGxUnFGyqTyknFFxUnFTc9rLXWJQ9rrXXJw1prXfLDZSr/JZWTin+JylRxUjGpnFScqJxUvKEyVdyk8obKScWkclIxqbxRMVVMKl9UvKFyUvHFw1prXfKw1lqXPKy11iX2B2utdcHDWmtd8rDWWpc8rLXWJQ9rrXXJw1prXfKw1lqXPKy11iUPa611ycNaa13ysNZalzystdYlD2utdcnDWmtd8rDWWpc8rLXWJf8PebNhbhnTaLsAAAAASUVORK5CYII=","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/group"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"5b21bcbd-65ad-4a95-b91f-386e5e37d917"},{"name":"Enviar uma mensagem com imagem URL PÚBLICA","id":"0906d2dd-ccac-4724-9aa3-8400baf2f2a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"IMAGE","type":"text"},{"key":"destination","value":"{{groupIDwhats}}","type":"text"},{"key":"text","value":"\"Uma mensagem com imagem direto da HalloAPI :)\"","type":"text"},{"key":"image_name","value":"opcional (image name.png)","type":"text"},{"key":"image_url","value":"https://images.all-free-download.com/images/graphiclarge/iphone_6_sample_photo_566464.jpg","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/group","description":"Envio de mensagem com imagem, utilizando URL PÚBLICA para envio dos arquivos de imagem recuperada pelo sistema HalloAPI utilizando a URL informada para fazer o downaload do arquivo.
\nNão se esqueça! As politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","group"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"62a52979-aed7-495c-bd10-652a228eac1b","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"IMAGE","type":"text"},{"key":"destination","value":"{{groupIDwhats}}","type":"text"},{"key":"text","value":"\"Uma mensagem com imagem direto da HalloAPI :)\"","type":"text"},{"key":"image_name","value":"opcional (image name.png)","type":"text"},{"key":"image_url","value":"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b3/Wikipedia-logo-v2-en.svg/1200px-Wikipedia-logo-v2-en.svg.png","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/group"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"0906d2dd-ccac-4724-9aa3-8400baf2f2a9"},{"name":"Enviar uma mensagem com video BASE64","id":"e4a7ab5d-0540-4abf-aa89-b85935701299","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"VIDEO","type":"text"},{"key":"destination","value":"{{groupIDwhats}}","type":"text"},{"key":"text","value":"\"Uma mensagem com video direto da HalloAPI :)\"","type":"text"},{"key":"video_name","value":"opcional (video name.mp4)","type":"text"},{"key":"video_base64","value":"data:video/mp4;base64,DAAYXJ0eHJlZgIGZ0eHDQyAAg3NDINCiUlRUAAAG1wNDJtcD.......","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/group","description":"Envio de mensagem com vídeo, utilizando BASE64 ENCODE para envio dos arquivos de vídeo de forma codificada.
\nNão se esqueça! As politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","group"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"68a4a701-f22d-43d8-a47e-d4283752035b","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"VIDEO","type":"text"},{"key":"destination","value":"{{groupIDwhats}}","type":"text"},{"key":"text","value":"\"Uma mensagem com video direto da HalloAPI :)\"","type":"text"},{"key":"video_name","value":"opcional (image name.png)","type":"text"},{"key":"video_base64","value":"data:video/mp4;base64,DAAYXJ0eHJlZgIGZ0eHDQyAAg3NDINCiUlRUAAAG1wNDJtcD.......","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/group"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"e4a7ab5d-0540-4abf-aa89-b85935701299"},{"name":"Enviar uma mensagem com video URL PÚBLICA","id":"e334e8be-69b7-4ac1-8e0c-f207532bc4f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"VIDEO","type":"text"},{"key":"destination","value":"{{groupIDwhats}}","type":"text"},{"key":"text","value":"\"Uma mensagem com video direto da HalloAPI :)\"","type":"text"},{"key":"video_name","value":"opcional (image name.png)","type":"text"},{"key":"video_url","value":"https://github.com/intel-iot-devkit/sample-videos/raw/master/people-detection.mp4","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/group","description":"Envio de mensagem com vídeo, utilizando URL PÚBLICA para envio dos arquivos de vídeo recuperada pelo sistema HalloAPI utilizando a URL informada para fazer o downaload do arquivo.
\nNão se esqueça! As politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","group"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"9ebfc521-b99a-4e16-9391-b899fff6f84f","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"VIDEO","type":"text"},{"key":"destination","value":"{{groupIDwhats}}","type":"text"},{"key":"text","value":"\"Uma mensagem com video direto da HalloAPI :)\"","type":"text"},{"key":"video_name","value":"opcional (image name.png)","type":"text"},{"key":"video_url","value":"https://github.com/intel-iot-devkit/sample-videos/raw/master/people-detection.mp4","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/group"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"e334e8be-69b7-4ac1-8e0c-f207532bc4f6"},{"name":"Enviar uma mensagem com áudio BASE64","id":"ba7b0b42-75f0-4691-9dcf-38bfa8fa5401","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"AUDIO","type":"text"},{"key":"destination","value":"{{groupIDwhats}}","type":"text"},{"key":"audio_name","value":"opcional (audio name.mp3)","type":"text"},{"key":"audio_base64","value":"data:audio/mp3;base64,DAAYXJ0eHJlZgIGZ0eHDQyAAg3NDINCiUlRUAAAG1wNDJtcD.......","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/group","description":"Envio de mensagem com áudio, utilizando BASE64 ENCODE para envio dos arquivos de áudio de forma codificada.
\nNão se esqueça! As politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","group"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"6ca755b3-3005-4243-b77e-d1ce2a346d4b","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"AUDIO","type":"text"},{"key":"destination","value":"{{groupIDwhats}}","type":"text"},{"key":"audio_name","value":"opcional (audio name.mp3)","type":"text"},{"key":"audio_base64","value":"data:audio/mp3;base64,DAAYXJ0eHJlZgIGZ0eHDQyAAg3NDINCiUlRUAAAG1wNDJtcD.......","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/group"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"ba7b0b42-75f0-4691-9dcf-38bfa8fa5401"},{"name":"Enviar uma mensagem com áudio URL PÚBLICA","id":"77047cfb-8788-4cd9-a317-7936c11a36d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"AUDIO","type":"text"},{"key":"destination","value":"{{groupIDwhats}}","type":"text"},{"key":"audio_name","value":"opcional (audio name.ogg)","type":"text"},{"key":"audio_url","value":"https://upload.wikimedia.org/wikipedia/en/a/ab/03_Maroon_5_Daylight.ogg","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/group","description":"Envio de mensagem com áudio, utilizando URL PÚBLICA para envio dos arquivos de áudio recuperada pelo sistema HalloAPI utilizando a URL informada para fazer o downaload do arquivo.
\nNão se esqueça! As politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","group"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"48146955-77bd-46a2-afcd-c71358cb3f4d","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"AUDIO","type":"text"},{"key":"destination","value":"{{groupIDwhats}}","type":"text"},{"key":"audio_name","value":"opcional (audio name.ogg)","type":"text"},{"key":"audio_url","value":"https://upload.wikimedia.org/wikipedia/en/a/ab/03_Maroon_5_Daylight.ogg","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/group"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"77047cfb-8788-4cd9-a317-7936c11a36d6"},{"name":"Enviar uma mensagem com documento BASE64","id":"70b6b84e-c5e1-4fce-9933-ee29eea834ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"DOCUMENT","type":"text"},{"key":"destination","value":"{{groupIDwhats}}","type":"text"},{"key":"text","value":"\"Uma mensagem com documento direto da HalloAPI :)\"","type":"text"},{"key":"document_name","value":"opcional (document name.pdf)","type":"text"},{"key":"document_base64","value":"data:application/pdf;base64,DAAYXJ0eHJlZgIGZ0eHDQyAAg3NDINCiUlRUAAAG1wNDJtcD.......","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/group","description":"Envio de mensagem com documento, utilizando BASE64 ENCODE para envio dos arquivos de documentos de forma codificada.
\nNão se esqueça! A extensão/tipo do aquivo que deseja enviar ! Teóricamente este método deve suportar todos tipos de documentos, desde que eles estejam dentro das politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui).
\nO Whatsapp limita o tamanho de arquivos e sua politica muda constantemente, por isso sempre recomendamos a verificação direto no site do próprio Whatsapp.
\nNeste link você encontra tudo que precisa saber sobre formatos e tamanhos de arquivos.
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","group"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"d4fdcc5c-c5c4-424e-9d11-79ed4df4eb55","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"DOCUMENT","type":"text"},{"key":"destination","value":"{{groupIDwhats}}","type":"text"},{"key":"text","value":"\"Uma mensagem com documento direto da HalloAPI :)\"","type":"text"},{"key":"document_name","value":"opcional (document name.pdf)","type":"text"},{"key":"document_base64","value":"data:application/pdf;base64,DAAYXJ0eHJlZgIGZ0eHDQyAAg3NDINCiUlRUAAAG1wNDJtcD.......","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/group"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"70b6b84e-c5e1-4fce-9933-ee29eea834ae"},{"name":"Enviar uma mensagem com documento URL PÚBLICA","id":"d9998532-26c5-48d9-a1f8-68d827d80e7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"DOCUMENT","type":"text"},{"key":"destination","value":"{{groupIDwhats}}","type":"text"},{"key":"text","value":"\"Uma mensagem com documento direto da HalloAPI :)\"","type":"text"},{"key":"document_name","value":"opcional (document name.pdf)","type":"text"},{"key":"document_url","value":"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/group","description":"Envio de mensagem com documento, utilizando URL PÚBLICA para envio dos arquivos de documentos recuperado pelo sistema HalloAPI utilizando a URL informada para fazer o downaload do arquivo.
\nNão se esqueça! A extensão/tipo do aquivo que deseja enviar ! Teóricamente este método deve suportar todos tipos de documentos, desde que eles estejam dentro das politícas de tamanho de aquivos do proprio Whatsaspp (para saber mais sobre estes limites clique aqui).
\nO Whatsapp limita o tamanho de arquivos e sua politica muda constantemente, por isso sempre recomendamos a verificação direto no site do próprio Whatsapp.
\nNeste link você encontra tudo que precisa saber sobre formatos e tamanhos de arquivos.
\nIMPORTANTE: Os retornos e confirmação por webhook são os mesmos da mensagem de texto simples acima.
\n","urlObject":{"path":["v1","instance","{{instanceKey}}","token","{{instanceToken}}","group"],"host":["https://app.hallo-api.com/"],"query":[],"variable":[]}},"response":[{"id":"52c54a32-cc0c-475f-a120-97be518a0c58","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"DOCUMENT","type":"text"},{"key":"destination","value":"{{groupIDwhats}}","type":"text"},{"key":"text","value":"\"Uma mensagem com documento direto da HalloAPI :)\"","type":"text"},{"key":"document_name","value":"opcional (document name.pdf)","type":"text"},{"key":"document_url","value":"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/group"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 27 Sep 2022 01:48:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"309"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"135-B5Msgc0tlFN0ue6OKbvhCUV2ej4\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message_id\": 21\n },\n \"isValid\": \"true\",\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\",\n \"buffer_count\": 7,//informa no retorno quantas mensagens estão na fila de humanização do whatsapp\n \"message\": \"MESSAGE_SCHEDULED\"\n}"}],"_postman_id":"d9998532-26c5-48d9-a1f8-68d827d80e7b"}],"id":"02dc1c4a-20ff-411c-83e0-aceba06ffa0d","_postman_id":"02dc1c4a-20ff-411c-83e0-aceba06ffa0d","description":""},{"name":"Profile","item":[{"name":"Verificar se um número está no WhatsApp","id":"b5cd0d0e-9d96-4085-9d6a-fccbd655879d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"fLogin","value":"{{fLogin}}","type":"text"},{"key":"ACTION","value":"ONWHATSAPP","type":"text"},{"key":"number","value":"{{phoneNumber}}","type":"text"},{"key":"wait","value":"0(0 pelo webhook, 1 aguarda resposta aqui)","type":"text"}]},"url":"https://app.hallo-api.com//v1/instance/{{instanceKey}}/token/{{instanceToken}}/profile","description":"Posibilita verificar se um determinado número está no WhatsApp.
\nA ação de verificar se número informado está no Whatsapp é enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de verificar se número tem Whatsapp ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou quando a resposta for adquirida, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na saida do grupo com código enviada anteriormente está vinculada ao \"action_id\" retornado na ação de criar ou no \"whats_id\" retornado na criação do grupo, utilize este identificador para aplicar ações em seu webhook de retorno.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{\n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_ON_WHATSAPP\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\", \n \"number\": \"numero enviado para verificação\", \n \"exists\": \"true ou false\",\n \"result\": {}\n}\n\nA ação não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de verificar se determinado número está no whatsapp, o número não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPosibilita verificar a existência de fila de humanização de envio de mensagens no WhatsApp.
Com as mensagens enviadas o sistema cria uma humanização que pode gerar uma fila, humanização não gera um gargalo de envio mais conforme quantidade de envios essa fila pode ser gerada. Seria bom evitar acumular muitas mensagens ou ações nesse buffer, gerencie seus envios para menor risco de sobrecarga.
A ação de verificar se número informado está no Whatsapp é enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": { },\n \"message\": \"BUFFER_SUCCESS\",\n \"isValid\": true,\n \"action_count\": 5,//recebe a contagem de ações ligadas a instância da conexão (ações são tudo que não são mensagens)\n \"message_count\": 22//recebe a contagem de mensagens de envio acumuladas em fila de humanização\n}\n\nApós a ação de verificar a fila não existe envios ou confirmações por webhook.
Aplique boas praticas evite loops de verificação contante sem uma sistematização lógica :)
Retorna o status de um perfil no WhatsApp.
\nA ação de verificar retornar a legenda de status de número no Whatsapp é enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de verificar status Whatsapp ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou quando a resposta for adquirida, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na verificação do status enviada anteriormente está vinculada ao \"action_id\" retornado na ação de criar ou no \"number\" enviado na solicitação, utilize este identificador para aplicar ações em seu webhook de retorno.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{\n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_PROFILE_STATUS\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\", \n \"number\": \"numero enviado para verificação\", \n \"status\": \"Apenas ligações de emergência\",\n \"setAt\": \"2022-09-27T01:08:56.000Z\",\n \"result\": {}\n}\n\nA ação não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de verificar status no whatsapp, o número não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPossibilita ajustar/alterar a legenda de status de exibição no Whatsapp.
\nA ação de alterar a legenda de status no Whatsapp é enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de solicitar alteração da legenda de status no Whatsapp ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou quando a resposta for adquirida, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na alteração de legenda do status enviada anteriormente está vinculada ao \"action_id\" retornado na ação, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{\n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_PROFILE_STATUS_UPDATE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\", \n \"status\": \"SUCCESS\",\n \"result\": {}\n}\n\nA ação não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de atualizar a legebda de status no whatsapp, o número não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPossibilita ajustar/alterar o nome de exibição no Whatsapp.
\nA ação de alterar o nome no Whatsapp é enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de solicitar alteração de nome no Whatsapp ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou quando a resposta for adquirida, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação alteração do nome enviada anteriormente está vinculada ao \"action_id\" retornado na ação, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{\n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_PROFILE_STATUS_UPDATE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\", \n \"status\": \"SUCCESS\",\n \"result\": {}\n}\n\nA ação não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de atualizar o nome no whatsapp, o número não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPossibilita solicitar a imagem de perfil de exibição no Whatsapp.
\nA ação de solicitar imagem de perfil no Whatsapp é enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de solicitar imagem de perfil no Whatsapp ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou quando a resposta for adquirida, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação consultar imagem de perfil enviada anteriormente está vinculada ao \"number\" ou a \"action_id\" retornado na ação, utilize este identificador para aplicar ações em seu webhook de retorno.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{\n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_PROFILE_IMAGE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\", \n \"number\": \"numero enviado para verificação\",\n \"image_base64\": \"[BASE64 FILE]\",\n \"result\": {}\n}\n\nA ação não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de obter a imagem de perfil whatsapp, o número não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nEnvio de ação de solicitação de alteração de imagem de perfil do Whatsapp, a imagem, envie utilizando BASE64 ENCODE para envio do arquivo de imagem de forma codificada.
\nNão se esqueça! As politícas de tamanho e formatos aquivos do proprio Whatsaspp, geralmente o mais comum é enviar JPG (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são enviados com o processamento da ação.
\nObservação: Esse webhook é disparado quando é confirmado o processamento da ação, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na ação de alterar a imagem enviada anteriormente está vinculada ao \"action_id\" retornado na ação de criar, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_GROUP_IMAGE_UPDATE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\",\n \"status\": \"SUCCESS\",\n \"result\": {}\n}\n\nEnvio de ação de solicitação de alteração de imagem de perfil do Whatsapp, envie utilizando um URL PÚBLICO que deve estar acessível por nossa API que vai realizar o anexo automático dessa imegem.
\nNão se esqueça! As politícas de tamanho e formatos aquivos do proprio Whatsaspp, geralmente o mais comum é enviar JPG (para saber mais sobre estes limites clique aqui)
\nIMPORTANTE: Os retornos e confirmação por webhook são enviados com o processamento da ação.
\nObservação: Esse webhook é disparado quando é confirmado o processamento da ação, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação na ação de alterar a imagem enviada anteriormente está vinculada ao \"action_id\" retornado na ação de criar, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{ \n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRM_GROUP_IMAGE_UPDATE\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\",\n \"status\": \"SUCCESS\",\n \"result\": {}\n}\n\nPossibilita bloquear número de Whatsapp, conforme o recurso disponível no app.
\nA ação de bloquear número de Whatsapp é enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de bloquear número de Whatsapp ao ser enviada, é retornado um id de registro da ação, no qual será confirmada postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou quando a resposta for adquirida, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação bloquear número de whatsapp enviada anteriormente está vinculada ao \"number\" ou \"action_id\" retornado na ação, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{\n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRMA_PROFILE_BLOCKUSER\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\",\n \"number\": \"numero enviado para verificação\",\n \"status\": \"SUCCESS\",\n \"result\": {}\n}\n\nA ação não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de bloquear um número no whatsapp, o número não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nPossibilita desbloquear número de Whatsapp bloqueado anteriormente, conforme o recurso disponível no app.
\nA ação de desbloquear número de Whatsapp bloqueado anteriormente é enviada para a fila de execuções, garantimos a execução da ação.
\n{\n \"result\": {\n \"action_id\": \"id da fila de ações\"\n },\n \"message\": \"GROUP_ACTION_SCHEDULED\",\n \"isValid\": true\n}\n\nApós a ação de desbloquear número de Whatsapp ao ser enviada, é retornado um id de registro da ação, no qual será confirmado postariormente, será disparado uma requisição para a url do webhook configurado na instância com o seguinte objeto:
\nObservação: Esse webhook é disparado quando é enviado/na fila ou quando a resposta for adquirida, preste atenção na propriedade \"instance_key\" ou \"instance_id\", ele é o identificador principal da instância vinculada.
\nA identificação da ação desbloquear número de whatsapp enviada anteriormente está vinculada ao \"number\" ou \"action_id\" retornado na ação, utilize este identificador para aplicar ações em seu webhook de retorno.
\nSTATUS DO RETORNO WEBHOOK
\nSUCCESS - Deu certo operação teve sucesso.
\nERROR - Não teve sucesso na operação.
\n\n\nWEBHOOK RETORNO DE AÇÃO >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
\n
{\n \"fLogin\": \"complemento de autenticação do uso da instância\",\n \"ACTION\": \"CONFIRMA_PROFILE_UNBLOCKUSER\",\n \"instance_key\": \"Key da instância que enviou a mensagem (action_id)\",\n \"instance_id\": \"ID único da instância que enviou a mensagem (action_id)\",\n \"instance_id_reffer\": \"ID de referância de sua instância, um id único atemporal, tem mesmo efeito do instance_id, caso seja útil para controle em sua ferramenta\",\n \"action_id\": \"id da fila de ações\",\n \"number\": \"numero enviado para verificação\",\n \"status\": \"SUCCESS\",\n \"result\": {}\n}\n\nA ação não foi enviada pois a instância não está conectada.
\n{\n \"result\": {},\n \"message\": \"INSTANCE_NOT_CONNECTED\",\n \"isValid\": false\n}\n\nA ação de desbloquear um número no whatsapp bloqueado anteriormente, o número não estão válidos ou vazio. Verifique o formato dos itens de envio.
\n{\n \"result\": {},\n \"message\": \"INVALID_DATA_ACTION\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\n*As oprações no pomor pode levar de 5 segundos a 30 segundos para completar, esse tempo é variável com a demanda.
\nPossibilita criar novas instâncias em sua conta, importante que a quantidade máxima de instâncias a criar é limitada conforme plano contratado.
\nA INTÂNCIA É CRIADA E ATIVADA AUTOMATICAMENTE NO SISTEMA
\n*Ultilize o método de conexão da instância para acesso ao QR Code para pareamento do Whatsapp.
\nA criação da instância retorna as informações de conexão e autenticação e utilização da instância, o \"instance_id\" retornado pode ser utilizado para consulta postarior utilizando o método de listar instâncias da conta.
\nGESTÃO DE CONTA E INSTÂNCIAS POR API
\nEssa funcionalidade é disponibilizada com o seu menu de PARCEIRO ativo, onde vai disponibilizar uma chave de acesso e autenticação, permitir que gerencie criando instâncias, ativando ou desativando as mesmas.
Importante implementar uma lógica de uso onde seu sistema integrado gerencie as instâncias, podendo criar, ativar, desativar, ou mesmo reativar a instância novamente, reutilizar ela com um novo número de Whatsapp, onde é possível realizar a reutilização da mesma inância desativada e reativada para númeres diferentes, etc.
{\n \"result\": [\n {\n \"instance_id\": \"79\",\n \"instance_id_reffer\": \"1235\",\n \"name\": \"Nome de identificação\",\n \"webhookUrl\": \"https://eoofbqi9ht5u74.m.pipedream.net\",\n \"instance_key\": \"OELK-000000-XXXX-j4KM-IH1B6681EY3U\",\n \"instance_token\": \"LP753Y4V-ujXX-C0PE-S82H-AN9YJGU5P3VS\",\n \"instance_login\": \"3CGYI5N1-3r9TyA-CVsUxBt2-6BEI2KY5SOUF\",\n \"profile_number\": null,\n \"profile_name\": null,\n \"createdAt\": \"2022-12-09T12:51:52-03:00\",\n \"expiresAt\": \"2022-12-16T12:51:52-03:00\",\n \"state\": \"activaction\",\n \"state_id\": \"1\", \n \"self\": \"false\"(opcional: true = ativar, false = desativar, so retorna se foi aplicado)\n }\n ],\n \"isValid\": \"true\",\n \"available_count\": \"5\",\n \"remaining_count\": 1\n}\n\n{\n \"result\": [],\n \"isValid\": \"false\",\n \"available_count\": \"5\",\n \"remaining_count\": 0,\n \"message\": \"SOLD_OUT_QUANTITY\"\n}\n\n{\n \"result\": [],\n \"isValid\": \"false\",\n \"message\": \"INVALID_WEBHOOK_URL\"\n}\n\nMétodo tem função de listar as instâncias disponíveis em sua conta, criados pelo método de criação de instância anterior.
\nCom esse método pode ter acesso aos dados de autenticação de cada instância de sua conta, podendo visualizar uma única instância utilizando o \"instance_id\" ou mesmo filtrar pelos status \"state\" (inactive, active (activaction, disconnected, connected)).
\nCaso não seja informados os filtros é retornados todas as intâncias disponíveis.
\nVARIÁVEIS DE CONTROLE
page - Define a página atual da consulta solicitada
pageSize - Define a quantidade de registros por página
{\n \"result\": [\n {\n \"instance_id\": \"7\",\n \"instance_id_reffer\": \"1237\",\n \"name\": \"Instance nome\",\n \"webhookUrl\": \"https://webhook-url.com\",\n \"instance_key\": \"KABK-000000-KrDp-XXX-ABB3X2ERVIZX\",\n \"instance_token\": \"WLF2PX54-XXXX-5j7w-6O1V-JHDYP86SW1G0\",\n \"instance_login\": \"OGKDS3QL-RPfVQW-xNFciWbo-34EL22K4ZMEP\",\n \"profile_number\": \"197849457569\",\n \"profile_name\": \"Digo\",\n \"createdAt\": \"2022-12-04T15:49:20-03:00\",\n \"expiresAt\": \"2022-12-11T23:59:00-03:00\",\n \"state\": \"connected\",\n \"state_id\": \"9\"\n },\n {\n \"instance_id\": \"6\",\n \"name\": \"Instance teste\",\n \"webhookUrl\": \"https://webhook-url.com\",\n \"instance_key\": \"J1E3-000000-tUBF-XXXX-OP8XE6E31YD1\",\n \"instance_token\": \"I3E0539U-5mdg-agmw-rSga-ADAGV09J0CY5\",\n \"instance_login\": \"VGYNLDKJ-XXX2l5-79sxHEBK-EIX2B45ADLIM\",\n \"profile_number\": null,\n \"profile_name\": null,\n \"createdAt\": \"2022-12-04T15:49:12-03:00\",\n \"expiresAt\": \"2030-10-10T23:59:00-03:00\",\n \"state\": \"disconnected\",\n \"state_id\": \"2\"\n }\n ],\n \"isValid\": \"true\",\n \"totalPage\": 100, //total de registro nessa página de consulta retornado\n \"totalPages\": 3, //total de paginas disponível para consultar pageSize\n \"total\": \"203\" // total de registros livres de páginação\n}\n\nPossibilita alterar a url do webhook da API de conta esse webhook não recebe mensagens rerlacionadas as funcionalidade da instância, esse webhook é relacionado a gestão de sua conta.
\nJSON
\n{\n \"result\": [],\n \"isValid\": \"true\",\n \"available_count\": \"5\",\n \"remaining_count\": 0,\n \"instance_id\": null\n}\n\nJSON
\n{\n \"result\": {},\n \"message\": \"INVALID_WEBHOOK_URL\",\n \"isValid\": false,\n \"instance_id\": \"5\",\n \"instance_id_reffer\": \"1235\"\n}\n\nJSON
\n{\n \"result\": {},\n \"message\": \"INVALID_ACCESS_TOKEN\",\n \"isValid\": false\n}\n\n*As oprações no pomor pode levar de 5 segundos a 30 segundos para completar, esse tempo é variável com a demanda.
\nPossibilita ATIVAR uma instância, tornando a mesma disponível para utilização de suas funcionalidades de envio e recebimento de mensagens.
\nUltilize o métodos de listar instâncias anteriores com filtro \"state=inactive\" pode assim localizar as instâncias disponíveis para ativação.
\nÉ possível também ATIVAR instâncias que foram desativadas pelo método para desativar instância.
\nApós a ativação, a instância retorna o \"state=activaction\" em alguns segundos fica disponível e utilizando os métodos de intância será possível obter o QR Code para pareamento e posteirormente utilização geral.
\nSOBRE CACHE DA INSTÂNCIA AO ATIVAR (opcional)
clearCache - Definir false, significa não limpar o cache da sessão anterior, se antes de desativar existiu um pareamento retorna o memso ativo. *Importante caso use a instância em seu sistema trocando de clientes, não desative a limpeza, pois a limpesa vai solicitar um novo pareamento do Whatsapp.
SOBRE LOGIN DA INSTÂNCIA AO ATIVAR (opcional)
generateLOGIN - Definir true, possibilita ALTERAR/GERAR NOVO fLogin de uma instância, tornando o anterior inacessível, com a justificativa de manter sua instância segura ou única em caso de alterações realizadas.
SOBRE AUTO LEITURA OU LEITURA AUTOMÁTICA DE MENSAGENS (opcional)
autoSelf - Definir false, possibilita desativar a leitura automática da instância a ativar, podendo usar true para definir como ativado. Esse recurso tem como objetivo remover as notificações do aparelho pareado com o sistema.
{\n \"result\": {\n \"instance_id\": \"1\",\n \"instance_id_reffer\": \"1235\",\n \"instance_login\": \"BVC00000-9900XX-00000000-000000000002\",\n \"state_id\": \"1\",\n \"createdAt\": \"2022-11-22T17:48:56-03:00\",\n \"expiresAt\": \"2022-12-09T23:59:00-03:00\"\n },\n \"isValid\": \"true\"\n}\n\n{\n \"result\": [],\n \"isValid\": \"false\",\n \"message\": \"IS_ACTIVE\"\n}\n\n{\n \"result\": [],\n \"isValid\": \"false\",\n \"message\": \"NO_ACTIVATE\"\n}\n\n{\n \"result\": {},\n \"message\": \"INVALID_ACCESS_TOKEN\",\n \"isValid\": false\n}\n\nPossibilita CRIAR um link direto com a HALLO-API para realização do pareamento de uma instância.
\nÉ possível realizar o pareamento com o código QR exposto nesse link. IMPORTANTE: Não é necessário utilizar esse link em sua aplicação, pode utilizar o método na API que te entrega o código QG em sua aplicação e usar seu URL de forma personalizada!
\n{\n \"result\": {\n \"state\": \"LINK\",\n \"instance_id\": 502,\n \"instance_id_reffer\": \"761502\",\n \"link\": \"https://app.hallo-api.com/par/qr=5HRDJZTG4PSCZM5X5I-qJvH5PMt-zjaDybDfkU-THJDE3FZHZNK-2\",\n \"expiresAt\": \"2023-07-04T02:58:50-03:00\",\n \"expires\": 1688450330\n },\n \"isValid\": \"true\"\n}\n\n{\n \"result\": [],\n \"isValid\": \"false\",\n \"message\": \"NO_ACTIVATE\"\n}\n\n{\n \"result\": {},\n \"message\": \"IS_ACTIVATE\",\n \"isValid\": false\n}\n\nPossibilita ALTERAR/GERAR NOVO fLogin de uma instância, tornando o anterior inacessível, com a justificativa de manter sua instância segura ou única em caso de alterações realizadas.
\nUltilize o recurso para gerar novo acesso para sua instância, podendo proteger a mesma em caso de alteração que deseje remover o acesso anterior.
\nÉ importante observar que ao realizar essa alteração os acessos anteriores serão removidos.
\nApós a ativação, a instância retorna o \"state=activaction\" em alguns segundos fica disponível e utilizando os métodos de intância será possível obter o QR Code para pareamento e posteirormente utilização geral.
\n{\n \"result\": {\n \"instance_id\": \"1\",\n \"instance_id_reffer\": \"1235\",\n \"instance_login\": \"BVC00000-9900XX-00000000-000000000002\"\n },\n \"isValid\": \"true\"\n}\n\n*As oprações no pomor pode levar de 5 segundos a 30 segundos para completar, esse tempo é variável com a demanda.
\nPossibilita DESATIVAR uma instância, tornando a mesma indisponível para utilização de suas funcionalidades de envio e recebimento de mensagens.
\nUltilize o métodos de listar instâncias anteriores com filtro \"state=active\" pode assim localizar as instâncias disponíveis para inativação ou todas em atividade, estando desconectadas ou conectadas..
\nÉ possível também DESATIVAR instâncias que foram ativadas pelo método para ativar instância.
\nApós a desativação, a instância retorna o \"state=inactive\" em alguns segundos é removida de operação e fica insdisponível para ultilização geral.
\n{\n \"result\": {\n \"instance_id\": \"1\",\n \"instance_id_reffer\": \"1235\",\n \"state\": \"inactive\",\n \"state_id\": \"0\",\n \"createdAt\": \"2022-11-22T17:48:56-03:00\"\n },\n \"isValid\": \"true\"\n}\n\n{\n \"result\": [],\n \"isValid\": \"false\",\n \"message\": \"IS_DISABLE\"\n}\n\nA instância está aplicando ação, motor OCUPADO, tente novamente em alguns segundos!
*As oprações no pomor pode levar de 5 segundos a 30 segundos para completar, esse tempo é variável com a demanda.
{\n \"result\": [],\n \"isValid\": \"false\",\n \"message\": \"NO_DISABLE\"\n}\n\n{\n \"result\": {},\n \"message\": \"INVALID_ACCESS_TOKEN\",\n \"isValid\": false\n}\n\n*As oprações no pomor pode levar de 5 segundos a 30 segundos para completar, esse tempo é variável com a demanda.
\nPossibilita REMOVER uma instância, tornando a mesma indisponível para utilização de suas funcionalidades de envio e recebimento de mensagens.
\nÉ possível também DESATIVAR instâncias que foram ativadas pelo método para ativar instância, com esse método pode também gerir suas instâncias.
\nApós a remoção, a instância em alguns segundos é removida de operação e fica insdisponível para ultilização geral.
\n{\n \"result\": {\n \"instance_id\": \"1\",\n \"instance_id_reffer\": \"1231\",\n \"state\": \"remove\",\n \"createdAt\": \"2022-11-22T17:48:56-03:00\"\n },\n \"isValid\": \"true\"\n}\n\n{\n \"result\": [],\n \"isValid\": \"false\",\n \"message\": \"NO_REMOVE\"\n}\n\nPossibilita iniciar aquecimento de número conectado em instância.
*O aquecimento é \"útil\" ou aplicável em instâncias com menos atendimentos passivos e maior fluxo ativo, criando na mesma um fluxo de troca de mensagens melhorando seu relacionamento com a plataforma, onde chamamos de AQUECIMENTO.
**Esse recurso só está disponível para parceiros com altorização, os demais vão receber retorno de erro ao utilizar.
\nJSON
\n{\n \"result\": {\n \"instance_id\": 1,\n \"instance_id_reffer\": \"0951\",\n \"action_state\": \"3\"\n },\n \"isValid\": \"true\",\n \"action\": \"HEATING\",\n \"metodo\": \"instance\",\n \"account\": 1,\n \"message\": \"Intância teve aquecimento iniciado!\"\n}\n\nJSON
\n{\n \"result\": {\n \"instance_id\": 1,\n \"instance_id_reffer\": \"0951\",\n \"action_state\": \"2\"\n },\n \"isValid\": \"true\",\n \"action\": \"HEATING\",\n \"metodo\": \"instance\",\n \"account\": 1,\n \"message\": \"Sua conta não permite aquecimento!\"\n}\n\nJSON
\n{\n \"result\": {},\n \"message\": \"INVALID_ACCESS_TOKEN\",\n \"isValid\": false\n}\n\nSTATUS DE RETORNO:
0 = Instância não disponível!
1 = Já existe um aquecimento em andamento!
2 = Sua conta não permite aquecimento!
3 = Intância teve aquecimento iniciado!
Possibilita parar o aquecimento já iniciado em número conectado em instância.
*O aquecimento não deve ser utilizado com grande frequência de formas consecutivas, evitando \"sobrecarga\" de menssagens.
**Esse recurso é utilizado para INTERROMPER o aquecimento antes da conclusão.
\nJSON
\n{\n \"result\": {\n \"instance_id\": 1,\n \"instance_id_reffer\": \"0951\",\n \"action_state\": \"1\"\n },\n \"isValid\": \"true\",\n \"action\": \"HEATING_STOP\",\n \"metodo\": \"instance\",\n \"account\": 1,\n \"message\": \"Intância teve aquecimento finalizado!\"\n}\n\nJSON
\n{\n \"result\": {\n \"instance_id\": 1\n \"action_state\": \"0\"\n },\n \"isValid\": \"true\",\n \"action\": \"HEATING_STOP\",\n \"metodo\": \"instance\",\n \"account\": 1,\n \"message\": \"Intância não tem aquecimento ativo!\"\n}\n\nJSON
\n{\n \"result\": {},\n \"message\": \"INVALID_ACCESS_TOKEN\",\n \"isValid\": false\n}\n\nSTATUS DE RETORNO:
0 = Intância não tem aquecimento ativo!
1 = Intância teve aquecimento finalizado!
Possibilita acompanhar o STATUS do aquecimento já iniciado em número conectado em instância.
*O aquecimento não deve ser utilizado com grande frequência de formas consecutivas, evitando \"sobrecarga\" de menssagens.
**Esse recurso é utilizado para ACOMPANHAR o aquecimento antes ou após a conclusão.
\nJSON
\n{\n \"result\": {\n \"instance_id\": 1,\n \"action_state\": \"1\",\n \"time_end\": \"0\",//Define o fim do aquecimento - se já finalizou [TIMESTAMP]\n \"instance_id_reffer\": \"0951\",\n \"time_cicle\": \"1703293873\",//Timestamp de ultima interação no ciclo de aquecimento\n \"aquecer_send\": \"1\",//Quantidade de mensagens enviadas\n \"aquecer_qtd\": \"4\"//Quantidade de interações recebidas\n },\n \"isValid\": \"true\",\n \"action\": \"HEATING_STATE\",\n \"metodo\": \"instance\",\n \"account\": 1,\n \"message\": \"Em aquecimento!\"\n}\n\nJSON
\n{\n \"result\": {\n \"instance_id\": 1,\n \"action_state\": \"0\",\n \"time_end\": \"1703293873\",//Se houve aquecimento anterior aqui informa o término\n \"instance_id_reffer\": \"0951\",\n \"time_cicle\": \"1703293873\",\n \"aquecer_send\": \"1\",\n \"aquecer_qtd\": \"4\"\n },\n \"isValid\": \"false\",\n \"action\": \"HEATING_STATE\",\n \"metodo\": \"instance\",\n \"account\": 1,\n \"message\": \"Sem aquecimento ativo!\"\n}\n\nJSON
\n{\n \"result\": {},\n \"message\": \"INVALID_ACCESS_TOKEN\",\n \"isValid\": false\n}\n\nSTATUS DE RETORNO:
0 = Sem aquecimento ativo!
1 = Em aquecimento!
Responsável pela gestão das instâncias adquiridas.
\nToda ação é necessário que seja informado as chaves de acesso para a instância, sendo elas:
\n{{instanceKey}} - Chave de identificação da instância.
{{instanceToken}} - Chave de acesso à instância.
Ambas chaves não devem ser compartilhadas, qualquer um poderá acessar a sua instância caso tenha as chaves acima. As chaves de autenticação não são as das intâncias, assim que sua conta parceiro é ativada, clique no menu DADOS DA CONTA, vai localizar essa autenticação lá :)
\nAs chaves de acesso estarão disponíveis em conta de parceito ativa, em dados da conta vai localizar \"Gestão de conta por API\".
\n\nVARIÁVEIS DE CONTROLE
instance_id - ID de controle do painel de sua instância.
instance_id_reffer - ID de referância de sua instância, um id único atemporal (tem mesmo efeito do instance_id), caso seja útil para controle em sua ferramenta.
GESTÃO DE CONTA E INSTÂNCIAS POR API
\nEssa funcionalidade é disponibilizada com o seu menu de PARCEIRO ativo, onde vai disponibilizar uma chave de acesso e autenticação, permitir que gerencie criando instâncias, ativando ou desativando as mesmas.
Importante implementar uma lógica de uso onde seu sistema integrado gerencie as instâncias, podendo criar, ativar, desativar, ou mesmo reativar a instância novamente, reutilizar ela com um novo número de Whatsapp, onde é possível realizar a reutilização da mesma inância desativada e reativada para númeres diferentes, etc.