UAZAPI SDK

SDK completo para integrar com a API UAZAPI.
Disponível em PHP e JavaScript — sem dependências externas.

🐘

PHP SDK

Classe única, sem composer obrigatório. Funciona com PHP 7.4+

⚡

JavaScript SDK

ESM + CommonJS. Funciona no browser e no Node.js 18+

🎮

Playground

Teste qualquer endpoint diretamente nesta página

📦

Instalação

PHP

Opção 1 — Download direto:

require 'Uazapi.php';

Opção 2 — Composer:

composer require tectonny/uazapi

require 'Uazapi.php';
use Tectonny\Uazapi\Uazapi;

$api = new Uazapi(
    baseUrl:    'https://tectonny.uazapi.com',
    token:      'SEU_TOKEN',
    adminToken: 'ADMIN_TOKEN'
);

$status = $api->instanceStatus();
echo $status['data']['instance']['name'];

JavaScript

npm:

npm install @tectonny/uazapi

Browser / CDN:

import Uazapi from '@tectonny/uazapi'

const api = new Uazapi({
  baseUrl:    'https://tectonny.uazapi.com',
  token:      'SEU_TOKEN',
  adminToken: 'ADMIN_TOKEN'
})

const status = await api.instanceStatus()
console.log(status.data.instance.name)

🎮

Playground

BASE URL

TOKEN DA INSTÂNCIA

ADMIN TOKEN

MÉTODO

ENDPOINT

Usar Admin Token

PAYLOAD (JSON)

PRONTO

RESPOSTA

// Aguardando execução...

🔌

Instância

GET instanceStatus /instance/status

Retorna status, nome do perfil, foto, número conectado e informações gerais da instância.

$api->instanceStatus()

const r = await api.instanceStatus()
console.log(r.data.instance.name)

POST instanceConnect /instance/connect

Inicia conexão e gera QR Code. Use GET /instance/status para pegar o QR.

$api->instanceConnect()

await api.instanceConnect()

{}

POST instanceDisconnect /instance/disconnect

Desconecta a instância do WhatsApp.

$api->instanceDisconnect()

await api.instanceDisconnect()

{}

POST instanceUpdateName /instance/updateInstanceName

Atualiza o nome exibido da instância no painel.

Parâmetro	Tipo	Obrigatório	Descrição
`name`	string	● Sim	Novo nome da instância

$api->instanceUpdateName('Minha Instância')

await api.instanceUpdateName('Minha Instância')

{
    "name": "Minha Instância"
}

GET instanceGetSettings /instance/settings

Retorna configurações como reject_call, msg_call, delay_min, delay_max.

$api->instanceGetSettings()

await api.instanceGetSettings()

PUT instanceSaveSettings /instance/settings

Salva configurações de comportamento da instância.

$api->instanceSaveSettings(['reject_call' => true, 'msg_call' => 'Não posso atender'])

await api.instanceSaveSettings({ reject_call: true, msg_call: 'Não posso atender' })

{
    "reject_call": true,
    "msg_call": "Não posso atender agora"
}

📤

Envio

POST sendText /send/text

Envia uma mensagem de texto simples para um número ou grupo.

Parâmetro	Tipo	Obrigatório	Descrição
`number`	string	● Sim	Número com DDI. Ex: 5511999998888
`text`	string	● Sim	Texto da mensagem
`delay`	number	Não	Delay em ms antes de enviar

$api->sendText('5511999998888', 'Olá! Testando SDK 🚀')

await api.sendText('5511999998888', 'Olá! Testando SDK 🚀')

{
    "number": "5511999998888",
    "text": "Olá! Testando SDK 🚀"
}

POST sendImage /send/media

Envia uma imagem por URL ou base64.

Parâmetro	Tipo	Obrigatório	Descrição
`number`	string	● Sim	Número destinatário
`file`	string	● Sim	URL pública ou base64 da imagem
`caption`	string	Não	Legenda da imagem

$api->sendImage('5511999998888', 'https://exemplo.com/img.jpg', 'Descrição')

await api.sendImage('5511999998888', 'https://exemplo.com/img.jpg', 'Descrição')

{
    "number": "5511999998888",
    "type": "image",
    "file": "https:\/\/exemplo.com\/img.jpg",
    "caption": "Descrição"
}

POST sendAudio /send/media

Envia áudio. Com ptt:true aparece como mensagem de voz no WhatsApp.

$api->sendAudio('5511999998888', 'https://exemplo.com/audio.mp3', true)

await api.sendAudio('5511999998888', 'https://exemplo.com/audio.mp3', true)

{
    "number": "5511999998888",
    "type": "audio",
    "file": "https:\/\/exemplo.com\/audio.mp3",
    "ptt": true
}

POST sendDocument /send/media

Envia documento (PDF, DOCX, etc) com nome personalizado.

$api->sendDocument('5511999998888', 'https://exemplo.com/doc.pdf', 'Proposta.pdf')

await api.sendDocument('5511999998888', 'https://exemplo.com/doc.pdf', 'Proposta.pdf')

{
    "number": "5511999998888",
    "type": "document",
    "file": "https:\/\/exemplo.com\/doc.pdf",
    "docName": "Proposta.pdf"
}

POST sendLocation /send/location

Envia localização com nome e endereço.

$api->sendLocation('5511999998888', -23.564, -46.654, 'Escritório', 'Av. Paulista, 1000')

await api.sendLocation('5511999998888', -23.564, -46.654, 'Escritório', 'Av. Paulista, 1000')

{
    "number": "5511999998888",
    "latitude": -23.564,
    "longitude": -46.654,
    "name": "Escritório",
    "address": "Av. Paulista, 1000"
}

POST sendList /send/menu

Envia lista interativa. Choices no formato "Texto|id" ou "[Seção]" para cabeçalhos.

$api->sendList('5511999998888', 'Selecione:', ['[Atendimento]','Suporte|sup','Vendas|ven'])

await api.sendList('5511999998888', 'Selecione:', ['[Atendimento]','Suporte|sup','Vendas|ven'])

{
    "number": "5511999998888",
    "type": "list",
    "text": "Selecione:",
    "buttonText": "Ver Menu",
    "choices": [
        "[Atendimento]",
        "Suporte|sup",
        "Vendas|ven"
    ]
}

POST sendButtons /send/menu

Envia botões interativos (máx. 3 botões).

$api->sendButtons('5511999998888', 'Confirma?', ['Sim|yes','Não|no'])

await api.sendButtons('5511999998888', 'Confirma?', ['Sim|yes','Não|no'])

{
    "number": "5511999998888",
    "type": "button",
    "text": "Confirma?",
    "choices": [
        "Sim|yes",
        "Não|no"
    ]
}

POST sendPoll /send/menu

Envia enquete nativa do WhatsApp.

$api->sendPoll('5511999998888', 'Qual o melhor?', ['Opção A','Opção B','Opção C'])

await api.sendPoll('5511999998888', 'Qual o melhor?', ['Opção A','Opção B','Opção C'])

{
    "number": "5511999998888",
    "type": "poll",
    "text": "Qual o melhor?",
    "choices": [
        "Opção A",
        "Opção B",
        "Opção C"
    ],
    "selectableCount": 1
}

🔔

Webhook

GET webhookGet /webhook

Retorna a configuração atual do webhook: URL, status, eventos ativos e filtros.

$api->webhookGet()

await api.webhookGet()

POST webhookSet /webhook

Configura o webhook. excludeMessages filtra eventos antes de disparar.

Parâmetro	Tipo	Obrigatório	Descrição
`url`	string	● Sim	URL do seu endpoint
`enabled`	boolean	● Sim	Ativar ou desativar
`events`	array	Não	messages, connection, groups, call, history, labels, chats, contacts, presence, chat_labels, blocks, leads, sender
`excludeMessages`	array	Não	wasSentByApi, wasNotSentByApi, fromMeYes, fromMeNo, isGroupYes, isGroupNo

$api->webhookSet('https://meu-sistema.com/webhook', true, ['messages','connection'], ['wasSentByApi'])

await api.webhookSet('https://meu-sistema.com/webhook', true, ['messages','connection'], ['wasSentByApi'])

{
    "url": "https:\/\/meu-sistema.com\/webhook",
    "enabled": true,
    "events": [
        "messages",
        "connection",
        "groups"
    ],
    "excludeMessages": [
        "wasSentByApi",
        "isGroupYes"
    ]
}

👥

Grupos

GET groupList /group/list

Lista todos os grupos da instância.

$api->groupList()

await api.groupList()

POST groupInfo /group/info

Retorna participantes, admins e metadados de um grupo.

$api->groupInfo('120363000000000000@g.us')

await api.groupInfo('120363000000000000@g.us')

{
    "groupId": "120363000000000000@g.us"
}

🏷️

Labels

👤

Perfil

POST profileSetName /profile/name

Altera o nome do perfil do WhatsApp.

$api->profileSetName('Meu Atendimento')

await api.profileSetName('Meu Atendimento')

{
    "name": "Meu Atendimento"
}

POST profileSetImage /profile/image

Altera a foto do perfil. Aceita URL pública ou base64 JPEG.

$api->profileSetImage('https://exemplo.com/foto.jpg')

await api.profileSetImage('https://exemplo.com/foto.jpg')

{
    "image": "https:\/\/exemplo.com\/foto.jpg"
}

📢

Campanhas

GET senderListFolders /sender/listfolders

Lista as campanhas de disparo com status, progresso e contadores.

$api->senderListFolders()

await api.senderListFolders()

POST senderEdit /sender/edit

Pausa, retoma ou cancela uma campanha de disparo.

Parâmetro	Tipo	Obrigatório	Descrição
`folder_id`	string	● Sim	ID da pasta/campanha
`action`	string	● Sim	pause \| resume \| cancel

$api->senderEdit('abc123', 'pause')

await api.senderEdit('abc123', 'pause')

{
    "folder_id": "abc123",
    "action": "pause"
}

🤖

Agentes IA

📚

Conhecimento

⚡

Triggers

💬

Respostas Rápidas

GET quickReplyList /quickreply/showall

Lista todas as respostas rápidas cadastradas.

$api->quickReplyList()

await api.quickReplyList()

📞

Chamadas

💼

UAZAPI SDK

PHP SDK

JavaScript SDK

Playground

Instalação

Playground

Instância

Envio

Webhook

Grupos

Labels

Perfil

Campanhas

Agentes IA

Conhecimento

Triggers

Respostas Rápidas

Chamadas

Chatwoot