WAZGO PUBLIC API · V1
API Reference
Referência gerada do OpenAPI servido pela API. Contrato 1.0.0 · 3.1.0.
As operações abaixo pertencem ao workspace da API Key. A API não aceita um workspaceId para trocar de tenant.
/meConsultar contexto da chave e do workspace Escopo: workspace:read.
Retorna somente o workspace determinado pela API Key, o plano/status resumido e os limites de instâncias, grupos, campanhas e membros.
Exemplo de resposta
{
"data": {
"workspace": {
"id": "00000000-0000-4000-8000-000000000010",
"name": "Minha operação"
},
"apiKey": {
"id": "00000000-0000-4000-8000-000000000011",
"prefix": "wzb_live_ab12cd34",
"scopes": [
"workspace:read"
],
"expiresAt": null
},
"plan": {
"name": "Plano configurado",
"status": "ACTIVE",
"access": {
"allowed": true,
"reason": null,
"until": null
}
},
"usage": {
"instances": {
"used": 1,
"limit": 2
},
"groups": {
"used": 4,
"limit": 20
},
"campaigns": {
"used": 1,
"limit": 10
},
"teamMembers": {
"used": 2,
"limit": 5
}
}
}
}Exemplo de chamada
curl -X GET "$WAZGO_API_BASE/me" \
-H "Authorization: Bearer $WAZGO_API_KEY"/usageConsultar uso e limites Escopo: usage:read.
Retorna os contadores reais disponíveis para o workspace vinculado à chave.
Exemplo de resposta
{
"data": {
"workspaceId": "00000000-0000-4000-8000-000000000010",
"resources": {
"instances": {
"used": 1,
"limit": 2
},
"groups": {
"used": 4,
"limit": 20
},
"campaigns": {
"used": 1,
"limit": 10
},
"teamMembers": {
"used": 2,
"limit": 5
}
}
}
}Exemplo de chamada
curl -X GET "$WAZGO_API_BASE/usage" \
-H "Authorization: Bearer $WAZGO_API_KEY"/instancesListar conexões do workspace Escopo: instances:read.
Os dados sensíveis da sessão e credenciais do provedor não são retornados.
| Parâmetro | Local | Obrigatório | Descrição |
|---|---|---|---|
limit | query | Não | Quantidade máxima de itens. Padrão 50; intervalo de 1 a 100. |
cursor | query | Não | UUID recebido em `nextCursor` na resposta anterior. |
Exemplo de resposta
{
"data": {
"items": [
{
"id": "00000000-0000-4000-8000-000000000020",
"name": "WhatsApp principal",
"status": "ACTIVE",
"sessionStatus": "CONNECTED",
"maskedPhone": "+55 •••• 1234",
"connectedAt": "2026-10-02T12:00:00.000Z",
"lastSeenAt": "2026-10-02T12:00:00.000Z",
"createdAt": "2026-10-02T12:00:00.000Z"
}
],
"nextCursor": null
}
}Exemplo de chamada
curl -X GET "$WAZGO_API_BASE/instances?limit=50&cursor=SEU_CURSOR" \
-H "Authorization: Bearer $WAZGO_API_KEY"/groupsListar grupos do workspace Escopo: groups:read.
Lista grupos ativos e indica se cada grupo está selecionado para gestão.
| Parâmetro | Local | Obrigatório | Descrição |
|---|---|---|---|
limit | query | Não | Quantidade máxima de itens. Padrão 50; intervalo de 1 a 100. |
cursor | query | Não | UUID recebido em `nextCursor` na resposta anterior. |
Exemplo de resposta
{
"data": {
"items": [
{
"id": "00000000-0000-4000-8000-000000000002",
"name": "Comunidade principal",
"enabled": true,
"participantCount": 42,
"community": {
"id": "00000000-0000-4000-8000-000000000030",
"name": "Clientes"
},
"createdAt": "2026-10-02T12:00:00.000Z"
}
],
"nextCursor": null
}
}Exemplo de chamada
curl -X GET "$WAZGO_API_BASE/groups?limit=50&cursor=SEU_CURSOR" \
-H "Authorization: Bearer $WAZGO_API_KEY"/campaignsListar campanhas Escopo: campaigns:read.
Lista campanhas não arquivadas deste workspace.
| Parâmetro | Local | Obrigatório | Descrição |
|---|---|---|---|
limit | query | Não | Quantidade máxima de itens. Padrão 50; intervalo de 1 a 100. |
cursor | query | Não | UUID recebido em `nextCursor` na resposta anterior. |
Exemplo de resposta
{
"data": {
"items": [
{
"id": "00000000-0000-4000-8000-000000000003",
"name": "Aviso semanal",
"active": false,
"timezone": "America/Sao_Paulo",
"frequencyPerWeek": 1,
"windowStartMinute": 480,
"windowEndMinute": 1260,
"createdAt": "2026-10-02T12:00:00.000Z",
"updatedAt": "2026-10-02T12:00:00.000Z",
"groupIds": [
"00000000-0000-4000-8000-000000000002"
]
}
],
"nextCursor": null
}
}Exemplo de chamada
curl -X GET "$WAZGO_API_BASE/campaigns?limit=50&cursor=SEU_CURSOR" \
-H "Authorization: Bearer $WAZGO_API_KEY"/campaignsCriar campanha pausada Escopo: campaigns:write.
Cria uma campanha com `active: false`. A mídia é opcional; quando informada, deve existir no workspace. Os grupos devem pertencer ao mesmo workspace e a operação exige uma Idempotency-Key. A campanha não envia mensagens automaticamente.
| Parâmetro | Local | Obrigatório | Descrição |
|---|---|---|---|
Idempotency-Key | header | Sim | Chave única de 16 a 128 caracteres ASCII imprimíveis. Reutilize a mesma chave ao repetir a mesma criação. |
Body
JSON conforme o schema OpenAPI. Para campanhas, a resposta é criada pausada; nenhuma mensagem é enviada automaticamente.
{
"name": "Aviso semanal",
"text": "Confira as novidades da semana.",
"groupIds": [
"00000000-0000-4000-8000-000000000002"
],
"timezone": "America/Sao_Paulo",
"frequencyPerWeek": 1,
"messageMode": "NONE",
"messages": []
}Exemplo de resposta
{
"data": {
"id": "00000000-0000-4000-8000-000000000003",
"name": "Aviso semanal",
"active": false,
"groupIds": [
"00000000-0000-4000-8000-000000000002"
],
"createdAt": "2026-10-02T12:00:00.000Z"
}
}Exemplo de chamada
curl -X POST "$WAZGO_API_BASE/campaigns" \
-H "Authorization: Bearer $WAZGO_API_KEY" \
-H 'Idempotency-Key: $IDEMPOTENCY_KEY' \
-H 'Content-Type: application/json' \
-d '{"name":"Aviso semanal","text":"Confira as novidades da semana.","groupIds":["00000000-0000-4000-8000-000000000002"],"timezone":"America/Sao_Paulo","frequencyPerWeek":1,"messageMode":"NONE","messages":[]}'