v1.0
📄 Documentação
📋 Exemplos de código
🔑 Chaves de API
🔐
Como autenticar: Clique em Authorize (cadeado 🔒 no topo da documentação abaixo), cole sua chave de API e clique em Authorize. Depois é só usar o botão Execute em cada endpoint.
Gerar minha chave →

Exemplos de código

Substitua SUA_CHAVE pela chave gerada na aba Chaves de API e 5511988887777 pelo número WhatsApp remetente (com DDI+DDD, só dígitos) — é o número que aparece como remetente para o destinatário.

O campo phone é obrigatório em todo envio — é o número de origem, quem vai enviar. Ele é procurado só nas contas liberadas para a chave; conta que a chave não cobre responde 403.

POST /api/keys/nova
Criar chave — uma chamada só

Manda e-mail e senha do painel e o nome da chave. O servidor entra, descobre as suas empresas e devolve a chave pronta. A chave crua vem no campo key e só aparece nessa resposta — aqui fica guardado apenas o sha256 dela.

Mais de uma empresa? Sem dizer qual, a resposta é 400 com a lista das suas — é só repetir escolhendo. Para uma chave que valha para todas, mande "todas": true.

curl -X POST https://api.iazis.com.br/api/keys/nova \
  -H "Content-Type: application/json" \
  -d '{
    "email": "SEU_EMAIL",
    "password": "SUA_SENHA",
    "name": "integracao n8n"
  }'

# valendo para TODAS as suas empresas
curl -X POST https://api.iazis.com.br/api/keys/nova \
  -H "Content-Type: application/json" \
  -d '{
    "email": "SEU_EMAIL",
    "password": "SUA_SENHA",
    "name": "integracao geral",
    "todas": true
  }'

# que também LÊ os dados (uma empresa só; dono, admin ou gestor)
curl -X POST https://api.iazis.com.br/api/keys/nova \
  -H "Content-Type: application/json" \
  -d '{
    "email": "SEU_EMAIL",
    "password": "SUA_SENHA",
    "name": "integracao crm",
    "ler": true
  }'
const res = await fetch('https://api.iazis.com.br/api/keys/nova', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    email: 'SEU_EMAIL',
    password: 'SUA_SENHA',
    name: 'integracao n8n',
    // todas: true,     // uma chave para todas as suas empresas
    // tenant: 'devs',  // ou escolha uma pelo nome
    // ler: true,       // também lê os dados (uma empresa só)
  }),
});

const data = await res.json();
console.log(data.key); // guarde agora: não aparece de novo
import requests

res = requests.post(
    "https://api.iazis.com.br/api/keys/nova",
    json={
        "email": "SEU_EMAIL",
        "password": "SUA_SENHA",
        "name": "integracao n8n",
        # "todas": True,     # uma chave para todas as suas empresas
        # "tenant": "devs",  # ou escolha uma pelo nome
        # "ler": True,       # também lê os dados (uma empresa só)
    },
)

print(res.json()["key"])  # guarde agora: nao aparece de novo
{
  "id": "0f2c...",
  "name": "integracao n8n",
  "key": "sk_IA_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "key_prefix": "sk_IA_xxxxx...",
  "instance_name": null,
  "is_sandbox": false,
  "tenant": { "id": "2cdf67e3-...", "name": "devs" },
  "created_at": "2026-09-24T12:00:00.000Z"
}
// HTTP 401 — e-mail ou senha errados
{ "ok": false, "error": "E-mail ou senha inválidos" }

// HTTP 400 — você tem mais de uma empresa e não disse qual.
// A resposta já traz a lista: repita escolhendo uma.
{
  "ok": false,
  "error": "Você tem mais de uma empresa — repita a chamada com 'tenant_id' ou 'tenant'",
  "tenants": [
    { "id": "2cdf67e3-...", "name": "devs" },
    { "id": "46c01e07-...", "name": "IA boost" }
  ]
}

// HTTP 409 — já existe chave com esse nome
{ "ok": false, "error": "Já existe uma chave com o nome \"integracao n8n\"" }

O número de origem não entra aqui — ele é obrigatório em cada envio, no campo phone.

Quem já tem um token de sessão pode usar POST /api/keys com Authorization: Bearer <token> — mesmos campos, sem e-mail e senha.

POST /v1/messages/send
Enviar mensagem de texto
curl -X POST https://api.iazis.com.br/v1/messages/send \
  -H "Content-Type: application/json" \
  -H "x-api-key: SUA_CHAVE" \
  -d '{
    "phone": "5511988887777",
    "to": "5511999998888",
    "text": "Olá! Seu pedido foi confirmado. 🎉"
  }'

# "phone" é o número de origem — obrigatório em todo envio.
const response = await fetch('https://api.iazis.com.br/v1/messages/send', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'SUA_CHAVE'
  },
  body: JSON.stringify({
    phone: '5511988887777',
    to: '5511999998888',
    text: 'Olá! Seu pedido foi confirmado. 🎉'
  })
});

const data = await response.json();
console.log(data);
// { ok: true, messageId: '3EB0ABC123DEF456', timestamp: 1721743200 }
import requests

response = requests.post(
    'https://api.iazis.com.br/v1/messages/send',
    headers={
        'Content-Type': 'application/json',
        'x-api-key': 'SUA_CHAVE'
    },
    json={
        'phone': '5511988887777',
        'to': '5511999998888',
        'text': 'Olá! Seu pedido foi confirmado. 🎉'
    }
)

data = response.json()
print(data)
# {'ok': True, 'messageId': '3EB0ABC123DEF456', 'timestamp': 1721743200}
{
  "ok": true,
  "messageId": "3EB0ABC123DEF456",
  "timestamp": 1721743200
}
// HTTP 422 — aparelho fora do ar
{
  "ok": false,
  "error": "Instância desconectada — reconecte no painel"
}

// HTTP 400 — faltou o número de origem
{
  "ok": false,
  "error": "Campo 'phone' é obrigatório — informe o número de origem que vai enviar"
}

// HTTP 400 — chave de várias contas e o mesmo número em mais de uma
{
  "ok": false,
  "error": "Esse número existe em mais de uma conta sua — informe 'tenant_id' ou 'tenant'",
  "tenants": [
    { "id": "2cdf67e3-...", "name": "devs" },
    { "id": "46c01e07-...", "name": "IA boost" }
  ]
}

// HTTP 403 — conta que esta chave não cobre
{
  "ok": false,
  "error": "Esta chave não está liberada para essa conta"
}
GET /v1/messages/{messageId}/status
Consultar status de entrega
curl https://api.iazis.com.br/v1/messages/3EB0ABC123DEF456/status \
  -H "x-api-key: SUA_CHAVE"
const messageId = '3EB0ABC123DEF456'; // ID retornado no envio

const response = await fetch(
  `https://api.iazis.com.br/v1/messages/${messageId}/status`,
  { headers: { 'x-api-key': 'SUA_CHAVE' } }
);

const data = await response.json();
console.log(data.status);
// 'sent' | 'delivered' | 'read' | 'error'
if (data.error) console.log(data.error.code, data.error.hint || data.error.message);
import requests

message_id = '3EB0ABC123DEF456'  # ID retornado no envio

response = requests.get(
    f'https://api.iazis.com.br/v1/messages/{message_id}/status',
    headers={ 'x-api-key': 'SUA_CHAVE' }
)

data = response.json()
print(data['status'])
# 'sent' | 'delivered' | 'read' | 'error'
if data.get('error'):
    print(data['error']['code'], data['error']['hint'] or data['error']['message'])
{
  "ok": true,
  "messageId": "3EB0ABC123DEF456",
  "status": "delivered",
  "statusCode": 2,
  "to": "5511999998888",
  "type": "text",
  "sentAt": "2026-07-23T15:30:00Z",
  "updatedAt": "2026-07-23T15:30:05Z",
  "error": null
}

// Quando falha, "error" diz o motivo:
{
  "ok": true,
  "messageId": "wamid.HBgMNTUxMTk5OTk5ODg4OBUCABEYEjU4…",
  "status": "error",
  "statusCode": 0,
  "to": "5511999998888",
  "type": "error",
  "sentAt": "2026-10-23T19:53:55Z",
  "updatedAt": "2026-10-23T19:53:57Z",
  "error": {
    "code": 131047,
    "message": "Message failed to send because more than 24 hours have passed since the customer last replied to this number.",
    "hint": "Mais de 24 h desde a última mensagem do cliente — fora da janela, só modelo (template) aprovado."
  }
}
// HTTP 404 — messageId não encontrado (não existe ou é de outra conta)
{
  "ok": false,
  "error": "Mensagem não encontrada"
}
POST /v1/messages/media
Enviar imagem / documento / áudio / vídeo
curl -X POST https://api.iazis.com.br/v1/messages/media \
  -H "Content-Type: application/json" \
  -H "x-api-key: SUA_CHAVE" \
  -d '{
    "phone": "5511988887777",
    "to": "5511999998888",
    "mediaType": "image",
    "mediaUrl": "https://exemplo.com/foto.jpg",
    "caption": "Confira nossa proposta!"
  }'
const response = await fetch('https://api.iazis.com.br/v1/messages/media', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'SUA_CHAVE'
  },
  body: JSON.stringify({
    phone: '5511988887777',
    to: '5511999998888',
    mediaType: 'document',        // image | video | audio | document
    mediaUrl: 'https://exemplo.com/contrato.pdf',
    caption: 'Seu contrato para assinatura',
    fileName: 'contrato.pdf'      // opcional, recomendado para documentos
  })
});

const data = await response.json();
console.log(data);
import requests

response = requests.post(
    'https://api.iazis.com.br/v1/messages/media',
    headers={
        'Content-Type': 'application/json',
        'x-api-key': 'SUA_CHAVE'
    },
    json={
        'phone': '5511988887777',
        'to': '5511999998888',
        'mediaType': 'image',   # image | video | audio | document
        'mediaUrl': 'https://exemplo.com/foto.jpg',
        'caption': 'Confira nossa proposta!'
    }
)

print(response.json())
{
  "ok": true,
  "messageId": "3EB0XYZ987654321",
  "timestamp": 1721743260
}
⚠️ Atenção: o campo mediaUrl deve ser uma URL HTTPS pública — não aceita base64, paths locais nem URLs internas (ex: localhost).

Leitura de dados

Para integrar o seu sistema (CRM, ERP, BI). Use uma chave criada com "Pode ler dados" — ela lê a empresa dela, então nenhuma chamada precisa de id de empresa. As listas vêm em páginas: data + next_cursor (repita com cursor= até vir null). Para buscar só o que mudou, use updated_since. Limite: 120 leituras por minuto por chave.

GET /v1/chats
Listar conversas (contatos e grupos)

Filtros: device (aparelho), type (contact | group), status (open | pending | resolved), phone, updated_since e limit (até 200). Uma conversa entra em updated_since quando muda (status, atendente, etiqueta) ou quando chega/sai mensagem.

# primeira página
curl "https://api.iazis.com.br/v1/chats?limit=100" \
  -H "x-api-key: SUA_CHAVE"

# só o que mudou desde a última sincronização
curl "https://api.iazis.com.br/v1/chats?updated_since=2026-10-23T00:00:00Z&limit=100" \
  -H "x-api-key: SUA_CHAVE"

# próxima página: repita com o next_cursor da resposta
curl "https://api.iazis.com.br/v1/chats?limit=100&cursor=NEXT_CURSOR" \
  -H "x-api-key: SUA_CHAVE"
// Puxa todas as conversas alteradas desde a última sincronização.
async function sincronizarConversas(desde) {
  const todas = [];
  let cursor = null;
  do {
    const url = new URL('https://api.iazis.com.br/v1/chats');
    url.searchParams.set('limit', '200');
    if (desde) url.searchParams.set('updated_since', desde);
    if (cursor) url.searchParams.set('cursor', cursor);

    const res = await fetch(url, { headers: { 'x-api-key': 'SUA_CHAVE' } });
    if (res.status === 429) {                       // limite por minuto
      const espera = Number(res.headers.get('Retry-After') || 30);
      await new Promise((r) => setTimeout(r, espera * 1000));
      continue;
    }
    const pagina = await res.json();
    if (!pagina.ok) throw new Error(pagina.error);
    todas.push(...pagina.data);
    cursor = pagina.next_cursor;
  } while (cursor);
  return todas;
}

const conversas = await sincronizarConversas('2026-10-23T00:00:00Z');
console.log(conversas.length, conversas[0]?.id);
import time
import requests

def sincronizar_conversas(desde=None):
    todas, cursor = [], None
    while True:
        params = {'limit': 200}
        if desde:
            params['updated_since'] = desde
        if cursor:
            params['cursor'] = cursor
        res = requests.get('https://api.iazis.com.br/v1/chats',
                           headers={'x-api-key': 'SUA_CHAVE'}, params=params)
        if res.status_code == 429:  # limite por minuto
            time.sleep(int(res.headers.get('Retry-After', 30)))
            continue
        pagina = res.json()
        todas += pagina['data']
        cursor = pagina['next_cursor']
        if not cursor:
            return todas

conversas = sincronizar_conversas('2026-10-23T00:00:00Z')
print(len(conversas))
{
  "ok": true,
  "data": [
    {
      "id": "Comercial::5511999998888@s.whatsapp.net",
      "lead_id": "0ff83435-2a60-4b38-b0e5-ef2e0ef40137",
      "device": "Comercial",
      "jid": "5511999998888@s.whatsapp.net",
      "phone": "5511999998888",
      "name": "Maria Souza",
      "is_group": false,
      "status": "open",
      "ticket_open": true,
      "attendant": { "id": "4c1e…", "name": "João" },
      "assigned_at": "2026-10-23T14:02:10Z",
      "department_id": null,
      "tags": ["cliente-ativo"],
      "customer_id": null,
      "last_message_at": "2026-10-23T14:05:00Z",
      "created_at": "2026-09-02T11:20:00Z",
      "updated_at": "2026-10-23T14:02:10Z"
    }
  ],
  "next_cursor": "eyJ2IjoiMjAyNi0xMC0yM1QxNDowMjoxMFoiLCJpIjoiMGZmOC4uLiJ9"
}
// HTTP 403 — chave sem permissão de leitura
{
  "ok": false,
  "error": "Esta chave não tem permissão de leitura — crie uma chave com 'Pode ler dados'"
}

// HTTP 429 — passou de 120 leituras no minuto (header Retry-After: 34)
{
  "ok": false,
  "error": "Limite de 120 leituras por minuto atingido — tente de novo em 34s"
}
GET /v1/chats/{id}/messages
Mensagens de uma conversa

O {id} é o id da conversa (aparelho::jid, codificado na URL) ou o lead_id. Padrão: da mais nova para a mais antiga. Para buscar só as novas, use since + order=asc.

# pelo lead_id (mais simples)
curl "https://api.iazis.com.br/v1/chats/0ff83435-2a60-4b38-b0e5-ef2e0ef40137/messages?limit=50" \
  -H "x-api-key: SUA_CHAVE"

# pelo id da conversa (aparelho::jid codificado)
curl "https://api.iazis.com.br/v1/chats/Comercial%3A%3A5511999998888%40s.whatsapp.net/messages?since=2026-10-23T00:00:00Z&order=asc" \
  -H "x-api-key: SUA_CHAVE"
const chatId = 'Comercial::5511999998888@s.whatsapp.net'; // "id" de /v1/chats

const res = await fetch(
  `https://api.iazis.com.br/v1/chats/${encodeURIComponent(chatId)}/messages?limit=50`,
  { headers: { 'x-api-key': 'SUA_CHAVE' } }
);
const { data, next_cursor } = await res.json();
for (const m of data) {
  console.log(m.created_at, m.direction, m.text ?? m.caption ?? m.type);
}
// mensagens mais antigas: repita com &cursor=${next_cursor}
from urllib.parse import quote
import requests

chat_id = 'Comercial::5511999998888@s.whatsapp.net'  # "id" de /v1/chats

res = requests.get(
    f'https://api.iazis.com.br/v1/chats/{quote(chat_id, safe="")}/messages',
    headers={'x-api-key': 'SUA_CHAVE'},
    params={'since': '2026-10-23T00:00:00Z', 'order': 'asc', 'limit': 200},
)
for m in res.json()['data']:
    print(m['created_at'], m['direction'], m['text'] or m['type'])
{
  "ok": true,
  "chat_id": "Comercial::5511999998888@s.whatsapp.net",
  "data": [
    {
      "id": "3EB05098589D6856E35B",
      "direction": "outgoing",
      "type": "text",
      "text": "Seu pedido saiu para entrega 🚚",
      "caption": null,
      "media_url": null,
      "status": "read",
      "sender_name": "João",
      "reply_to": null,
      "deleted": false,
      "scheduled": null,
      "source": "api",
      "created_at": "2026-10-23T14:05:00Z"
    },
    {
      "id": "AC82F1D0E5B4C3A2",
      "direction": "incoming",
      "type": "image",
      "text": null,
      "caption": "segue o comprovante",
      "media_url": "https://…/comprovante.jpg",
      "status": null,
      "sender_name": "Maria Souza",
      "reply_to": null,
      "deleted": false,
      "scheduled": null,
      "source": null,
      "created_at": "2026-10-23T14:01:00Z"
    }
  ],
  "next_cursor": null
}
// HTTP 404 — conversa não existe nesta empresa
{
  "ok": false,
  "error": "Conversa não encontrada nesta empresa"
}
GET /v1/devices · /v1/groups · /v1/contacts · /v1/customers
Aparelhos, grupos, contatos do CRM e clientes

Mesma paginação (limit, cursor, updated_since) — menos /v1/devices, que vem inteiro. Buscas: /v1/groups?device=, /v1/contacts?phone= ou email=, /v1/customers?phone=, email= ou document= (CPF/CNPJ).

# aparelhos da empresa (o "id" serve para o campo phone do envio)
curl "https://api.iazis.com.br/v1/devices" -H "x-api-key: SUA_CHAVE"

# grupos
curl "https://api.iazis.com.br/v1/groups?limit=100" -H "x-api-key: SUA_CHAVE"

# contato do CRM pelo telefone
curl "https://api.iazis.com.br/v1/contacts?phone=5511999998888" -H "x-api-key: SUA_CHAVE"

# clientes alterados desde ontem
curl "https://api.iazis.com.br/v1/customers?updated_since=2026-10-22T00:00:00Z" -H "x-api-key: SUA_CHAVE"
const ler = (rota) =>
  fetch(`https://api.iazis.com.br${rota}`, { headers: { 'x-api-key': 'SUA_CHAVE' } })
    .then((r) => r.json());

const aparelhos = await ler('/v1/devices');
const grupos    = await ler('/v1/groups?limit=100');
const contato   = await ler('/v1/contacts?phone=5511999998888');
const clientes  = await ler('/v1/customers?document=12345678000199');

console.log(aparelhos.data.map((d) => `${d.name} (${d.type})`));
import requests

def ler(rota, **params):
    return requests.get(f'https://api.iazis.com.br{rota}',
                        headers={'x-api-key': 'SUA_CHAVE'}, params=params).json()

aparelhos = ler('/v1/devices')
grupos    = ler('/v1/groups', limit=100)
contato   = ler('/v1/contacts', phone='5511999998888')
clientes  = ler('/v1/customers', updated_since='2026-10-22T00:00:00Z')

for d in aparelhos['data']:
    print(d['name'], d['type'], d['status'])
// GET /v1/devices
{
  "ok": true,
  "data": [
    { "id": "Comercial", "name": "Comercial", "phone": "5511988887777",
      "type": "web", "status": "connected", "created_at": "2026-04-07T23:52:11Z" },
    { "id": "cloud_api_1318410598018482", "name": "Atendimento", "phone": "5511977776666",
      "type": "official", "status": "connected", "created_at": "2026-05-02T10:00:00Z" }
  ]
}

// GET /v1/groups
{
  "ok": true,
  "data": [
    { "id": "307afb06-…", "chat_id": "Comercial::120363408852011571@g.us",
      "device": "Comercial", "jid": "120363408852011571@g.us", "name": "Clientes VIP",
      "participants": 87, "is_admin": true, "is_community": false,
      "invite_link": "https://chat.whatsapp.com/…", "last_message_at": "2026-10-23T13:40:00Z" }
  ],
  "next_cursor": null
}

// GET /v1/contacts
{
  "ok": true,
  "data": [
    { "id": "000c50e3-…", "name": "Maria Souza", "phone": "5511999998888",
      "email": "maria@exemplo.com", "company": "Loja X", "tags": ["vip"],
      "stage": "lead", "source": "whatsapp", "updated_at": "2026-10-20T09:12:00Z" }
  ],
  "next_cursor": null
}

// GET /v1/customers
{
  "ok": true,
  "data": [
    { "id": "b2c6e75e-…", "name": "Carlos Savi", "legal_name": "Trilha Carreiras LTDA",
      "email": "carlos@exemplo.com", "phone": "5511989658431", "document": "12345678000199",
      "document_type": "CNPJ", "status": "ativo",
      "address": { "city": "São Paulo", "state": "SP" }, "updated_at": "2026-10-22T18:00:00Z" }
  ],
  "next_cursor": null
}

Chaves de API

Gerencie as chaves de acesso à IAZIS Messaging REST API. Cada chave é mostrada apenas uma vez no momento da criação.

Entrar na conta

Use o mesmo email e senha do painel IAZIS.