API para gerenciamento de instâncias do WhatsApp. Esta API permite a criação, atualização, remoção e gerenciamento de instâncias do WhatsApp. Utiliza o padrão RESTful e JSON para comunicação. Todas as requisições devem ser autenticadas com um token de usuário. Para obter um token de usuário, é necessário se registrar na API e obter um token de acesso junto aos desenvolvedores. Para mais informações, consulte a documentação da API ou entre em contato.
Desenvolvido por edgvi10 (edgvi10@gmail.com)
Retorna o status da API
No query
No body
{
"status": "OK"
}
Retorna a documentação da API
No headers
No query
No body
Retorna a lista de instâncias
No body
{
"instances": [
{
"instanceKey": "string",
"name": "string",
"useWebhook": "true|false",
"webhookUrl": "string",
"ignoreGroups": "true|false",
"blockCalls": "true|false",
"blockMedia": "true|false",
"createdAt": "string",
"updatedAt": "string"
}
]
}
Cria uma nova instância
No query
{
"error": false,
"message": "Instância iniciada",
"instance": {
"key": "string",
"userToken": "string",
"name": "string",
"qrcode": "string",
"qrcode_url": "string",
"useWebhook": "true|false",
"webhookUrl": "true|false",
"ignoreGroups": "true|false",
"blockAudio": "true|false",
"blockImages": "true|false",
"blockVideos": "true|false",
"blockDocuments": "true|false",
"blockCalls": "true|false",
"blockCallsMessage": "",
"createdAt": "2024-04-26T19:51:01.073Z"
}
}
{
"error": true,
"message": "Instância já existe"
}
Retorna os detalhes de uma instância
No query
No body
{
"instance": {
"instanceKey": "string",
"name": "string",
"useWebhook": "true|false",
"webhookUrl": "string",
"ignoreGroups": "true|false",
"blockCalls": "true|false",
"blockMedia": "true|false",
"createdAt": "string",
"updatedAt": "string"
}
}
Atualiza os detalhes de uma instância
No query
{
"error": false,
"message": "Instância atualizada"
}
{
"error": true,
"message": "Instância não encontrada"
}
{
"error": true,
"message": "Erro ao atualizar instância"
}
{
"error": true,
"message": "Acesso não autorizado"
}
Retorna o QRCode de uma instância para autenticação no WhatsApp
No query
No body
{
"qrcode": "base64string"
}
Desconecta uma instância do WhatsApp
No query
No body
{
"error": false,
"message": "Instância desconectada"
}
{
"error": true,
"message": "Instância não encontrada"
}
Remove uma instância permanentemente
No query
No body
{
"error": false,
"message": "Instância removida"
}
{
"error": true,
"message": "Instância não encontrada"
}
Envia uma mensagem para um contato ou grupo
No query
{
"error": false,
"message": "Mensagem enviada",
"messageId": "string",
"messageData": "object"
}
{
"error": true,
"message": "Erro ao enviar mensagem"
}
Envia imagem, vídeo, áudio ou documento para um contato ou grupo
No query
{
"error": false,
"message": "Mídia enviada",
"messageId": "string",
"messageData": "object"
}
{
"error": true,
"message": "Erro ao enviar mídia"
}
Envia uma mensagem com botões de opções para um contato ou grupo
No query