Documentação

Seja bem vindo a Mega-api ! Documentação completa da melhor api, para integração com o whatsapp no Brasil!:

Introdução à Mega-api

Bem-vindo à Mega-api! Conheça nossa solução de integração com o WhatsApp e explore seus recursos:

O que é a Mega-api?


A Mega-api é uma solução avançada para integração com o WhatsApp, permitindo que empresas e desenvolvedores ampliem suas capacidades de comunicação, conectando-se de maneira eficiente e segura com seus clientes através deste popular aplicativo de mensagens.

Para quem a Mega-api foi desenvolvida?


A Mega-api foi desenvolvida para empresas, desenvolvedores e profissionais que desejam otimizar sua comunicação via WhatsApp, seja para atendimento ao cliente, marketing ou outros objetivos empresariais. Independentemente do tamanho ou do setor, a Mega-api tem as ferramentas para impulsionar suas operações.

Quem pode utilizar a Mega-api?


Qualquer pessoa ou empresa que deseja melhorar e ampliar sua comunicação no WhatsApp. Desde pequenas empresas até grandes corporações, a Mega-api é flexível e escalável para atender às necessidades de todos.

Limites de envio de mensagens:


NÃO TEMOS LIMITE para o número de mensagens enviadas! No entanto, é importante entender que você está utilizando uma sessão do WhatsApp Web, então o padrão de utilização precisa ser compatível. Além disso, sempre recomendamos que você leia atentamente as políticas estabelecidas pelo próprio WhatsApp em sua página oficial.

URLs para chamadas dos endpoints

Os hosts listados abaixo podem variar de acordo com a instância criada. A seleção específica do host dependerá da disponibilidade do servidor no momento da criação da instância. Isso é feito para garantir que nossos servidores não sejam sobrecarregados e para manter a performance ideal para todos os usuários

HOST URL
api2 api2.megaapi.com.br
api4 api4.megaapi.com.br
api5 api5.megaapi.com.br
apistart01 apistart01.megaapi.com.br
apistart02 apistart02.megaapi.com.br
apibusiness01 apibusiness01.megaapi.com.br

Para sua comodidade, lembre-se de que essas informações, bem como outras configurações e detalhes relevantes, estão sempre disponíveis no painel de usuário da Mega-api. Recomendamos verificar regularmente para obter as informações mais atualizadas e garantir a otimização do uso da nossa API.

lightbox

Instance Key e Token

Entenda os conceitos da Mega-api e saiba como a Instance Key e o Token são fundamentais para a integração com sua aplicação.

Para que serve?

Para assegurar uma comunicação segura entre a Mega-api e sua aplicação, estabelecemos um protocolo de autenticação robusto. Cada interação com nossa API deve ser autenticada usando uma Instance Key e um Token. Esses identificadores garantem a integridade e segurança das suas requisições.

Na Mega-api, a Instance Key é usada na URL, enquanto o Token é incluído no header das requisições no formato Bearer, garantindo assim uma maior segurança na transmissão de dados.

Como localizar minha Instance Key e Token?

Assim que você cria sua conta na Mega-api, será necessário criar uma instância, que terá sua própria Instance Key e Token. Estes dois identificadores trabalham juntos para garantir a comunicação segura entre sua aplicação e a Mega-api. Para visualizar sua Instance Key e Token, acesse a instância no painel do usuário e clique em 'Detalhes'. Lá, você encontrará todos os detalhes relacionados à instância. E lembre-se, se você tiver múltiplas instâncias, cada uma terá sua própria Instance Key e Token.

lightbox

Autenticação Bearer Token

Para garantir uma comunicação segura e autenticada entre sua aplicação e a Mega-api, utilizamos o método de autenticação Bearer Token. Esta é uma prática padrão que oferece segurança robusta para APIs.

Na autenticação Bearer Token, o Token é enviado no header da requisição HTTP. Isso permite à Mega-api validar e autenticar a requisição antes de processá-la. Assegura-se de que apenas entidades autorizadas possam interagir com a API.

Aqui está um exemplo de como incluir o Bearer Token no header de uma requisição:

Authorization: Bearer SEU_TOKEN_AQUI

Substitua "SEU_TOKEN_AQUI" pelo token específico da sua instância. Mantenha o prefixo "Bearer" exatamente como mostrado, seguido de um espaço e depois o seu token.

É essencial que todas as suas requisições para a Mega-api sigam este formato de autenticação. Isso não apenas garante a segurança das suas operações, mas também a integridade dos dados transmitidos.

INSTANCE CONTROLLER

Introdução

Uma instância pode ser visualizada como uma ponte dedicada entre um número específico de telefone com uma conta no WhatsApp e a plataforma Mega-API. Esta ponte permite a transmissão e recepção de mensagens, possibilitando uma comunicação fluida e consistente. Com a capacidade de criar múltiplas instâncias, os usuários têm a liberdade de conectar diversos números de WhatsApp à sua conta na plataforma.

Por trás da Instância

No contexto técnico, quando falamos de uma instância, estamos nos referindo a um container ou máquina virtual dentro da nossa sofisticada infraestrutura. Essa estrutura é especialmente projetada para oferecer um ambiente seguro e otimizado para a conexão do seu número de WhatsApp. Embora cada instância esteja vinculada a um único número, há uma flexibilidade inerente; é completamente viável desconectar um número existente e estabelecer uma nova conexão com um número diferente usando a mesma instância.

Nossa Abordagem Técnica

A base do nosso serviço é inspirada na versatilidade do WhatsApp Web. No entanto, evoluímos essa ideia ao construir uma camada adicional que permite a manipulação por meio de uma API RestFul, oferecendo uma experiência ampliada e mais controlada. Ao avançar, vamos detalhar mais sobre o funcionamento das instâncias, garantindo que você esteja bem equipado para começar.

Status

Este método te permite verificar se sua instância está conectada a sua conta Whatsapp.

/instance/{{instance_key}}

GET https://{{host}}/rest/instance/{{instance_key}}

Header

KEY VALUE
Authorization Bearer {{token}}

Response

Atributos Tipo Descrição
message string Mensagem de retorno
instance object Contém os dados da instancia
key string Nome da instancia
id string Whatsapp que está conectado
verifiedName / name string Nome do contato

Exemplo de solicitação

Buscar todos os chats

Este método te permite buscar todos os chats.

/instance/chats/{{instance_key}}

GET https://{{host}}/rest/instance/chats/{{instance_key}}

Header

KEY VALUE
Authorization Bearer {{token}}

Response

Atributos Tipo Descrição
error string Status do Retorno
message string Mensagem do retorno
chats array Lista contendo todos os chats
participants array Lista os participantes do grupo
id string Whatsapp da conversa
unreadCount number Qtd. Mensagens não lidas
conversationTimestamp / low timestamp Data e hora
conversationTimestamp / unsigned boolean Whatsapp oficial (Selo verde)

Exemplo de solicitação

Buscar todos os contatos

Este método te permite buscar todos os contatos.

/instance/contacts/{{instance_key}}

GET https://{{host}}/rest/instance/contacts/{{instance_key}}

Header

KEY VALUE
Authorization Bearer {{token}}

Response

Atributos Tipo Descrição
error string Status do Retorno
message string Mensagem do retorno
chats array Lista contendo todos os contatos
id string Contato
name string Nome do contato

Exemplo de solicitação

Buscar mensagens

Este método permite que busque as mensagens de um chat específico

/instance/messages/{{instance_key}}?chat_id=551199999999

GET https://{{host}}/rest/instance/messages/{{instance_key}}?chat_id=551199999999

Header

KEY VALUE
Authorization Bearer {{token}}

Request Params

Atributos Tipo Descrição
chat_id string Contato Whatsapp (EX: [email protected] ) ou Grupo Whatsapp ([email protected])

Response

Atributos Tipo Descrição
remoteJid string Contato Whatsapp
id string ID da mensagem
fromMe boolean true - Mensagem enviada
false - Mensagem recebida
status number Status da mensagem enviada
2 - Enviada
3 - Entregue
4 - Visualizada

Exemplo de solicitação

Download dos arquivos de mídias

Este endpoint é destinado ao download de arquivos de mídia recebidos através do webhook do WhatsApp. Os arquivos são criptografados e necessitam de várias chaves, como mediaKey, directPath, url, e mimetype, para serem descriptografados e acessados. A requisição deve ser do tipo POST e contém um corpo de dados específico.

/instance/downloadMediaMessage/{{instance_key}}

POST https://{{host}}/rest/instance/downloadMediaMessage/{{instance_key}}

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
mediaKey string Key retornado pelo Whatsapp
directPath string Path retornado pelo Whatsapp
url string URL retornado pelo Whatsapp
mimetype string MineType retornado pelo Whatsapp
messageType string image, document, audio, video

Request Body

                                        
                                            {
                                                "messageKeys": {
                                                    "mediaKey": "309GwkbNs+hvIl+oGYHVIEa+eWGFvYbhwhPrrTQ+P40=",
                                                    "directPath": "/v/t62.7118-24/33508108_425320909632029_855316559690107593_n.enc?ccb=11-4&oh=01_AVwsxssXNsJd8unW7UogNLzFkvWXWQAD18uu1fcMG56mrQ&oe=62FB2248",
                                                    "url": "https://mmg.whatsapp.net/v/t62.7117-24/29574318_6036841743076666_3009887773264574325_n.enc?ccb=11-4&oh=01_AdScv9HQNKy4od39pDdDZjVh_RXfcX3vr94CPXhWKvuBBg&oe=6425B5F7&mms3=true",
                                                    "mimetype": "image/jpeg",
                                                    "messageType": "image"
                                                }
                                            }

🤔 Aonde encontro essas informações no meu webhook?

Abaixo, temos um exemplo de um payload de uma mensagem recebida do tipo audio. Marcamos na imagem as quatro informações necessárias para serem enviadas, no body da requisição

lightbox

Response

Atributos Tipo Descrição
error string Status do Retorno
data string Arquivo no formato base64

Exemplo de solicitação

Buscar imagem perfil

Este método permite que busque imagem de um perfil do whatsapp

/instance/getProfilePicture/{{instance_key}}?to=551199999999&type=image

GET https://{{host}}/rest/instance/getProfilePicture/{{instance_key}}?chat_id=551199999999&type=image

Header

KEY VALUE
Authorization Bearer {{token}}

Request Params

Atributos Tipo Descrição
chat_id string Contato Whatsapp (EX: [email protected] ) ou Grupo Whatsapp ([email protected])
type string icon = pega a imagem pequena
image = pega a imagem tamanho normal

Response

Atributos Tipo Descrição
error boolean Status
data string URL da imagem do perfil

Exemplo de solicitação

Atualizar imagem do perfil Whatsapp

Este método é reponsavel em alterar a imagem de perfil do Whatsapp conectado

/instance/setProfilePictureUrl/{{instance_key}}

POST https://{{host}}/rest/instance/setProfilePictureUrl/{{instance_key}}

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Whatsapp que esta conectado na api para troca da imagem do perfil
url string URL da imagem

Request Body

                                        
                                            {
                                                "messageData": {
                                                    "to": "[email protected]",
                                                    "url": "URL da imagem"
                                                }
                                            }

Response

Atributos Tipo Descrição
error string true caso tenha dado certo e false em caso de falha
message string Mensagem de retorno da requisição

Exemplo de solicitação

Atualizar descrição do perfil Whatsapp

Este método é reponsavel em alterar a descrição de perfil no Whatsapp conectado

/instance/setProfileStatus/{{instance_key}}

POST https://{{host}}/rest/instance/setProfileStatus/{{instance_key}}

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
status string Mensagem que deseja adicionar na descrição do perfil

Request Body

                                        
                                            {
                                                "messageData": {
                                                    "status": "Mega-api, a melhor api para whatsapp no Brasil!"
                                                }
                                            }

Response

Atributos Tipo Descrição
error string true caso tenha dado certo e false em caso de falha
message string Mensagem de retorno da requisição

Exemplo de solicitação

Atualizar nome do perfil Whatsapp

Este método é reponsavel em alterar o nome de perfil do Whatsapp conectado

/instance/setProfileName/{{instance_key}}

POST https://{{host}}/rest/instance/setProfileName/{{instance_key}}

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
name string Nome que deseja adicionar no perfil do Whatsapp

Request Body

                                        
                                            {
                                                "messageData": {
                                                    "name": "Mega-api"
                                                }
                                            }

Response

Atributos Tipo Descrição
error string true caso tenha dado certo e false em caso de falha
message string Mensagem de retorno da requisição

Exemplo de solicitação

Validação do número com whatsapp

Este método vrifica se o número tem ou não Whatsapp.

/instance/isOnWhatsApp/{{instance_key}}?jid=551199999999

GET https://{{host}}/rest/instance/isOnWhatsApp/{{instance_key}}?jid=551199999999

Header

KEY VALUE
Authorization Bearer {{token}}

Request Params

Atributos Tipo Descrição
jid string Contato Whatsapp (EX: [email protected] ) que será verificado

Response

Atributos Tipo Descrição
exists boolean true - Whatsapp Existe
false - Whatsapp não existe
jid string Contato whatsapp

Exemplo de solicitação

Conectar whatsapp

Para acessar os recursos da Mega-API, você terá que efetuar a leitura de um QRCode ou inserir um número de telefone, de forma semelhante ao que ocorre com o WhatsApp Web.

Há duas abordagens possíveis para estabelecer essa conexão:

  • Utilizar o nosso painel de gestão para efetuar a conexão, ou
  • Integrar esse processo diretamente na sua própria aplicação, utilizando as diretrizes fornecidas nesta documentação.

Escolha o método mais adequado para ler o QRCode do WhatsApp, conforme os métodos abaixo:

Header

KEY VALUE
Authorization Bearer {{token}}

Métodos

/instance/qrcode/{{instance_key}}

GET https://{{host}}/rest/instance/qrcode/{{instance_key}}

Esse método retorna o qrcode, sendo renderizado no HTML. Facilitando a renderização da imagem do qrcode.

/instance/qrcode_base64/{{instance_key}}

GET https://{{host}}/rest/instance/qrcode_base64/{{instance_key}}

Esse método retorna o a imagem do qrcode, do tipo base64. Podendo ser renderizado por exemplo, utilizando a tag HTML img, ou algum outro componente compatível com a sua linguagem de programação.

/instance/pairingCode/{{instance_key}}?phoneNumber=5511999999999

GET https://{{host}}/rest/instance/pairingCode/{{instance_key}}?phoneNumber=5511999999999

Este procedimento gera um código único que permite associar o seu número de telefone à API, eliminando a necessidade de escanear um QR Code. Basta inserir o código fornecido para estabelecer a conexão.

Desconectar do whatsapp

Este método desconecta seu Whatsapp da Mega-api.

/instance/{{instance_key}}/logout

DELETE https://{{host}}/rest/instance/{{instance_key}}/logout

Header

KEY VALUE
Authorization Bearer {{token}}

Response

Atributos Tipo Descrição
error boolean Status
message string Mensagem do retorno

Exemplo de solicitação

WEBHOOK CONTROLLER

Introdução

Um Webhook é um método eficiente de permitir que aplicações na internet se comuniquem entre si, transmitindo dados em tempo real sempre que um evento é ativado. Quando você integra com a Megaapi para receber informações via WhatsApp, é essencial estabelecer endpoints em seu aplicativo. Esses pontos de interação permitem que a Megaapi o notifique automaticamente sobre qualquer atividade ocorrendo em seu WhatsApp, sem necessidade de intervenção manual. Portanto, cada vez que o número conectado receber uma interação, a Mega-api fará uma requisição usando o método POST para a URL que você previamente configurou. Cada uma dessas requisições será acompanhada por um corpo JSON específico. Em resumo, Webhooks e a Megaapi juntos tornam possível um fluxo de informação automatizado e em tempo real para o seu WhatsApp.

Exemplos dos retorno do webhook Megaa-api

📄Mensagens recebidas tipo texto (messageType: conversation)

                                    
                                        {
										  "instance_key": "megaapi-sdfsdgkiiuyHH",
										  "jid": "[email protected]",
										  "isBusiness": false,
										  "messageType": "conversation",
										  "key": {
											"remoteJid": "[email protected]",
											"fromMe": false,
											"id": "ED8D5F177503C2F317DDAAA63635B06C"
										  },
										  "messageTimestamp": 1704815264,
										  "pushName": "Megaapi",
										  "broadcast": false,
										  "message": {
											"conversation": "Megaapi - A melhor api whatsapp",
											"messageContextInfo": {
											  "deviceListMetadata": {
												"senderKeyHash": "mkzk2kJzmE7+/Q==",
												"senderTimestamp": "1704719930",
												"recipientKeyHash": "5225lp0hE2wpPQ==",
												"recipientTimestamp": "1704813552"
											  },
											  "deviceListMetadataVersion": 2
											}
										  },
										  "verifiedBizName": "Megaapi"
										}

📄Mensagens recebidas tipo texto (messageType: extendedTextMessage)

                                    
                                        {
										  "instance_key": "megaapi-HFGHuydfg",
										  "jid": "[email protected]",
										  "isBusiness": false,
										  "messageType": "extendedTextMessage",
										  "key": {
											"remoteJid": "[email protected]",
											"fromMe": false,
											"id": "3EB0B0B4BB0F1CC219988A"
										  },
										  "messageTimestamp": 1704814208,
										  "pushName": "Megaapi",
										  "broadcast": false,
										  "message": {
											"extendedTextMessage": {
											  "text": "Oi bom dia",
											  "contextInfo": {
												"ephemeralSettingTimestamp": "1702904604",
												"disappearingMode": {
												  "initiator": "CHANGED_IN_CHAT",
												  "trigger": "CHAT_SETTING"
												}
											  },
											  "inviteLinkGroupTypeV2": "DEFAULT"
											},
											"messageContextInfo": {
											  "deviceListMetadata": {
												"senderKeyHash": "mkzk2kJzmE7+/Q==",
												"senderTimestamp": "1704719930",
												"recipientKeyHash": "5225lp0hE2wpPQ==",
												"recipientTimestamp": "1704562228"
											  },
											  "deviceListMetadataVersion": 2
											}
										  },
										  "verifiedBizName": "Megaapi"
										}

📄Mensagens recebidas tipo texto (messageType: ephemeralMessage)

                                    
                                        {
											"instance_key": "megaapi-kdfkjghdifj",
											"jid": "[email protected]",
											"isBusiness": true,
											"messageType": "ephemeralMessage",
											"key": {
												"remoteJid": "[email protected]",
												"fromMe": false,
												"id": "D2042AF1FC6CD1CE28"
											},
											"messageTimestamp": 1705607198,
											"pushName": "Megaapi",
											"broadcast": false,
											"message": {
												"messageContextInfo": {
													"deviceListMetadata": {
														"senderKeyHash": "zdsXt16gneppKQ==",
														"senderTimestamp": "1705578467",
														"recipientKeyHash": "4/XmyrdO+9At+A==",
														"recipientTimestamp": "1705526548"
													},
													"deviceListMetadataVersion": 2
												},
												"ephemeralMessage": {
													"message": {
														"extendedTextMessage": {
															"text": "ola",
															"contextInfo": {
																"expiration": 86400,
																"ephemeralSettingTimestamp": "1705526476",
																"disappearingMode": {
																	"initiator": "INITIATED_BY_OTHER"
																}
															}
														}
													}
												}
											}
										}

📄Mensagens recebidas tipo audio (messageType: audioMessage)

                                    
                                        {
                                            "instance_key": "megaapi-sdfdfhykilkjol",
                                            "jid": "[email protected]",
                                            "messageType": "audioMessage",
                                            "key": {
                                              "remoteJid": "[email protected]",
                                              "fromMe": false,
                                              "id": "5FD1F41408F697B674CA3ADD605687A1"
                                            },
                                            "messageTimestamp": 1688998845,
                                            "pushName": "Megaapi",
                                            "broadcast": false,
                                            "message": {
                                              "audioMessage": {
                                                "url": "https://mmg.whatsapp.net/v/t62.7117-24/26101326_1369464033967818_5474365542897363460_n.enc?ccb=11-4&oh=01_AdQjhLgwsDft2a7qV-McAsyclB-WoyHLITmpsL-XnI0GKA&oe=64D38814&mms3=true",
                                                "mimetype": "audio/ogg; codecs=opus",
                                                "fileSha256": "SwdQv1V6r5t6mipVz/Pahu20eqM+TgZ32eNc+6PMzs0=",
                                                "fileLength": "5999",
                                                "seconds": 4,
                                                "ptt": true,
                                                "mediaKey": "qz7L7KdrKq0iJdvI/YJe/ZjWg7hS5VoJ/FDrHDQ6o1k=",
                                                "fileEncSha256": "npQDLLWGHIXXsGPjyjWRUXMg1CVbf1DYJ5xjI2JY86Y=",
                                                "directPath": "/v/t62.7117-24/26101326_1369464033967818_5474365542897363460_n.enc?ccb=11-4&oh=01_AdQjhLgwsDft2a7qV-McAsyclB-WoyHLITmpsL-XnI0GKA&oe=64D38814",
                                                "mediaKeyTimestamp": "1688998842",
                                                "waveform": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=="
                                              },
                                              "messageContextInfo": {
                                                "deviceListMetadata": {
                                                  "senderKeyHash": "5NtBfGDpS10M5Q==",
                                                  "senderTimestamp": "1688993376",
                                                  "recipientKeyHash": "4vsArO2PIywtVA==",
                                                  "recipientTimestamp": "1688995880"
                                                },
                                                "deviceListMetadataVersion": 2
                                              }
                                            },
                                            "verifiedBizName": "Megaapi"
                                        }

📄Mensagens recebidas tipo video (messageType: videoMessage)

                                    
                                        {
                                            "instance_key": "megaapi-fgfhuhkyjytodwairefjrdfg",
                                            "jid": "[email protected]",
                                            "messageType": "videoMessage",
                                            "key": {
                                              "remoteJid": "[email protected]",
                                              "fromMe": false,
                                              "id": "DB14180A5E463B5C8E07F1FEFA705EF9"
                                            },
                                            "messageTimestamp": 1688998950,
                                            "pushName": "Megaapi",
                                            "broadcast": false,
                                            "message": {
                                              "videoMessage": {
                                                "url": "https://mmg.whatsapp.net/v/t62.7161-24/32575829_762500995613895_3138389360331200724_n.enc?ccb=11-4&oh=01_AdSNhvooGVUqIzjMzTGb5V0nI4TopPZ_5309zmjycD7dsQ&oe=64D36D47&mms3=true",
                                                "mimetype": "video/mp4",
                                                "fileSha256": "b6z2N6v3uBPue2q29GTMk6TiBjUgHibivf07PsY6Cyg=",
                                                "fileLength": "487315",
                                                "seconds": 2,
                                                "mediaKey": "ssFWeyqJ/bkZS9rstMp2OBNIJnnZXuFlXXmOekQDU0w=",
                                                "height": 672,
                                                "width": 368,
                                                "fileEncSha256": "IZDtgaZX0Pes2JpHuDPn5ZqBwToDcEnxZzPPeu0+K30=",
                                                "directPath": "/v/t62.7161-24/32575829_762500995613895_3138389360331200724_n.enc?ccb=11-4&oh=01_AdSNhvooGVUqIzjMzTGb5V0nI4TopPZ_5309zmjycD7dsQ&oe=64D36D47",
                                                "mediaKeyTimestamp": "1688998949",
                                                "jpegThumbnail": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEABsbGxscGx4hIR4qLSgtKj04MzM4PV1CR0JHQl2NWGdYWGdYjX2Xe3N7l33gsJycsOD/2c7Z//////////////8BGxsbGxwbHiEhHiotKC0qPTgzMzg9XUJHQkdCXY1YZ1hYZ1iNfZd7c3uXfeCwnJyw4P/Zztn////////////////CABEIAEgAJwMBIgACEQEDEQH/xAAvAAACAwEBAAAAAAAAAAAAAAAABAEDBQIGAQEBAQEAAAAAAAAAAAAAAAAAAgED/9oADAMBAAIQAxAAAABm+y3CvDkCY4EdwAZsmkSEqNpNw4nuenoDorleizw3zjebqze4WFc8tUNYtwZWwBs//8QAJRAAAgICAQMDBQAAAAAAAAAAAQIAAwQRIRQxUwUSQRATIDNh/9oACAEBAAE/AOmo8awYmOF/Us6TH8SzpKfGs6bH8SwCN2A+uoNA7M2DyPwChlYHtAABMnPFNntA3KfU6bCAQQYOYOFmZYa6uO5hCNxBUvx3Ex299KH+QBtkHt8TOJCgRK2LFjKUZLeRMcD7Y0JvczRwsZiDwZjgs2yYi+1QBFYTIAepo7gtMAozCCdTj+VZd6jSAVRty01ltgiY+SlJ3KfVqDw5Kz//xAAYEQACAwAAAAAAAAAAAAAAAAAAAREgMP/aAAgBAgEBPwDFkV//xAAbEQABBAMAAAAAAAAAAAAAAAABABAgMREhQf/aAAgBAwEBPwCQ2VymFrMf/9k=",
                                                "streamingSidecar": "k+W/Hld8v15dSWBl+avkELz4oZs/ozeeUUDfMEsUuHrXZNkOdXMJKM7qCAATth03G+B5XMMFlVhfnImd5Oz4H77D5jVoGKBcHEg+RbLEE8M="
                                              },
                                              "messageContextInfo": {
                                                "deviceListMetadata": {
                                                  "senderKeyHash": "5NtBfGDpS10M5Q==",
                                                  "senderTimestamp": "1688993376",
                                                  "recipientKeyHash": "4vsArO2PIywtVA==",
                                                  "recipientTimestamp": "1688995880"
                                                },
                                                "deviceListMetadataVersion": 2
                                              }
                                            },
                                            "verifiedBizName": "Megaapi"
                                        }

📄Mensagens recebidas tipo imagem (messageType: imageMessage)

                                    
                                        {
                                            "instance_key": "megaapi-dfgdfgfddflkyoreif4",
                                            "jid": "[email protected]",
                                            "messageType": "imageMessage",
                                            "key": {
                                              "remoteJid": "[email protected]",
                                              "fromMe": false,
                                              "id": "5496701AC02ECA38DF6D086E3C4EEF00"
                                            },
                                            "messageTimestamp": 1688999019,
                                            "pushName": "Megaapi",
                                            "broadcast": false,
                                            "message": {
                                              "imageMessage": {
                                                "url": "https://mmg.whatsapp.net/v/t62.7118-24/56249636_3101883020117577_8268908827765176859_n.enc?ccb=11-4&oh=01_AdR_GrfvFRBUF01YUeeuNzgUQsl8DJIYk2bhIpniP3fb0g&oe=64D37060&mms3=true",
                                                "mimetype": "image/jpeg",
                                                "fileSha256": "CrHzEMZm+d6kfqmivqcKYmdcpoQcIgk6BpaYKPsR7Xw=",
                                                "fileLength": "68223",
                                                "height": 1599,
                                                "width": 899,
                                                "mediaKey": "hYhJzBNqomEcqJChup1tThacMeAZGnC1mrES+7hgnMg=",
                                                "fileEncSha256": "tuT5APp667FAD0EnwziX0ysNZCTmv2CnkSvOZfx1yXQ=",
                                                "directPath": "/v/t62.7118-24/56249636_3101883020117577_8268908827765176859_n.enc?ccb=11-4&oh=01_AdR_GrfvFRBUF01YUeeuNzgUQsl8DJIYk2bhIpniP3fb0g&oe=64D37060",
                                                "mediaKeyTimestamp": "1688999013",
                                                "jpegThumbnail": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEABsbGxscGx4hIR4qLSgtKj04MzM4PV1CR0JHQl2NWGdYWGdYjX2Xe3N7l33gsJycsOD/2c7Z//////////////8BGxsbGxwbHiEhHiotKC0qPTgzMzg9XUJHQkdCXY1YZ1hYZ1iNfZd7c3uXfeCwnJyw4P/Zztn////////////////CABEIADwAIQMBIgACEQEDEQH/xAAuAAACAwEBAAAAAAAAAAAAAAAABQEDBgIEAQEBAQAAAAAAAAAAAAAAAAAAAQL/2gAMAwEAAhADEAAAAG0WRFJbBWdhZHCBdF0taEAHhTvEmdsXHhY3MHRZ4My5Ry6v34dhrOoEpZ//xAAjEAABBAEEAgMBAAAAAAAAAAABAAIDEQQQEiExBVEVIjJB/9oACAEBAAE/AGjaxFgVEdqlSd3rt9Kj60se9aU8oiYXKYzveX71gTSuJZIVS59LO6ATWybXFePHNm7QCpZ1UEHkO74WEzi9cvmByD3CTkLCcDEhplSuBDP4VK8tcoppbH3Ki8lkxn9L5XIX/8QAGBEAAwEBAAAAAAAAAAAAAAAAAAERECD/2gAIAQIBAT8A6YthD//EABoRAAIDAQEAAAAAAAAAAAAAAAABAhARMUH/2gAIAQMBAT8AvG7jwl2vBs0//9k=",
                                                "scansSidecar": "Zl9yVcohaUMRC7KxeoaF1ZVdko+93MWto4mWiSyO/cXO3U3aj0Ea2A==",
                                                "scanLengths": [
                                                  9880,
                                                  20519,
                                                  11264,
                                                  26560
                                                ],
                                                "midQualityFileSha256": "nw+qKVvr6rr8qFSOhF+MzXriEVUE+mi+1vUXlTjxYT8="
                                              },
                                              "messageContextInfo": {
                                                "deviceListMetadata": {
                                                  "senderKeyHash": "5NtBfGDpS10M5Q==",
                                                  "senderTimestamp": "1688993376",
                                                  "recipientKeyHash": "4vsArO2PIywtVA==",
                                                  "recipientTimestamp": "1688995880"
                                                },
                                                "deviceListMetadataVersion": 2
                                              }
                                            },
                                            "verifiedBizName": "Megaapi"
                                        }

📄Mensagens recebidas tipo documento (messageType: documentMessage)

                                    
                                        {
                                            "instance_key": "megaapi-sdfjrkerurgtrtgrtfg",
                                            "jid": "[email protected]",
                                            "messageType": "documentMessage",
                                            "key": {
                                              "remoteJid": "[email protected]",
                                              "fromMe": false,
                                              "id": "8C214F71959E3EA008D129EE1B743334"
                                            },
                                            "messageTimestamp": 1688999107,
                                            "pushName": "Megaapi",
                                            "broadcast": false,
                                            "message": {
                                              "documentMessage": {
                                                "url": "https://mmg.whatsapp.net/v/t62.7119-24/21583374_1294410024800880_1234675654224783648_n.enc?ccb=11-4&oh=01_AdQK_wZZVPotOJzA424DSRToRyBhVxp2gckG6nYJX69BrA&oe=64D37300&mms3=true",
                                                "mimetype": "application/pdf",
                                                "fileSha256": "NOw6/zCb33IZFUusxXGnejT2iNscny06BgMuirkSHNY=",
                                                "fileLength": "1985112",
                                                "pageCount": 9,
                                                "mediaKey": "ikja1LLePWQzb+hMjP9Zk4Bmf9wWceeImWZ1i8YpC30=",
                                                "fileName": "[ REAL ] WHATSAPP INBANÍVEL EM 3 HORAS.pdf",
                                                "fileEncSha256": "054tpGzSpTb8Sfz3WbkbtJEd8WpggEN5P5GRiWCNJww=",
                                                "directPath": "/v/t62.7119-24/21583374_1294410024800880_1234675654224783648_n.enc?ccb=11-4&oh=01_AdQK_wZZVPotOJzA424DSRToRyBhVxp2gckG6nYJX69BrA&oe=64D37300",
                                                "mediaKeyTimestamp": "1688999106",
                                                "thumbnailDirectPath": "/v/t62.36145-24/24267706_1315162849404562_9002310990058726372_n.enc?ccb=11-4&oh=01_AdQrhxNeSvh0CfHJygTsCuzHr1AzCab10Lc9nJ9XwPMEaw&oe=64D38FAE",
                                                "thumbnailSha256": "4rwcgRe+kzY4kqEZN8jS5hbZJ2gIwz1Oiq6GnUOljoc=",
                                                "thumbnailEncSha256": "Vkz+fW71U0S1/yNSvpAFJ10ulmo02fw8Sui2GYVz+WY=",
                                                "jpegThumbnail": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEABERERESERMVFRMaHBkcGiYjICAjJjoqLSotKjpYN0A3N0A3WE5fTUhNX06MbmJiboyiiIGIosWwsMX46/j///8BERERERIRExUVExocGRwaJiMgICMmOiotKi0qOlg3QDc3QDdYTl9NSE1fToxuYmJujKKIgYiixbCwxfjr+P/////CABEIAGAARAMBIgACEQEDEQH/xAAxAAADAAMBAQAAAAAAAAAAAAAABAYBAwcCBQEBAQEBAQAAAAAAAAAAAAAAAAECAwT/2gAMAwEAAhADEAAAAPuILzBR6J/TZTEyFNukw7OZJYiPrZSzya/dZGgVG0TtQGbBzlVN7ytocxa0K+OZj5zOK7CZJY34H35HPB8QGH8Ig95TF7ABr0xEzSytm1hLyP6FwY1eA7IBLDyfQvhpM5pcE1mjEnCjDoBga//EADcQAAEDAgIGCQMCBwEAAAAAAAEAAgMEEQUSBlFSkZKyExUWITE0QVNzNWJ0IoEQICMyRGFxof/aAAgBAQABPwDGMSqqLEKalhyWljBu5P0hxSnmnhbFA/oz3uyPT9IsWH+Ozhcu1WIbES7VYhsRLtViGxEu1WIe3EodKsSzm0UCp5DLBDIQAXxtcf3C0u+qUvwDmKklljkeWTvOY3LgSLo1FQQQZpLHx/Uf5qLyVL8LOVaXHLilP+MrFWKsf4WOpWKsVReSpfhZyrTEkYnTAC5NOphNA9zJYntcBcjUumJF8rrKN75iQxpJAuUaKuuQad1wNYQpK1zsogcT/wBCNDXi16Z+8J7zG8se1zXA2IKovJUvws5Vpk15xSkLPEQBSzYg6pfOD0b3geC6bEg4/wBV1yFDHV07i6M2JFlFX1kbA0xAkG5KdXVTvGEeKkrK91hGAyxN/VSsqZZOklN3Ki8lS/CzlWlpIxSn/GHMUXTHvc29tZKzu2V0h1LOVmdrKzHWUSSO8qi8lS/CzlWlNM+oxOEMI8qOYrq2p2411bU7ca6rqduNHCqnbiXVlTtxrqyp240/DahrHOLo7AEqi8lS/CzlWlbCcRiIeW2pRzFZ5PcfxFZ5PcfxFZ5PcfxFZ5PcfxFZ5PcfxFZ5PcfxFF77G8j95VF5Kl+FnKtL/qcH4w5iunf9vCF0z+/+3v8AtC6eI+IdwtQmiHiHcLU6Z3eBbL/toRmeT4M4QnuLu828PQWVF5Kl+FnKtL/qUH4wQsfVu8IWNu9u8IuA9RvCzja/9Wdusb1nbrG9ZgVReSpfhZyrTD6jB+MrAat6/SB6ItB1b0ANY3qzfDu3hZRrbvCIFvRUXkqX4Wcqx/Cayvro5YLANhDF2cxbbHEV2bxXbHEUdGsUcLF44iuy+Ja27yuzGJfauzGJfYuy+Ja2KmYY6eBjvFsbWn9gv//EACARAAEDBAIDAAAAAAAAAAAAAAEAAhEDMFKREFEhQZL/2gAIAQIBAT8AtANjyTKhnZRp0+3fRQDQIE8EO9OCh+Q0ofkNKH5DVz//xAAkEQABAwEIAwEAAAAAAAAAAAABAAIREgMEECJRU2GSIDBBYv/aAAgBAwEBPwCDEyImPUQ6oQAsw+Kp3Ck4Pbbl2S0aBpCovW83qqLzut6qi87revhIUjCBooGij8hRwMP/2Q==",
                                                "thumbnailHeight": 480,
                                                "thumbnailWidth": 339
                                              },
                                              "messageContextInfo": {
                                                "deviceListMetadata": {
                                                  "senderKeyHash": "5NtBfGDpS10M5Q==",
                                                  "senderTimestamp": "1688993376",
                                                  "recipientKeyHash": "4vsArO2PIywtVA==",
                                                  "recipientTimestamp": "1688995880"
                                                },
                                                "deviceListMetadataVersion": 2
                                              }
                                            },
                                            "verifiedBizName": "Megaapi"
                                        }

📄Mensagens recebidas tipo localização (messageType: locationMessage)

                                    
                                        {
                                            "instance_key": "megaapi-rdtdgffbcmbfjgnbjfkbgfg",
                                            "jid": "[email protected]",
                                            "messageType": "locationMessage",
                                            "key": {
                                              "remoteJid": "[email protected]",
                                              "fromMe": false,
                                              "id": "F898EA4B2090B20B31A7355A57FA252A"
                                            },
                                            "messageTimestamp": 1688999857,
                                            "pushName": "Megaapi",
                                            "broadcast": false,
                                            "message": {
                                              "locationMessage": {
                                                "degreesLatitude": -15.7666614,
                                                "degreesLongitude": -48.2620458
                                              },
                                              "messageContextInfo": {
                                                "deviceListMetadata": {
                                                  "senderKeyHash": "5NtBfGDpS10M5Q==",
                                                  "senderTimestamp": "1688993376",
                                                  "recipientKeyHash": "4vsArO2PIywtVA==",
                                                  "recipientTimestamp": "1688995880"
                                                },
                                                "deviceListMetadataVersion": 2
                                              }
                                            },
                                            "verifiedBizName": "Megaapi"
                                          }

📄Mensagens recebidas tipo contato (messageType: contactMessage)

                                    
                                        {
                                            "instance_key": "megaapi-dgfyjuikhujsdrgfthjvum",
                                            "jid": "[email protected]",
                                            "messageType": "contactMessage",
                                            "key": {
                                              "remoteJid": "[email protected]",
                                              "fromMe": false,
                                              "id": "65DC5A8B44D117A791EF84855ED866B8"
                                            },
                                            "messageTimestamp": 1688999946,
                                            "pushName": "Megaapi",
                                            "broadcast": false,
                                            "message": {
                                              "contactMessage": {
                                                "displayName": "Mega Api - api integração com wpp",
                                                "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:wpp;Mega Api - api integração;com;;\nFN:Mega Api - api integração com wpp\nORG:Mega Api - api integração com wpp\nTITLE:\nitem1.TEL;waid=556181926137:+55 61 8192-6137\nitem1.X-ABLabel:Celular\nX-WA-BIZ-DESCRIPTION:A melhor api whatsapp do Brasil\nX-WA-BIZ-NAME:Mega Api - api integração com wpp\nEND:VCARD"
                                              },
                                              "messageContextInfo": {
                                                "deviceListMetadata": {
                                                  "senderKeyHash": "5NtBfGDpS10M5Q==",
                                                  "senderTimestamp": "1688993376",
                                                  "recipientKeyHash": "4vsArO2PIywtVA==",
                                                  "recipientTimestamp": "1688995880"
                                                },
                                                "deviceListMetadataVersion": 2
                                              }
                                            },
                                            "verifiedBizName": "Megaapi"
                                        }

📄Mensagens recebidas tipo sticker (messageType: stickerMessage)

                                    
                                        {
                                            "instance_key": "megaapi-sdfsjkrtgopsdjfkjhdfdfg",
                                            "jid": "[email protected]",
                                            "messageType": "stickerMessage",
                                            "key": {
                                              "remoteJid": "[email protected]",
                                              "fromMe": false,
                                              "id": "53A80274EFAEA9AA2DB3C0B127004574"
                                            },
                                            "messageTimestamp": 1689000108,
                                            "pushName": "Megaapi",
                                            "broadcast": false,
                                            "message": {
                                              "stickerMessage": {
                                                "url": "https://mmg.whatsapp.net/v/t62.15575-24/26455351_283992877528341_4267243168817038757_n.enc?ccb=11-4&oh=01_AdTIo26ZG06u-m7gOvYgZ2rzQTOzwGT7ofsKSGdiqZ2OaA&oe=64D39541&mms3=true",
                                                "fileSha256": "nkX+umCp5W00cOg2j9B0pUcSZEKPQmvhraKSX0pE72k=",
                                                "fileEncSha256": "Up8Z0NoHud0IDZH76UTlf50WsLpmc97DGvl92GDWIhU=",
                                                "mediaKey": "8uesIQkZYGLqSJxS+HUP7EpySM93Ghmk9yjOpUhAmrA=",
                                                "mimetype": "image/webp",
                                                "directPath": "/v/t62.15575-24/26455351_283992877528341_4267243168817038757_n.enc?ccb=11-4&oh=01_AdTIo26ZG06u-m7gOvYgZ2rzQTOzwGT7ofsKSGdiqZ2OaA&oe=64D39541",
                                                "fileLength": "493618",
                                                "mediaKeyTimestamp": "1657737199485",
                                                "firstFrameLength": 6114,
                                                "firstFrameSidecar": "hihAfjPuyHtzYw==",
                                                "isAnimated": true,
                                                "stickerSentTs": "1689000107648",
                                                "isAvatar": false
                                              },
                                              "messageContextInfo": {
                                                "deviceListMetadata": {
                                                  "senderKeyHash": "5NtBfGDpS10M5Q==",
                                                  "senderTimestamp": "1688993376",
                                                  "recipientKeyHash": "4vsArO2PIywtVA==",
                                                  "recipientTimestamp": "1688995880"
                                                },
                                                "deviceListMetadataVersion": 2
                                              }
                                            },
                                            "verifiedBizName": "Megaapi"
                                        }
📄Mensagens recebidas enquete, pedidos, catalogos ...(messageType: messageContextInfo) 
                                    
                                        {
                                            "instance_key": "megaapi-ksdhfjsdfsdfsdf",
                                            "jid": "[email protected]",
                                            "messageType": "messageContextInfo",
                                            "key": {
                                              "remoteJid": "[email protected]",
                                              "fromMe": false,
                                              "id": "93B9DA99E50EE89C9CC2E8FAB30551AD"
                                            },
                                            "messageTimestamp": 1689000322,
                                            "pushName": "Megaapi",
                                            "broadcast": false,
                                            "message": {
                                              "messageContextInfo": {
                                                "deviceListMetadata": {
                                                  "senderKeyHash": "5NtBfGDpS10M5Q==",
                                                  "senderTimestamp": "1688993376",
                                                  "recipientKeyHash": "4vsArO2PIywtVA==",
                                                  "recipientTimestamp": "1688995880"
                                                },
                                                "deviceListMetadataVersion": 2
                                              },
                                              "interactiveMessage": {
                                                "nativeFlowMessage": {
                                                  "buttons": [
                                                    {
                                                      "name": "review_order",
                                                      "buttonParamsJson": "{\"reference_id\":\"4MB04BD81Q0\",\"order\":{\"status\":\"canceled\"}}"
                                                    }
                                                  ],
                                                  "messageParamsJson": "{}"
                                                },
                                                "contextInfo": {
                                                  "stanzaId": "0B90675CF538A5889039E8EAAF04C9E2",
                                                  "participant": "[email protected]",
                                                  "quotedMessage": {
                                                    "interactiveMessage": {
                                                      "header": {
                                                        "title": "Tedte",
                                                        "subtitle": "Quantidade: 2"
                                                      },
                                                      "nativeFlowMessage": {
                                                        "buttons": [
                                                          {
                                                            "name": "review_and_pay",
                                                            "buttonParamsJson": "{\"currency\":\"BRL\",\"total_amount\":{\"value\":20000,\"offset\":100},\"reference_id\":\"4MB04BD81Q0\",\"type\":\"physical-goods\",\"order\":{\"status\":\"canceled\",\"subtotal\":{\"value\":20000,\"offset\":100},\"items\":[{\"retailer_id\":\"custom-item-4150ba95-1834-43cc-876b-be71cd4c1070\",\"name\":\"Tedte\",\"amount\":{\"value\":10000,\"offset\":100},\"quantity\":2}]}}"
                                                          }
                                                        ]
                                                      }
                                                    }
                                                  }
                                                }
                                              }
                                            },
                                            "verifiedBizName": "Megaapi"
                                          }

Buscar dados do webhook

Este método te permite verificar qual url esta salva no webhook

/webhook/{{instance_key}}

GET https://{{host}}/rest/webhook/{{instance_key}}

Header

KEY VALUE
Authorization Bearer {{token}}

Response

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
webhookUrl string URL do Webhook salvo na API
webhookEnabled boolean true - Ativado para receber os eventos
false - Desativado para receber os eventos

Exemplo de solicitação

Configurar webhook

Este método te permite verificar qual url esta salva no webhook

/webhook/{{instance_key}}/configWebhook

POST https://{{host}}/rest/webhook/{{instance_key}}/configWebhook

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
webhookUrl string URL do seu webhook
webhookEnabled boolean true - Ativado para receber os eventos
false - Desativado para receber os eventos

Response

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
webhookUrl string URL do Webhook salvo na API

Request Body

                                        
                                            {
                                                "messageData": {
                                                    "webhookUrl": "https://meuwebhook.com",
                                                    "webhookEnabled": true
                                                }
                                            }

Exemplo de solicitação

Configurar webhook utilizando painel Mega-api

1️⃣ - Acesse nosso painel, clique na opção MINHAS INSTANCIAS

lightbox

2️⃣ - Agora, clicando no botão DETALHES, você será redirecionado, para a tela com todos os detalhes da instância contratada

lightbox

3️⃣ - Clique no EDITAR, abrirá uma janela modal. Adicione a url do weu webhook, salve e pronto. Sua instância a partir de agora, começará a receber todos os eventos disparados pelo whatsapp

lightbox

MESSAGE CONTROLLER

Introdução

Inicialmente, é essencial compreender que as mensagens podem ser direcionadas a um contato individual, um grupo ou até mesmo a uma comunidade. Embora eu vá abordar mais detalhes sobre isso mais a frente, é crucial entender que, para o WhatsApp, tudo é considerado um chat - seja ele um contato individual, um grupo, uma comunidade, um canal entre outros.
Quando se trata de enviar mensagens, é necessário uma identificação do chat correspondente:

  1. ➡️ Para contatos individuais, usa-se o número de telefone do contato;
  2. ➡️ Nos grupos, o ID é formado pela combinação do número whatsapp do criador do grupo com um valor de data/hora em timestamp;
  3. ➡️ Para comunidade, o ID tambem é formado pelo whatsapp do criador do grupo com um valor de data/hora em timestamp.
Esses IDs do grupo podem ser obtidos por meio do método get/list groups. Importante mencionar sobre o ID de mensagem: é altamente recomendável que você armazene o (key.id) retornado pela resposta do whatsapp, como ilustrado no exemplo abaixo. Isso porque, se necessitar responder, marcar ou excluir uma mensagem específica, você precisará do (key.id) para realizar estas ações no método correspondente.

                                            
                                                {

                                                    "key": {
                                                        "remoteJid": "[email protected]",
                                                        "fromMe": false,
                                                        "id": "23DECC1FEB57D4A269C9C24D8C69E744" //O id para ser salvo
                                                    },
                                                }

Envio de Mensagens Textuais para Múltiplos Destinatários

Este endpoint é projetado para enviar uma mensagem de texto para uma lista de contatos. Ele executa um loop, enviando a mensagem para cada contato presente no array de destinatários especificado na solicitação. Você tem a liberdade de enriquecer suas mensagens com formatações de texto e emojis.

Para aprender a formatar textos conforme as diretrizes do WhatsApp, acesse este link.

Adicionalmente, a inserção de emojis pode agregar mais expressividade às suas mensagens. Se precisar de uma referência de emojis, visite este Emojiterra.

Quanto à inclusão de quebras de linha nas mensagens, o método pode variar conforme a plataforma e a linguagem de programação utilizada. Alguns dos formatos comuns incluem:

  • \n
  • \r
  • \r\n
  • %0a
  • \\n

/sendMessage/{{instance_key}}/textToMany

POST https://{{host}}/rest/sendMessage/{{instance_key}}/textToMany

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to array Lista de contatos que vão receber a mensagem
text string Mensagem que será enviada

Request Body

                                        
                                            {
                                                "messageData": {
                                                    "to": [
                                                        "[email protected]",
                                                        "[email protected]"
                                                    ],
                                                    "text": "Mensagem de Texto"
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
sent number Quantidade que foram enviadas
failed number Quantidade que deram falhas
jidFailed array Contatos que deram falhas
data array Lista dos contatos que receberam a mensagem enviada
remoteJid string Contato que recebeu a mensagem
formMe boolean true - Mensagem Enviada
false - Mensagem Recebida
id string ID da mensagem
text string Mensagem que foi enviada
messageTimestamp string Data e horário que foi feito o disparo (TIMESTAMP)

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Envio de Mensagens de Texto

Este endpoint é projetado para enviar uma mensagem de texto. Você tem a liberdade de enriquecer suas mensagens com formatações de texto e emojis.

Para aprender a formatar textos conforme as diretrizes do WhatsApp, acesse este link.

Adicionalmente, a inserção de emojis pode agregar mais expressividade às suas mensagens. Se precisar de uma referência de emojis, visite este Emojiterra.

Quanto à inclusão de quebras de linha nas mensagens, o método pode variar conforme a plataforma e a linguagem de programação utilizada. Alguns dos formatos comuns incluem:

  • \n
  • \r
  • \r\n
  • %0a
  • \\n

Exemplo

lightbox

/sendMessage/{{instance_key}}/text

POST https://{{host}}/rest/sendMessage/{{instance_key}}/text

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Contato que vai receber a mensagem
text string Mensagem que será enviada

Request Body

                                        
                                            {
                                                "messageData": {
                                                    "to": "[email protected]",
                                                    "text": "Mensagem de Texto"
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
remoteJid string Contato que recebeu a mensagem
formMe boolean true - Mensagem Enviada
false - Mensagem Recebida
id string ID da mensagem
text string Mensagem que foi enviada
messageTimestamp string Data e horário do disparo (TIMESTAMP)

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Mencionar contatos no envio de mensagem

Este endpoint foi especialmente desenvolvido para permitir o envio de mensagens de texto, com a funcionalidade adicional de mencionar contatos diretamente na mensagem. Esse recurso oferece uma forma distinta e eficaz de chamar a atenção do destinatário. Além disso, você possui total liberdade para realçar suas mensagens com formatações de texto variadas e o uso expressivo de emojis.

Para aprender a formatar textos conforme as diretrizes do WhatsApp, acesse este link.

Adicionalmente, a inserção de emojis pode agregar mais expressividade às suas mensagens. Se precisar de uma referência de emojis, visite este Emojiterra.

Quanto à inclusão de quebras de linha nas mensagens, o método pode variar conforme a plataforma e a linguagem de programação utilizada. Alguns dos formatos comuns incluem:

  • \n
  • \r
  • \r\n
  • %0a
  • \\n

/sendMessage/{{instance_key}}/textMentioned

POST https://{{host}}/rest/sendMessage/{{instance_key}}/textMentioned

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Contato que vai receber a mensagem
text string Mensagem que será enviada
mentions array Contato que será mencionado na mensagem (EX: [email protected] em caso de grupo [email protected])

Request Body

                                        
                                            {
                                                "messageData": {
                                                  "to": "[email protected]",
                                                  "text": "@551199999910 Testando...",
                                                  "mentions": [
                                                    "[email protected]"
                                                  ]
                                                }
                                              }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
remoteJid string Contato que recebeu a mensagem
formMe boolean true - Mensagem Enviada
false - Mensagem Recebida
id string ID da mensagem
text string Mensagem que foi enviada
mentionedJid array Contatos que foram mencionados na mensagem
messageTimestamp string Data e horário do disparo (TIMESTAMP)

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Envio de arquivos (URL)

Este método permite o envio de arquivos para seus chats de uma forma distinta:

  • Através de um Link: Caso o arquivo já esteja disponível online, você pode simplesmente enviar seu URL.
Quanto ao tamanho e aos formatos dos arquivos, as diretrizes do WhatsApp mudam com frequência. Por isso, é sempre uma boa prática consultar o site oficial do WhatsApp para as informações mais recentes. Encontre orientações detalhadas sobre tamanhos e formatos de arquivo aqui.

Exemplo

lightbox

/sendMessage/{{instance_key}}/mediaUrl

POST https://{{host}}/rest/sendMessage/{{instance_key}}/mediaUrl

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Contato que vai receber a mensagem
url string URL da mídia a ser enviada
fileName string Nome do arquivo
type string É o tipo de mídia a ser enviada (image - video - audio - ptt(audio formato gravado) - document)
caption string É a legenda da mídia a ser enviada (Funciona somente em imagem e vídeo)
mineType string MineTypes:
imagem = image/jpeg,
video = video/mp4,
ptt = audio/ogg; codecs=opus,
audio = audio/ogg; codecs=opus,
pdf = application/pdf,
xlsx = application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,
word = application/vnd.openxmlformats-officedocument.wordprocessingml.document,
php, bin, html = application/octet-stream,
sql = application/x-sql

Request Body

                                        
                                            {
                                                "messageData": {
                                                    "to": "[email protected]",
                                                    "url": "{link do arquivo}",
                                                    "fileName": "{nome_do_arquivo}.extensão",
                                                    "type": "{tipo}",
                                                    "caption": "{texto legenda}",
                                                    "mimeType": "{mimetype}"
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
remoteJid string Contato que recebeu a mensagem
formMe boolean true - Mensagem Enviada
false - Mensagem Recebida
id string ID da mensagem
url string Link do arquivo enviado
mimetype string MineType do arquivo enviado
mediaKey string Key do arquivo enviado
fileName string Nome do arquivo enviado
directPath string Path do arquivo enviado
mediaKeyTimestamp string Data e Hora do arquivo enviado
messageTimestamp string Data e Hora do arquivo enviado

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Envio de arquivos (URL) para Múltiplos Destinatários

Este método permite o envio de arquivo para uma lista de contatos. Ele executa um loop, enviando a mensagem para cada contato presente no array de destinatários especificado na solicitação de uma forma distinta:

  • Através de um Link: Caso o arquivo já esteja disponível online, você pode simplesmente enviar seu URL.
Quanto ao tamanho e aos formatos dos arquivos, as diretrizes do WhatsApp mudam com frequência. Por isso, é sempre uma boa prática consultar o site oficial do WhatsApp para as informações mais recentes. Encontre orientações detalhadas sobre tamanhos e formatos de arquivo aqui.

/sendMessage/{{instance_key}}/mediaUrlToMany

POST https://{{host}}/rest/sendMessage/{{instance_key}}/mediaUrlToMany

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to array Contatos que vão receber a mensagem
url string URL da mídia a ser enviada
fileName string Nome do arquivo
type string É o tipo de mídia a ser enviada (image - video - audio - document)
caption string É a legenda da mídia a ser enviada (Funciona somente em imagem e vídeo)
mineType string MineTypes:
imagem = image/jpeg,
video = video/mp4,
audio = audio/ogg; codecs=opus,
pdf = application/pdf,
xlsx = application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,
word = application/vnd.openxmlformats-officedocument.wordprocessingml.document,
php, bin, html = application/octet-stream,
sql = application/x-sql

Request Body

                                        
                                            {
                                                "messageData": {
                                                    "to": [
                                                        "[email protected]", "[email protected]"
                                                    ],
                                                    "url": "{link do arquivo}",
                                                    "fileName": "{nome_do_arquivo}.extensão",
                                                    "type": "{tipo do arquivo}",
                                                    "caption": "{texto legenda}",
                                                    "mimeType": "{mimetype}"
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
sent number Quantidade que foram enviadas
failed number Quantidade que deram falhas
jidFailed array Contatos que deram falhas
data array Lista dos contatos que receberam a mensagem enviada
remoteJid string Contato que recebeu a mensagem
formMe boolean true - Mensagem Enviada
false - Mensagem Recebida
id string ID da mensagem
text string Mensagem que foi enviada
messageTimestamp string Data e horário que foi feito o disparo (TIMESTAMP)

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Envio de arquivos (BASE64)

Este método permite o envio de arquivos para seus chats de uma forma distinta:

  • Utilizando Base64: Para esta opção, sua aplicação deve incluir uma funcionalidade para transformar a imagem em Base64. Uma boa maneira de verificar se a conversão foi bem-sucedida é copiar o código Base64 gerado e colá-lo na barra de endereços do navegador. Se a imagem for exibida corretamente, significa que a conversão foi efetiva. Se não, é sinal de que algo precisa ser ajustado. Lembre-se de adicionar 'data:{mimetype};base64,' antes do seu código Base64.
Para testar este método, você pode usar ferramentas online de conversão de imagens para Base64. Aqui estão alguns exemplos de conversores que você pode experimentar. Quanto ao tamanho e aos formatos dos arquivos, as diretrizes do WhatsApp mudam com frequência. Por isso, é sempre uma boa prática consultar o site oficial do WhatsApp para as informações mais recentes. Encontre orientações detalhadas sobre tamanhos e formatos de arquivo aqui.

Exemplo

lightbox

/sendMessage/{{instance_key}}/mediaBase64

POST https://{{host}}/rest/sendMessage/{{instance_key}}/mediaBase64

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Contato que vai receber a mensagem
base64 string Arquivo no formato base64 que vai ser enviado
fileName string Nome do arquivo
type string É o tipo de mídia a ser enviada (image - video - audio - ptt (audio formato gravado) - document)
caption string É a legenda da mídia a ser enviada (Funciona somente em imagem e vídeo)
mineType string MineTypes:
imagem = image/jpeg,
video = video/mp4,
audio = audio/ogg; codecs=opus,
ptt = audio/ogg; codecs=opus,
pdf = application/pdf,
xlsx = application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,
word = application/vnd.openxmlformats-officedocument.wordprocessingml.document,
php, bin, html = application/octet-stream,
sql = application/x-sql

Request Body

                                        
                                             {
												"messageData": {
													"to": "[email protected]",
													"base64": "data:application/pdf;base64,JVBERi0xLjcKJbXtrvsKNCAwIG9iago8PCAvTGV...",
													"fileName": "Boleto.pdf",
													"type": "document",
													"caption": "Segue o boleto",
													"mimeType": "application/pdf"
												}
											}

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
remoteJid string Contato que recebeu a mensagem
formMe boolean true - Mensagem Enviada
false - Mensagem Recebida
id string ID da mensagem
url string Link do arquivo enviado
mimetype string MineType do arquivo enviado
mediaKey string Key do arquivo enviado
fileName string Nome do arquivo enviado
directPath string Path do arquivo enviado
mediaKeyTimestamp string Data e Hora do arquivo enviado
messageTimestamp string Data e Hora do arquivo enviado

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Envio de localização

Método responsavel por enviar uma localização de endereço ao seus contatos

Exemplo

lightbox

/sendMessage/{{instance_key}}/location

POST https://{{host}}/rest/sendMessage/{{instance_key}}/location

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Contato que vai receber a mensagem
address string Endereço (Opcional)
caption string Legenda (Opcional)
latitude string Latitude
longitude string Longitude

Request Body

                                        
                                            {
                                                "messageData": {
                                                    "to": "[email protected]",
                                                    "address": "QD 04 Lote 25",
                                                    "caption": "Escola classe",
                                                    "latitude": 157470795,
                                                    "longitude": 482982315
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
remoteJid string Contato que recebeu a mensagem
formMe boolean true - Mensagem Enviada
false - Mensagem Recebida
id string ID do arquivo
degreesLatitude number Latitude enviada
degreesLongitude number Longitude enviada
name string Legenda que foi enviada
address string Endereço que foi enviado
messageTimestamp string Data e Hora do arquivo enviado

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Envio de lista de opções

Método responsavel por enviar uma mensagem de texto com uma lista de opções, onde o usuário seleciona umas das opções enviadas

Exemplo

lightbox
lightbox

/sendMessage/{{instance_key}}/listMessage

POST https://{{host}}/rest/sendMessage/{{instance_key}}/listMessage

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Contato whatsapp que vai receber a mensagem
buttonText string Título do botão
text string Mensagem
title string Título da mensagem
description string Descrição
sections array Lista de seções
rows array Lista de itens
rowId string ID do item

Request Body

                                        
                                            {
                                                "messageData": {
                                                    "to": "[email protected]",
                                                    "buttonText": "Escolha",
                                                    "text": "Testanto",
                                                    "title": "TEste",
                                                    "description": "Selecione uma forma de pagamento",
                                                    "sections": [
                                                        {
                                                            "title": "PIX",
                                                            "rows": [
                                                                {
                                                                    "title": "PIX",
                                                                    "description": "pagamento via pix",
                                                                    "rowId": "01"
                                                                }
                                                            ]
                                                        },
                                                        {
                                                            "title": "CARTÃO",
                                                            "rows": [
                                                                {
                                                                    "title": "Cartão de Crédito",
                                                                    "description": "pagamento por cartão de crédito",
                                                                    "rowId": "01"
                                                                }
                                                            ]
                                                        }
                                                    ],
                                                    "listType": 0
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
remoteJid string Contato que recebeu a mensagem
fromMe boolean Indica se a mensagem foi enviada (true) ou recebida (false)
id string ID da mensagem
title string Título
description string Descrição
buttonText string Titulo do botão
listType string Tipo da lista enviada
sections array Lista todos os itens que foram criados dentro da sessão
footerText string Texto do rodapé
messageTimestamp string Data e Hora do arquivo enviado

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Envio de lista de opções para Múltiplos Destinatários

Método responsável por enviar uma lista de opções para múltiplos destinatários, onde cada destinatário pode selecionar uma das opções enviadas.

Exemplo

lightbox
lightbox

/sendMessage/{{instance_key}}/listMessageToMany

POST https://{{host}}/rest/sendMessage/{{instance_key}}/listMessageToMany

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to array Contatos whatsapp que vão receber a mensagem
buttonText string Título do botão
text string Mensagem
title string Título da mensagem
description string Descrição
sections array Lista de seções
rows array Lista de itens
rowId string ID do item

Request Body

                                        
                                            {
                                                "messageData": {
                                                    "to": ["[email protected]", "[email protected]"],
                                                    "buttonText": "Escolha",
                                                    "text": "Testanto",
                                                    "title": "TEste",
                                                    "description": "Selecione uma forma de pagamento",
                                                    "sections": [
                                                        {
                                                            "title": "PIX",
                                                            "rows": [
                                                                {
                                                                    "title": "PIX",
                                                                    "description": "pagamento via pix",
                                                                    "rowId": "01"
                                                                }
                                                            ]
                                                        },
                                                        {
                                                            "title": "CARTÃO",
                                                            "rows": [
                                                                {
                                                                    "title": "Cartão de Crédito",
                                                                    "description": "pagamento por cartão de crédito",
                                                                    "rowId": "01"
                                                                }
                                                            ]
                                                        }
                                                    ],
                                                    "listType": 0
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
sent numer Quantidade que foram enviadas
failed number Quantidade que deram falhas
jidFailed array Contatos que deram falhas
data array Lista dos contatos que receberam a mensagem enviada
remoteJid array Contato que recebeu a mensagem
fromMe boolean Indica se a mensagem foi enviada (true) ou recebida (false)
id string ID da mensagem
title string Título
description string Descrição
buttonText string Titulo do botão
listType string Tipo da lista enviada
sections array Lista todos os itens que foram criados dentro da sessão
footerText string Texto do rodapé
messageTimestamp string Data e Hora do arquivo enviado

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Enviar contato

Este procedimento direto possibilita o envio de informações de um contato através do preenchimento dos campos necessários no método. Não é requerido que o contato esteja previamente salvo na sua lista, apenas insira os detalhes necessários e proceda com o envio.

Exemplo

lightbox

/sendMessage/{{instance_key}}/contactMessage

POST https://{{host}}/rest/sendMessage/{{instance_key}}/contactMessage

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Contato que vai receber a mensagem
fullName string Nome do contato
displayName string Nome do contato que irá aparecer no card
organization string Nome da empresa ou nome do contato
phoneNumber string Telefone do contato que você quer compartilhar(DDI DDD Número Ex: 551199999999)

Request Body

                                        
                                            {
                                                "messageData": {
                                                  "to": "[email protected]",
                                                  "vcard": {
                                                    "fullName": "Megaapi Whats",
                                                    "displayName": "Megaapi Whats",
                                                    "organization": "Megaapi",
                                                    "phoneNumber": "551199999999"
                                                  }
                                                }
                                              }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
remoteJid string Contato que recebeu a mensagem
formMe boolean true - Mensagem Enviada
false - Mensagem Recebida
id string ID da mensagem
displayName string Nome do contato
vcard string Card
messageTimestamp string Data e horário do disparo (TIMESTAMP)

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Reencaminhar mensagem

Este método permite que as mensagens sejam retransmitidas via API. Você só precisa das informações que estão na chave key do payload de retorno do webhook , e das informações que estão dentro da chave message do payload do webhook.

Onde encontro essas informações Key e Message?

É importante destacar que as informações necessárias para utilizar este endpoint, especificamente os valores da chave 'key' e 'message', são obtidos através do payload de retorno fornecido pelo webhook para as mensagens recebidas. Para realizar o reencaminhamento de mensagens pelo WhatsApp, você deverá recuperar esses dados diretamente do webhook, pois eles contêm os elementos essenciais que permitem à plataforma identificar e processar o pedido de retransmissão de forma adequada.

Exemplo de onde localizar os dados da chave key

lightbox

Exemplo de onde localizar os dados da chave message

lightbox

Exemplo

lightbox

/sendMessage/{{instance_key}}/forwardMessage

POST https://{{host}}/rest/sendMessage/{{instance_key}}/forwardMessage

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Contato que vai receber a mensagem
key object Objeto que contem as informações necessárias para reencaminhar a mensagem
message object Objeto que contem as informações necessárias para reencaminhar a mensagem

Request Body

                                        
                                            {
                                                "messageData": {
                                                  "to": "[email protected]",
                                                  "key": {object},
                                                  "message": {object}
                                                }
                                              }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
remoteJid string Contato que recebeu a mensagem
formMe boolean true - Mensagem Enviada
false - Mensagem Recebida
id string ID da mensagem
text string Mensagem que foi enviada
messageTimestamp string Data e horário do disparo (TIMESTAMP)

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Responder mensagem

O recurso de "Responder Mensagem" da API oferece uma forma interativa de comunicação no seu chat do WhatsApp. Ao utilizar este método, é possível enviar uma resposta direta a uma mensagem específica. Tudo o que você precisa é da identificação única da mensagem original, que pode ser encontrada no campo 'message' do payload do webhook, e do identificador do chat, presente no campo 'key'. Com esses dados, a API organiza a sua resposta como uma citação da mensagem original, proporcionando um contexto claro para a continuidade da conversa.

Onde encontro essas informações Key e Message?

É importante destacar que as informações necessárias para utilizar este endpoint, especificamente os valores da chave 'key' e 'message', são obtidos através do payload de retorno fornecido pelo webhook para as mensagens recebidas. Para realizar o reencaminhamento de mensagens pelo WhatsApp, você deverá recuperar esses dados diretamente do webhook, pois eles contêm os elementos essenciais que permitem à plataforma identificar e processar o pedido de retransmissão de forma adequada.

Exemplo de onde localizar os dados da chave key

lightbox

Exemplo de onde localizar os dados da chave message

lightbox

Exemplo

lightbox

/sendMessage/{{instance_key}}/quoteMessage

POST https://{{host}}/rest/sendMessage/{{instance_key}}/quoteMessage

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Contato que vai receber a mensagem
text string Mensagem
key object Objeto que contem as informações necessárias para responder a mensagem
message object Objeto que contem as informações necessárias para responder a mensagem

Request Body

                                        
                                            {
                                                "messageData": {
                                                  "to": "[email protected]",
                                                  "text": "Mensagem",
                                                  "key": {},
                                                  "message": {}
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
remoteJid string Contato que recebeu a mensagem
formMe boolean true - Mensagem Enviada
false - Mensagem Recebida
id string ID da mensagem
text string Mensagem que foi enviada
messageTimestamp string Data e horário do disparo (TIMESTAMP)

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

CHAT CONTROLLER

Introdução

Nesta seção, exploraremos os diversos métodos disponíveis para coletar informações sobre os seus chats, permitindo uma gestão mais eficiente e detalhada dessas conversas.












Digitando - Gravando Áudio - Online

Esse método é responsavel em simular os eventos do whatsapp, como Digitando... | Gravando Áudio | Online | Visto por último as ...

/chat/{{instance_key}}/presenceUpdateChat

POST https://{{host}}/rest/chat/{{instance_key}}/presenceUpdateChat

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Contato Whatsapp
options string Eventos:
  • composing - Digitando...
  • recording - Gravando áudio...
  • available - Online
  • unavailable - Visto por último hoje às ...

Request Body

                                        
                                            {
                                                "to": "[email protected]",
                                                "option": "composing"
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Arquivar chat

Esse método é responsavel em arquivar ou desarquivar um chat whatsapp

/chat/{{instance_key}}/archiveChat

POST https://{{host}}/rest/chat/{{instance_key}}/archiveChat

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Contato Whatsapp
options boolean Opções:
  • true - Para arquivar o chat
  • false - Para desarquivar um chat

Request Body

                                        
                                            {
                                                "to": "[email protected]",
                                                "option": true
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Fixar conversa

Esse método é responsavel em fixar ou desafixar um chat whatsapp

/chat/{{instance_key}}/pinChat

POST https://{{host}}/rest/chat/{{instance_key}}/pinChat

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Contato Whatsapp
options boolean Opções:
  • true - Para fixar o chat
  • false - Para desafixar um chat

Request Body

                                        
                                            {
                                                "to": "[email protected]",
                                                "options": true
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Bloquear contato

Esse método é responsavel em bloquear e desbloquear um contato whatsapp

/chat/{{instance_key}}/blockChat

POST https://{{host}}/rest/chat/{{instance_key}}/blockChat

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Contato Whatsapp
options boolean Opções:
  • true - Bloqueia o contato
  • false - Desbloqueia ocontato

Request Body

                                        
                                            {
                                                "to": "[email protected]",
                                                "option": true
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Confirmar leitura da mensagen

Este método permite confirmar a leitura de uma mensagem de um chat. Você só precisa das informações que estão na chave key do payload de retorno do webhook .

Onde encontro essas informações Key?

É importante destacar que as informações necessárias para utilizar este endpoint, especificamente os valores da chave 'key', são obtidos através do payload de retorno fornecido pelo webhook para as mensagens recebidas. Para realizar a confirmação de leitura das mensagens do WhatsApp, você deverá recuperar esses dados diretamente do webhook, pois eles contêm os elementos essenciais que permitem à plataforma identificar e processar o pedido de confirmação de forma adequada.

Exemplo de onde localizar os dados da chave key

lightbox

Exemplo

lightbox

/sendMessage/{{instance_key}}/readMessage

POST https://{{host}}/rest/sendMessage/{{instance_key}}/readMessage

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
key object Objeto que contem as informações necessárias para confirmar a leitura das mensagens

Request Body

                                        
                                            {
                                                "messageData": {
                                                  "key": {object}
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Confirmar leitura de todas as mensagens do chat

Este método permite confirmar a leitura de todas as mensagens de um chat. Você só precisa das informações que estão na chave key do payload de retorno do webhook .. Você só precisa das informações que estão na chave key do payload de retorno do webhook , e da informação que estão dentro da chave messageTimestamp do payload do webhook.

Onde encontro essas informações key e messageTimestamp?

É importante destacar que as informações necessárias para utilizar este endpoint, especificamente os valores da chave 'key' e 'messageTimestamp', são obtidos através do payload de retorno fornecido pelo webhook para as mensagens recebidas. Para realizar a confirmação das mensagens pelo WhatsApp, você deverá recuperar esses dados diretamente do webhook, pois eles contêm os elementos essenciais que permitem à plataforma identificar e processar o pedido de confirmação de forma adequada.

Exemplo de onde localizar os dados da chave key

lightbox

Exemplo de onde localizar os dados da chave messageTimestamp

lightbox

Exemplo

lightbox

/sendMessage/{{instance_key}}/readChat

POST https://{{host}}/rest/sendMessage/{{instance_key}}/readChat

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Contato do chat que deseja confirmar a visualização das mensagens
option boolean true - confirmar; false - não confirmar
key string Objeto key. Coletado do retorno do webhook para confirmar a leitura da mensagem.
messageTimestamp number Data/Hora da última mensagem. Valor coletado do retorno do webhook.

Request Body

                                        
                                            {
                                                "to": "[email protected]",
                                                "option": true,
                                                "messageData": {
                                                    "key": {object},
                                                    "messageTimestamp": 0
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Deletar mensagem

Este método permite deletar uma mensagem de um chat. Você só precisa das informações que estão na chave key do payload de retorno do webhook .

Onde encontro essas informações Key?

É importante destacar que as informações necessárias para utilizar este endpoint, especificamente os valores da chave 'key', são obtidos através do payload de retorno fornecido pelo webhook para as mensagens recebidas. Para deletar as mensagens do WhatsApp, você deverá recuperar esses dados diretamente do webhook, pois eles contêm os elementos essenciais que permitem à plataforma identificar e processar o pedido de deletar de forma adequada.

Exemplo de onde localizar os dados da chave key

lightbox

Exemplo

lightbox

/chat/{{instance_key}}/deleteMessage

POST https://{{host}}/rest/chat/{{instance_key}}/deleteMessage

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Contato do chat que deseja deletar uma mensagem
key object Objeto que contem as informações necessárias para deletar a mensagen whatsapp

Request Body

                                        
                                            {
                                                "messageData": {
                                                  "to": "[email protected]",
                                                  "key": {}
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
remoteJid string Contato que recebeu a mensagem
formMe boolean true - Mensagem Enviada
false - Mensagem Recebida
id string ID da mensagem
text string Mensagem que foi enviada
messageTimestamp string Data e horário do disparo (TIMESTAMP)

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

GROUP CONTROLLER

Introdução

Esta seção é dedicada a explorar a variedade de métodos disponíveis para a gestão de grupos no WhatsApp.


Assim como em chats individuais, as mensagens enviadas e recebidas em grupos seguem o mesmo princípio. Cada grupo é identificado por um ID único, geralmente uma combinação do número do criador do grupo e uma data no formato em timestamp, algo como '5511999999999-162327528'. Esse ID específico é o que você usará como referência para enviar mensagens aos grupos. Para obter esse ID, você pode usar o método 'list groups'.


Além disso, nesta seção, você também encontrará informações e procedimentos para criar e gerenciar grupos, oferecendo um controle mais amplo sobre suas interações de grupo no WhatsApp.












Listar todos os grupos

Este método te permite listar todos os grupos.

/group/list/{{instance_key}}

GET https://{{host}}/rest/group/list/{{instance_key}}

Header

KEY VALUE
Authorization Bearer {{token}}

Response

Atributos Tipo Descrição
status boolean Status da requisição
message string Mensagem de retorno
groups array Todos os grupos cadastrados
communitys array Todas as comunidades criadas

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Administrador dos grupos

Este método te permite listar todos os grupos em que seu whatsapp está como administrador

/group/{{instance_key}}/adminGroups

GET https://{{host}}/rest/group/{{instance_key}}/adminGroups

Header

KEY VALUE
Authorization Bearer {{token}}

Response

Atributos Tipo Descrição
status boolean Status da requisição
message string Mensagem de retorno
groups array Todos os grupos cadastrados
communitys array Todas as comunidades criadas

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Detalhe do grupo

Este método retorna todas as informações do grupo e de seus participantes

/group/{{instance_key}}/group/?jid={{id_group}}

GET https://{{host}}/rest/group/{{instance_key}}/group/?jid={{id_group}}

Header

KEY VALUE
Authorization Bearer {{token}}

Resquest Params

Atributos Tipo Descrição
jid string ID do grupo

Response

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno
id string ID do grupo
subject string Nome do Grupo
creation number Data e Hora que o grupo foi criado (TIMESTAMP)
owner string Contato que criou o grupo
restrict boolean true - Somente Admin podem fazer alterações; false - Todos os participantes podem fazer alterações
announce boolean true - Somente Admin podem enviar mensagens; false - Todos os participantes podem enviar mensagens
participants array Lista com todos os contatos dos usuários que estão participando do grupo
id string Contato whatsapp
admin string null - Não é administrador; admin - Contato é um administrador do grupo

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Código do grupo

Este método retorna o codigo do grupo, utilizado para montar o link de compartilhamento do grupo

/group/{{instance_key}}/groupInviteCode?group_id={{id_group}}

GET https://{{host}}/rest/group/{{instance_key}}/groupInviteCode?group_id={{id_group}}

Header

KEY VALUE
Authorization Bearer {{token}}

Resquest Params

Atributos Tipo Descrição
group_id string ID do grupo

Response

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno
inviteCode string Código de convite do grupo

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Envio de Mensagens de Texto

Este endpoint é projetado para enviar uma mensagem de texto. Você tem a liberdade de enriquecer suas mensagens com formatações de texto e emojis.

Para aprender a formatar textos conforme as diretrizes do WhatsApp, acesse este link.

Adicionalmente, a inserção de emojis pode agregar mais expressividade às suas mensagens. Se precisar de uma referência de emojis, visite este Emojiterra.

Quanto à inclusão de quebras de linha nas mensagens, o método pode variar conforme a plataforma e a linguagem de programação utilizada. Alguns dos formatos comuns incluem:

  • \n
  • \r
  • \r\n
  • %0a
  • \\n

Exemplo

lightbox

/sendMessage/{{instance_key}}/text

POST https://{{host}}/rest/sendMessage/{{instance_key}}/text

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Grupo que vai receber a mensagem
text string Mensagem que será enviada

Request Body

                                        
                                            {
                                                "messageData": {
                                                    "to": "[email protected]",
                                                    "text": "Mensagem de Texto"
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
remoteJid string Contato que recebeu a mensagem
formMe boolean true - Mensagem Enviada
false - Mensagem Recebida
id string ID da mensagem
text string Mensagem que foi enviada
messageTimestamp string Data e horário do disparo (TIMESTAMP)

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Envio de arquivos (URL)

Este método permite o envio de arquivos para seus chats de uma forma distinta:

  • Através de um Link: Caso o arquivo já esteja disponível online, você pode simplesmente enviar seu URL.
Quanto ao tamanho e aos formatos dos arquivos, as diretrizes do WhatsApp mudam com frequência. Por isso, é sempre uma boa prática consultar o site oficial do WhatsApp para as informações mais recentes. Encontre orientações detalhadas sobre tamanhos e formatos de arquivo aqui.

Exemplo

lightbox

/sendMessage/{{instance_key}}/mediaUrl

POST https://{{host}}/rest/sendMessage/{{instance_key}}/mediaUrl

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Grupo que vai receber a mensagem
url string URL da mídia a ser enviada
fileName string Nome do arquivo
type string É o tipo de mídia a ser enviada (image - video - audio - document)
caption string É a legenda da mídia a ser enviada (Funciona somente em imagem e vídeo)
mineType string MineTypes:
imagem = image/jpeg,
video = video/mp4,
audio = audio/ogg; codecs=opus,
pdf = application/pdf,
xlsx = application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,
word = application/vnd.openxmlformats-officedocument.wordprocessingml.document,
php, bin, html = application/octet-stream,
sql = application/x-sql

Request Body

                                        
                                            {
                                                "messageData": {
                                                    "to": "[email protected]",
                                                    "url": "{link do arquivo}",
                                                    "fileName": "{nome_do_arquivo}.extensão",
                                                    "type": "{tipo}",
                                                    "caption": "{texto legenda}",
                                                    "mimeType": "{mimetype}"
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
remoteJid string Grupo que recebeu a mensagem
formMe boolean true - Mensagem Enviada
false - Mensagem Recebida
id string ID da mensagem
url string Link do arquivo enviado
mimetype string MineType do arquivo enviado
mediaKey string Key do arquivo enviado
fileName string Nome do arquivo enviado
directPath string Path do arquivo enviado
mediaKeyTimestamp string Data e Hora do arquivo enviado
messageTimestamp string Data e Hora do arquivo enviado

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Envio de arquivos (BASE64)

Este método permite o envio de arquivos para seus chats de uma forma distinta:

  • Utilizando Base64: Para esta opção, sua aplicação deve incluir uma funcionalidade para transformar a imagem em Base64. Uma boa maneira de verificar se a conversão foi bem-sucedida é copiar o código Base64 gerado e colá-lo na barra de endereços do navegador. Se a imagem for exibida corretamente, significa que a conversão foi efetiva. Se não, é sinal de que algo precisa ser ajustado. Lembre-se de adicionar 'data:{mimetype};base64,' antes do seu código Base64.
Para testar este método, você pode usar ferramentas online de conversão de imagens para Base64. Aqui estão alguns exemplos de conversores que você pode experimentar. Quanto ao tamanho e aos formatos dos arquivos, as diretrizes do WhatsApp mudam com frequência. Por isso, é sempre uma boa prática consultar o site oficial do WhatsApp para as informações mais recentes. Encontre orientações detalhadas sobre tamanhos e formatos de arquivo aqui.

Exemplo

lightbox

/sendMessage/{{instance_key}}/mediaBase64

POST https://{{host}}/rest/sendMessage/{{instance_key}}/mediaBase64

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
to string Contato que vai receber a mensagem
base64 string Arquivo no formato base64 que vai ser enviado
fileName string Nome do arquivo
type string É o tipo de mídia a ser enviada (image - video - audio - document)
caption string É a legenda da mídia a ser enviada (Funciona somente em imagem e vídeo)
mineType string MineTypes:
imagem = image/jpeg,
video = video/mp4,
audio = audio/ogg; codecs=opus,
pdf = application/pdf,
xlsx = application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,
word = application/vnd.openxmlformats-officedocument.wordprocessingml.document,
php, bin, html = application/octet-stream,
sql = application/x-sql

Request Body

                                        
                                            {
                                                "messageData": {
                                                    "to": "[email protected]",
                                                    "base64": "{arquivo base64}",
                                                    "fileName": "{nome_do_arquivo}.extensão",
                                                    "type": "{tipo}",
                                                    "caption": "{texto legenda}",
                                                    "mimeType": "{mimetype}"
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno da requisição
remoteJid string Contato que recebeu a mensagem
formMe boolean true - Mensagem Enviada
false - Mensagem Recebida
id string ID da mensagem
url string Link do arquivo enviado
mimetype string MineType do arquivo enviado
mediaKey string Key do arquivo enviado
fileName string Nome do arquivo enviado
directPath string Path do arquivo enviado
mediaKeyTimestamp string Data e Hora do arquivo enviado
messageTimestamp string Data e Hora do arquivo enviado

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Criar grupo

Utilize este procedimento para iniciar um novo grupo, incluindo os participantes desejados.

/group/{{instance_key}}/create

POST https://{{host}}/rest/group/{{instance_key}}/create

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
group_name string Nome do Grupo
participants array Lista de contatos que serão adicionados no grupo ( EX: [email protected] )

Request Body

                                        
                                            {
                                                "group_data": {
                                                  "group_name": "Nome do Grupo",
                                                  "participants": [
                                                    "[email protected]"
                                                  ]
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno
id string ID do grupo
subject string Nome do grupo
creation number Data e Hora que o grupo foi criado
owner string Contato do criador do grupo
restrict boolean true - Somente Admin podem fazer alterações
false - Todos os participantes podem fazer alterações
announce boolean true - Somente Admin podem enviar mensagens
false - Todos os participantes podem enviar mensagens
participants array Lista com os participantes que foram adicionados
id string Contato whatsapp
admin string null - Não é administrador
superadmin - Contato é um administrador do grupo

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Adicionar participantes no grupo

Utilize este procedimento para adicionar novos participantes no grupo

/group/{{instance_key}}/addParticipants

POST https://{{host}}/rest/group/{{instance_key}}/addParticipants

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
jid string ID do grupo
participants array Lista de contatos que serão adicionados no grupo ( EX: [email protected] )

Request Body

                                        
                                            {
                                                "group_data": {
                                                    "jid": "[email protected]",
                                                    "participants": [
                                                        "[email protected]"
                                                    ]
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno
updatedParticipants array Lista de contatos que foram adicionados no grupo

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Sem autorização para adicionar esse contato no grupo

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Remover participantes no grupo

Utilize este procedimento para remover participantes no grupo

/group/{{instance_key}}/removeParticipants

POST https://{{host}}/rest/group/{{instance_key}}/removeParticipants

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
jid string ID do grupo
participants array Lista de contatos que serão removidos do grupo ( EX: [email protected] )

Request Body

                                        
                                            {
                                                "group_data": {
                                                    "jid": "[email protected]",
                                                    "participants": [
                                                        "[email protected]"
                                                    ]
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno
updatedParticipants array Lista de contatos que foram removidos do grupo

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Remover administrador do grupo

Utilize este procedimento para remover um ou mais administradores do grupo

/group/{{instance_key}}/demoteParticipants

POST https://{{host}}/rest/group/{{instance_key}}/demoteParticipants

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
jid string ID do grupo
participants array Lista de contatos que serão rebaixados administradores do grupo ( EX: [email protected] )

Request Body

                                        
                                            {
                                                "group_data": {
                                                    "jid": "[email protected]",
                                                    "participants": [
                                                        "[email protected]"
                                                    ]
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno
updatedParticipants array Lista de contatos que não são mais administradores do grupo

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Promover administrador do grupo

Utilize este procedimento para promover um ou mais administradores do grupo

/group/{{instance_key}}/promoteParticipants

POST https://{{host}}/rest/group/{{instance_key}}/promoteParticipants

Header

KEY VALUE
Authorization Bearer {{token}}

Atributos

Atributos Tipo Descrição
jid string ID do grupo
participants array Lista de contatos que serão promovidos á administradores do grupo ( EX: [email protected] )

Request Body

                                        
                                            {
                                                "group_data": {
                                                    "jid": "[email protected]",
                                                    "participants": [
                                                        "[email protected]"
                                                    ]
                                                }
                                            }

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno
updatedParticipants array Lista de contatos que serão promovidos á administradores do grupo

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Configurações do grupo

Abaixo vamos listar todos os métodos que permite configurar as preferências do grupo

setWhoCanSendMessage

Esse método define quem poderá enviar mensagens no grupo

/group/{{instance_key}}/setWhoCanSendMessage?jid={{id_group}}&allowOnlyAdmins=false

PUT https://{{host}}/rest/group/{{instance_key}}/setWhoCanSendMessage?jid={{id_group}}&allowOnlyAdmins=false

Header

KEY VALUE
Authorization Bearer {{token}}

Request Params

Atributos Tipo Descrição
jid string ID do grupo
allowOnlyAdmins boolean true - Somente admin envia mensagem no grupo false - Participantes podem enviar mensagens no grupo

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

setWhoCanChangeSettings

Esse método define quem poderá alterar as configurações do grupo

/group/{{instance_key}}/setWhoCanChangeSettings?jid={{id_group}}&allowOnlyAdmins=false

PUT https://{{host}}/rest/group/{{instance_key}}/setWhoCanChangeSettings?jid={{id_group}}&allowOnlyAdmins=false

Header

KEY VALUE
Authorization Bearer {{token}}

Request Params

Atributos Tipo Descrição
jid string ID do grupo
allowOnlyAdmins boolean true - Somente admin pode alterar as configurações do grupo false - Participantes podem alterar as configurações do grupo

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação

Sair do Grupo

Este método permite que você saia do grupo

/group/{{instance_key}}/leaveGroup?jid={{id_group}}

DELETE https://{{host}}/rest/group/{{instance_key}}/leaveGroup?jid={{id_group}}

Header

KEY VALUE
Authorization Bearer {{token}}

Request Params

Atributos Tipo Descrição
jid string ID do grupo

Response 200

Atributos Tipo Descrição
error boolean Status do retorno
message string Mensagem do retorno

Response 401

Instância não esta conectada ao Whatsapp

Response 403

Número do whatsapp não existe

Response 500

Alguma informação enviada incorretamente ou serviços do whatsapp instáveis

Exemplo de solicitação