{ "openapi": "3.0.3", "info": { "title": "Chattoo Project API", "version": "1.9.3", "description": "Project-bound API keys. Real Baileys text sessions are released per pilot instance; Meta and coexistence remain simulated. No automatic fallback and no conversation history. Baileys sessions have no fixed expiry: network failures and service restarts restore valid saved credentials; user disconnect/logout or WhatsApp revocation interrupt the session. New scopes control session state, pairing secrets and webhook content. Content requires explicit opt-in per destination and remains encrypted for retry for at most 24 hours, with early deletion after completion. Ambiguous sends are not blindly retried. No real billing. SDK Node.js TypeScript disponível em /developers; Swagger interativo em /api-docs. Somente token de projeto é necessário para configurar o cliente. Sessões e callbacks exigem os escopos correspondentes." }, "servers": [ { "url": "https://apis.chattoo.com.br/backend/functions/v1", "description": "Produção — tokens do projeto Supabase de produção" }, { "url": "https://apis.chattoo.com.br:8443/backend/functions/v1", "description": "Validação — tokens do ambiente de teste" } ], "security": [ { "ProjectApiKey": [] } ], "paths": { "/v1-instances": { "get": { "operationId": "listv1_instances", "summary": "List instances in the authenticated key project", "description": "Requires instances:read. Ordered by resource UUID; offset pagination.\n\nTypeScript: `chattoo.instances.list(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0 } } ], "responses": { "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Instance" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Instâncias" ], "x-sdk-method": "instances.list" }, "post": { "operationId": "createv1_instances", "summary": "Create draft instance", "description": "Requires instances:write. Idempotency is scoped to project and operation, across keys/rotations. v1-messages is an alias for v1-commands with a flat message body. Replays retain the original status and resource.\n\nTypeScript: `chattoo.instances.create(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,128}$" }, "example": "pedido-exemplo-001" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 120 } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Instance" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Instâncias" ], "x-sdk-method": "instances.create" } }, "/v1-instances/{id}": { "get": { "operationId": "getv1_instances", "summary": "Get instances resource in the key project", "description": "Requires instances:read. Other projects receive 404.\n\nTypeScript: `chattoo.instances.get(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "11111111-1111-4111-8111-111111111111" } ], "responses": { "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Instance" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Instâncias" ], "x-sdk-method": "instances.get" } }, "/v1-commands": { "get": { "operationId": "listv1_commands", "summary": "List commands in the authenticated key project", "description": "Requires commands:read. Ordered by resource UUID; offset pagination.\n\nTypeScript: `chattoo.commands.list(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0 } } ], "responses": { "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Command" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Comandos" ], "x-sdk-method": "commands.list" }, "post": { "operationId": "createv1_commands", "summary": "Accept a text or template command for mock processing", "description": "Requires commands:write. Idempotency is scoped to project and operation, across keys/rotations. v1-messages is an alias for v1-commands with a flat message body. Replays retain the original status and resource. Template sends require a catalog-approved name/language and exact parameter count; TEMPLATE_NOT_FOUND, TEMPLATE_NOT_APPROVED or TEMPLATE_PARAMETERS_MISMATCH returns 422 before enqueue. Sending controls may return 422 SENDING_PAUSED/TEXT_DISABLED/TEMPLATES_DISABLED. Project-wide acceptance quotas return 429 PROJECT_DAILY_LIMIT or PROJECT_PENDING_LIMIT with Retry-After seconds. Idempotent replay precedes these controls and never consumes another unit. Limits are managed through the authenticated dashboard, not project API keys. Enrolled mock subscriptions may additionally return 422 SUBSCRIPTION_INACTIVE/SUBSCRIPTION_EXPIRED or 429 COMMERCIAL_MONTHLY_LIMIT. Monthly units include all accepted commands in the current UTC month, including before enrollment. Commercial restrictions apply only to new acceptance, not claims/replays. Retry-After for monthly quota is 86400 seconds for rechecking, not a promise of renewal. Unofficial instances require an active simulated Baileys session. Official coexistence requires consent and its official mock binding. Unofficial template sends return 422 TEMPLATES_UNSUPPORTED. Clients cannot override the channel.\n\nTypeScript: `chattoo.messages.sendText / messages.sendTemplate(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,128}$" }, "example": "pedido-exemplo-001" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateCommand" }, { "$ref": "#/components/schemas/CreateTemplateCommand" } ] }, "example": { "instanceId": "11111111-1111-4111-8111-111111111111", "type": "message.send", "payload": { "to": "+5511999999999", "text": "Teste de integração" } } } } }, "responses": { "202": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Command" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Comandos" ], "x-sdk-method": "messages.sendText / messages.sendTemplate" } }, "/v1-commands/{id}": { "get": { "operationId": "getv1_commands", "summary": "Get commands resource in the key project", "description": "Requires commands:read. Other projects receive 404.\n\nTypeScript: `chattoo.commands.get(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "11111111-1111-4111-8111-111111111111" } ], "responses": { "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Command" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Comandos" ], "x-sdk-method": "commands.get" } }, "/v1-messages": { "get": { "operationId": "listv1_messages", "summary": "List commands in the authenticated key project", "description": "Requires commands:read. Ordered by resource UUID; offset pagination.\n\nTypeScript: `chattoo.commands.list(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0 } } ], "responses": { "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Command" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Mensagens" ], "x-sdk-method": "commands.list" }, "post": { "operationId": "createv1_messages", "summary": "Accept a queued message.send command for mock processing", "description": "Requires commands:write. Idempotency is scoped to project and operation, across keys/rotations. v1-messages is an alias for v1-commands with a flat message body. Replays retain the original status and resource. Sending controls may return 422 SENDING_PAUSED/TEXT_DISABLED/TEMPLATES_DISABLED. Project-wide acceptance quotas return 429 PROJECT_DAILY_LIMIT or PROJECT_PENDING_LIMIT with Retry-After seconds. Idempotent replay precedes these controls and never consumes another unit. Limits are managed through the authenticated dashboard, not project API keys. Enrolled mock subscriptions may additionally return 422 SUBSCRIPTION_INACTIVE/SUBSCRIPTION_EXPIRED or 429 COMMERCIAL_MONTHLY_LIMIT. Monthly units include all accepted commands in the current UTC month, including before enrollment. Commercial restrictions apply only to new acceptance, not claims/replays. Retry-After for monthly quota is 86400 seconds for rechecking, not a promise of renewal. Unofficial instances require an active simulated Baileys session. Official coexistence requires consent and its official mock binding. Unofficial template sends return 422 TEMPLATES_UNSUPPORTED. Clients cannot override the channel.\n\nTypeScript: `chattoo.messages.sendText(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,128}$" }, "example": "pedido-exemplo-001" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMessage" }, "example": { "instanceId": "11111111-1111-4111-8111-111111111111", "to": "+5511999999999", "text": "Teste de integração" } } } }, "responses": { "202": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Command" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Mensagens" ], "x-sdk-method": "messages.sendText" } }, "/v1-messages/{id}": { "get": { "operationId": "getv1_messages", "summary": "Get commands resource in the key project", "description": "Requires commands:read. Other projects receive 404.\n\nTypeScript: `chattoo.commands.get(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "11111111-1111-4111-8111-111111111111" } ], "responses": { "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Command" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Mensagens" ], "x-sdk-method": "commands.get" } }, "/v1-webhooks": { "get": { "operationId": "listv1_webhooks", "summary": "List webhooks in the authenticated key project", "description": "Requires webhooks:read. Ordered by resource UUID; offset pagination.\n\nTypeScript: `chattoo.webhooks.list(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0 } } ], "responses": { "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Webhooks" ], "x-sdk-method": "webhooks.list" }, "post": { "operationId": "createv1_webhooks", "summary": "Register a signed client webhook", "description": "Requires webhooks:write and Idempotency-Key. At most 10 active destinations per project. signingSecret appears once; idempotent replay returns metadata only. If the initial response is lost, disable the destination and register a replacement.\n\nTypeScript: `chattoo.webhooks.create(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,128}$" }, "example": "pedido-exemplo-001" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhook" } } } }, "responses": { "201": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookCreated" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Webhooks" ], "x-sdk-method": "webhooks.create" } }, "/v1-webhooks/{id}": { "get": { "operationId": "getv1_webhooks", "summary": "Get webhooks resource in the key project", "description": "Requires webhooks:read. Other projects receive 404.\n\nTypeScript: `chattoo.webhooks.get(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "11111111-1111-4111-8111-111111111111" } ], "responses": { "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Webhook" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Webhooks" ], "x-sdk-method": "webhooks.get" }, "delete": { "operationId": "disableWebhook", "summary": "Disable a webhook and cancel pending deliveries", "description": "Requires webhooks:write. A request already sent may still arrive. Repeated disable is safe. No Idempotency-Key required.\n\nTypeScript: `chattoo.webhooks.disable(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "11111111-1111-4111-8111-111111111111" } ], "responses": { "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookDisabled" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Webhooks" ], "x-sdk-method": "webhooks.disable" }, "patch": { "operationId": "configureWebhookContent", "summary": "Opt in or out of real Baileys webhook content", "description": "Requires webhooks:content and Idempotency-Key. Applies to new events only. Disabling cancels pending content deliveries. Legacy destinations receive metadata.\n\nTypeScript: `chattoo.webhooks.setContent(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "11111111-1111-4111-8111-111111111111" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "example": "pedido-exemplo-001" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookContentInput" } } } }, "responses": { "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookContent" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": {} }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Webhooks" ], "x-sdk-method": "webhooks.setContent" } }, "/v1-templates": { "get": { "operationId": "listv1_templates", "summary": "List templates in the authenticated key project", "description": "Requires templates:read. Same synthetic fixtures are visible within any authorized project. No Graph requests. GET only; templates cannot be created or edited.\n\nTypeScript: `chattoo.templates.list(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0 } } ], "responses": { "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Template" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Templates" ], "x-sdk-method": "templates.list" } }, "/v1-templates/{id}": { "get": { "operationId": "getv1_templates", "summary": "Get templates resource in the key project", "description": "Requires templates:read. Other projects receive 404.\n\nTypeScript: `chattoo.templates.get(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "11111111-1111-4111-8111-111111111111" } ], "responses": { "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Template" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Templates" ], "x-sdk-method": "templates.get" } }, "/v1-usage": { "get": { "operationId": "getProjectUsage", "summary": "Read project usage and sending policy", "description": "Requires usage:read. Project is derived from the key. No path ID or query parameters. Daily counts use the UTC acceptance cohort; pending covers all dates. Replays and provider retries do not consume new units. No message contents or billing units. Includes commercial entitlement metadata when opt-in mock billing is enabled; no invoice amounts or financial records. periodEnd is exclusive and UTC-based. Projects without enrollment retain existing operational behavior.\n\nTypeScript: `chattoo.usage.get(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [], "responses": { "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProjectUsage" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Uso" ], "x-sdk-method": "usage.get" } }, "/v1-sessions/{id}": { "get": { "operationId": "getSession", "summary": "Read a project instance session", "description": "Requires sessions:read. Read revision before each control operation. Real release is managed by the platform.\n\nTypeScript: `chattoo.sessions.get(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Instance ID in the API key project", "example": "11111111-1111-4111-8111-111111111111" } ], "responses": { "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Session" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": {} }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Sessões" ], "x-sdk-method": "sessions.get" }, "post": { "operationId": "controlSession", "summary": "Pair, reconnect, disconnect or logout", "description": "Requires sessions:write, Idempotency-Key and expectedRevision. Only released real Baileys. Disconnect preserves credentials and cancels unsubmitted sends; reconnect restores saved registered credentials. Logout requires remote acknowledgement. 409 SESSION_CHANGED means refresh and review. 422 SESSION_UNAVAILABLE means the action is not valid for this state. Sessions have no fixed TTL.\n\nTypeScript: `chattoo.sessions.pair / reconnect / disconnect / logout(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Instance ID in the API key project", "example": "11111111-1111-4111-8111-111111111111" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "example": "pedido-exemplo-001" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionControl" }, "example": { "action": "pair", "method": "qr", "expectedRevision": 1 } } } }, "responses": { "202": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SessionAccepted" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": {} }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "SESSION_CHANGED or IDEMPOTENCY_CONFLICT" }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "SESSION_UNAVAILABLE" }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Sessões" ], "x-sdk-method": "sessions.pair / reconnect / disconnect / logout" } }, "/v1-sessions/{id}/pairing": { "get": { "operationId": "getPairingSecret", "summary": "Read current QR or pairing code", "description": "Requires sessions:pair. Null means no valid artifact. Secrets expire independently of the linked session; no public caching.\n\nTypeScript: `chattoo.sessions.pairing(...)`. Guia: /developers. Bearer: colar apenas o token em Authorize.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Instance ID in the API key project", "example": "11111111-1111-4111-8111-111111111111" } ], "responses": { "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Pairing" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": {} }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Sessões" ], "x-sdk-method": "sessions.pairing" } }, "/v1-webhooks/{id}/test": { "post": { "operationId": "testWebhook", "summary": "Testar entrega e assinatura do webhook", "description": "Diagnóstico sem mensagens ou cobrança, pelo mesmo transporte/HMAC. Requer webhooks:write, Idempotency-Key e destino ativo; limite de um teste/minuto/destino e dez/projeto. Instale Node SDK >=0.3 para reconhecer webhook.test.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "11111111-1111-4111-8111-111111111111" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "maxLength": 128 } } ], "responses": { "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "202": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookTest" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } } }, "tags": [ "Webhooks" ], "x-sdk-method": "webhooks.test", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false }, "example": {} } } } } }, "/v1-webhooks/{id}/tests": { "get": { "operationId": "listWebhookTests", "summary": "Consultar diagnósticos de um destino", "description": "Requer webhooks:read. Consulta resultados sem corpo da resposta ou segredos.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "11111111-1111-4111-8111-111111111111" } ], "responses": { "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookTest" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } } }, "tags": [ "Webhooks" ], "x-sdk-method": "webhooks.tests" } }, "/v1-costs": { "get": { "operationId": "getProjectCosts", "summary": "Consultar estimativas de custo do projeto", "description": "Requer costs:read, emitido somente por owner/admin. Valores em micros são strings decimais exatas. Estimativas simuladas não são cobranças. Custo real indisponível é null, nunca zero. Até 50 lançamentos recentes; totais incluem todos os comandos registrados.", "parameters": [], "responses": { "200": { "description": "Resultado da operação", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProjectCosts" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ], "additionalProperties": false } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } } }, "400": { "description": "Invalid request", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this project", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency key conflict", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 32768 bytes", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Active mock connection required", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "120 requests per minute per key exceeded; Retry-After: 60", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry POST with the same idempotency key", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Uso" ], "x-sdk-method": "costs.get" } } }, "components": { "securitySchemes": { "ProjectApiKey": { "type": "http", "scheme": "bearer", "bearerFormat": "ctk_<32-hex-id>_<64-hex-secret>" } }, "schemas": { "Meta": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "replayed": { "type": "boolean" }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "required": [ "limit", "offset" ], "additionalProperties": false } }, "required": [ "requestId", "replayed" ], "additionalProperties": false }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false }, "meta": { "$ref": "#/components/schemas/ErrorMeta" } }, "required": [ "error", "meta" ], "additionalProperties": false }, "Instance": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "status": { "type": "string" }, "operatingMode": { "type": "string", "enum": [ "official_only", "unofficial_only", "official_coexistence", "hybrid_experimental" ] }, "channelKind": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "status", "operatingMode", "channelKind", "createdAt" ], "additionalProperties": false }, "Command": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "instanceId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "message.send", "message.template.send" ] }, "status": { "type": "string", "enum": [ "queued", "processing", "succeeded", "failed" ] }, "mode": { "type": "string", "enum": [ "mock", "real" ] }, "requestId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "attempts": { "type": "integer", "minimum": 0, "maximum": 3 }, "errorCode": { "type": "string", "nullable": true }, "receiptId": { "type": "string", "nullable": true, "description": "Recibo mock ou ID externo Baileys; nulo enquanto não confirmado. Não significa entrega/leitura." }, "deadLetteredAt": { "type": "string", "format": "date-time", "nullable": true }, "channel": { "type": "string", "enum": [ "meta", "baileys" ], "description": "Server-selected route, derived from the instance mode." }, "submissionState": { "type": "string", "enum": [ "not_started", "submitting", "sent", "uncertain" ], "description": "uncertain means an external send may have happened; no automatic resubmission. Later status events may confirm it." }, "routingDecision": { "$ref": "#/components/schemas/RoutingDecision" } }, "required": [ "id", "instanceId", "type", "status", "mode", "requestId", "createdAt", "attempts", "errorCode", "receiptId", "deadLetteredAt", "channel", "submissionState" ], "additionalProperties": false }, "CreateCommand": { "type": "object", "properties": { "instanceId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "message.send" ] }, "payload": { "type": "object", "properties": { "to": { "type": "string", "pattern": "^(\\+?[1-9][0-9]{7,14}|[0-9:]{5,64}@(s\\.whatsapp\\.net|lid))$", "description": "Phone for all channels; direct phone/LID JID additionally supported by real Baileys. Groups are unsupported." }, "text": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "to", "text" ], "additionalProperties": false } }, "required": [ "instanceId", "type", "payload" ], "additionalProperties": false }, "CreateMessage": { "type": "object", "properties": { "instanceId": { "type": "string", "format": "uuid" }, "to": { "type": "string", "pattern": "^(\\+?[1-9][0-9]{7,14}|[0-9:]{5,64}@(s\\.whatsapp\\.net|lid))$", "description": "Phone for all channels; direct phone/LID JID additionally supported by real Baileys. Groups are unsupported." }, "text": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "instanceId", "to", "text" ], "additionalProperties": false }, "Webhook": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" }, "enabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "signingSecret": { "type": "string", "description": "Returned only on the initial create response; absent on idempotent replay and all reads." }, "includeContent": { "type": "boolean", "default": false, "description": "Explicit opt-in for text and sender in new real Baileys events. Not retroactive. Disabling cancels pending content deliveries." } }, "required": [ "id", "url", "enabled" ], "additionalProperties": false }, "CreateWebhook": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2048, "description": "Public HTTPS IPv4 destination on port 443. The local test harness can explicitly allow one loopback HTTP origin." } }, "required": [ "url" ], "additionalProperties": false }, "Template": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "language": { "type": "string" }, "status": { "type": "string", "enum": [ "approved", "paused" ] }, "parameterCount": { "type": "integer", "minimum": 0, "maximum": 10 }, "mode": { "type": "string", "enum": [ "mock" ] }, "body": { "type": "string", "description": "Synthetic template fixture, never a received message." } }, "required": [ "id", "name", "language", "status", "parameterCount", "mode", "body" ], "additionalProperties": false }, "TemplateSelection": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,99}$" }, "language": { "type": "string", "pattern": "^[a-z]{2}(_[A-Z]{2})?$" }, "parameters": { "type": "array", "maxItems": 10, "items": { "type": "string", "minLength": 1, "maxLength": 1024 } } }, "required": [ "name", "language", "parameters" ], "additionalProperties": false }, "CreateTemplateCommand": { "type": "object", "properties": { "instanceId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "message.template.send" ] }, "payload": { "type": "object", "properties": { "to": { "type": "string", "pattern": "^\\+?[1-9][0-9]{7,14}$" }, "template": { "$ref": "#/components/schemas/TemplateSelection" } }, "required": [ "to", "template" ], "additionalProperties": false } }, "required": [ "instanceId", "type", "payload" ], "additionalProperties": false }, "SendingPolicy": { "type": "object", "properties": { "sendingEnabled": { "type": "boolean", "default": true }, "textEnabled": { "type": "boolean", "default": true }, "templatesEnabled": { "type": "boolean", "default": true }, "dailyCommandLimit": { "type": "integer", "minimum": 1, "maximum": 100000, "default": 1000 }, "pendingCommandLimit": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 }, "version": { "type": "integer", "minimum": 1 } }, "required": [ "sendingEnabled", "textEnabled", "templatesEnabled", "dailyCommandLimit", "pendingCommandLimit", "version" ], "additionalProperties": false }, "ProjectUsage": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid" }, "mode": { "type": "string", "enum": [ "mock" ] }, "unit": { "type": "string", "enum": [ "accepted_command" ] }, "period": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "timezone": { "type": "string", "enum": [ "UTC" ] }, "resetsAt": { "type": "string", "format": "date-time" } }, "required": [ "date", "timezone", "resetsAt" ], "additionalProperties": false }, "policy": { "$ref": "#/components/schemas/SendingPolicy" }, "counts": { "type": "object", "properties": { "accepted": { "type": "integer", "format": "int64", "minimum": 0 }, "text": { "type": "integer", "format": "int64", "minimum": 0 }, "templates": { "type": "integer", "format": "int64", "minimum": 0 }, "succeeded": { "type": "integer", "format": "int64", "minimum": 0 }, "failed": { "type": "integer", "format": "int64", "minimum": 0 }, "pending": { "type": "integer", "format": "int64", "minimum": 0 } }, "required": [ "accepted", "text", "templates", "succeeded", "failed", "pending" ], "additionalProperties": false }, "remaining": { "type": "object", "properties": { "daily": { "type": "integer", "minimum": 0 }, "pending": { "type": "integer", "minimum": 0 } }, "required": [ "daily", "pending" ], "additionalProperties": false }, "commercial": { "$ref": "#/components/schemas/CommercialEntitlement" } }, "required": [ "projectId", "mode", "unit", "period", "policy", "counts", "remaining" ], "additionalProperties": false }, "CommercialEntitlement": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "mock" ] }, "planId": { "type": "string", "enum": [ "mock_free", "mock_start", "mock_scale" ], "nullable": true }, "status": { "type": "string", "enum": [ "active", "cancelled", "expired" ], "nullable": true }, "validUntil": { "type": "string", "format": "date-time", "nullable": true }, "periodStart": { "type": "string", "format": "date" }, "periodEnd": { "type": "string", "format": "date" }, "accepted": { "type": "integer", "format": "int64", "minimum": 0 }, "monthlyCommandLimit": { "type": "integer", "minimum": 1, "nullable": true }, "remaining": { "type": "integer", "minimum": 0, "nullable": true } }, "required": [ "enabled", "mode", "planId", "status", "validUntil", "periodStart", "periodEnd", "accepted", "monthlyCommandLimit", "remaining" ], "additionalProperties": false }, "SessionControl": { "type": "object", "additionalProperties": false, "required": [ "action", "expectedRevision" ], "properties": { "action": { "type": "string", "enum": [ "pair", "reconnect", "disconnect", "logout" ] }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "method": { "type": "string", "enum": [ "qr", "code" ], "default": "qr" }, "phone": { "type": "string", "pattern": "^[1-9][0-9]{7,14}$", "description": "Required for pair with method code. Country code and number, digits only." } } }, "Session": { "type": "object", "properties": { "instanceId": { "type": "string", "format": "uuid" }, "mode": { "type": "string", "enum": [ "mock", "real" ] }, "realEnabled": { "type": "boolean" }, "session": { "allOf": [ { "$ref": "#/components/schemas/SessionState" } ], "nullable": true }, "workerActive": { "type": "boolean", "description": "Whether the session has current worker ownership. Persisted connected status alone is not a readiness guarantee." }, "resumeAvailable": { "type": "boolean", "description": "Registered credentials are available for an explicit reconnect." } }, "required": [ "instanceId", "mode", "realEnabled", "workerActive", "resumeAvailable", "session" ], "additionalProperties": false }, "Pairing": { "type": "object", "nullable": true, "required": [ "method", "value", "expiresAt" ], "properties": { "method": { "type": "string", "enum": [ "qr", "code" ] }, "value": { "type": "string", "description": "Sensitive short-lived QR payload or code; never log or cache." }, "expiresAt": { "type": "string", "format": "date-time" } }, "description": "QR/código atual, com validade curta independente da sessão; null se indisponível. Não salvar em logs/cache." }, "BaileysWebhookEvent": { "description": "Eventos v2 do canal real: mode=real, schemaVersion=2. Comandos não possuem occurredAt; notificações de provedor/sessão possuem.", "oneOf": [ { "$ref": "#/components/schemas/CommandWebhookEvent" }, { "$ref": "#/components/schemas/MessageWebhookEvent" }, { "$ref": "#/components/schemas/StatusWebhookEvent" }, { "$ref": "#/components/schemas/SessionWebhookEvent" } ] }, "WebhookCreated": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" }, "enabled": { "type": "boolean" }, "signingSecret": { "type": "string", "description": "Returned only on the initial create response; absent on idempotent replay and all reads." } }, "required": [ "id", "url", "enabled" ], "additionalProperties": false }, "WebhookDisabled": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean", "enum": [ false ] } }, "required": [ "id", "enabled" ], "additionalProperties": false }, "WebhookContent": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "includeContent": { "type": "boolean" } }, "required": [ "id", "includeContent" ], "additionalProperties": false }, "WebhookContentInput": { "type": "object", "properties": { "includeContent": { "type": "boolean" } }, "required": [ "includeContent" ], "additionalProperties": false }, "SessionState": { "type": "object", "properties": { "instance_id": { "type": "string", "format": "uuid" }, "organization_id": { "type": "string", "format": "uuid" }, "provider_mode": { "type": "string", "enum": [ "mock", "real" ] }, "desired_state": { "type": "string", "enum": [ "pairing", "connected", "disconnected", "logged_out" ] }, "status": { "type": "string", "enum": [ "queued", "pairing", "connecting", "connected", "verifying", "reconnecting", "simulated_connected", "disconnected", "logged_out", "error" ] }, "last_action": { "type": "string" }, "revision": { "type": "integer", "minimum": 0 }, "request_id": { "type": "string", "format": "uuid" }, "pairing_code": { "type": "string", "nullable": true, "description": "Campo legado; nulo em controles reais. Não contém o QR real." }, "error_code": { "type": "string", "nullable": true }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "instance_id", "organization_id", "provider_mode", "desired_state", "status", "last_action", "revision", "request_id", "error_code", "updated_at" ], "additionalProperties": true }, "SessionAccepted": { "allOf": [ { "$ref": "#/components/schemas/SessionState" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ], "additionalProperties": true } ], "description": "Estado/revisão aceitos. O socket confirma conexão posteriormente; o id adicional é o ID da instância." }, "CommandWebhookEvent": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "schemaVersion": { "type": "integer", "enum": [ 1, 2 ] }, "mode": { "type": "string", "enum": [ "mock", "real" ] }, "type": { "type": "string", "enum": [ "command.succeeded", "command.failed" ] }, "data": { "type": "object", "properties": { "commandId": { "type": "string", "format": "uuid" }, "instanceId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "succeeded", "failed" ] }, "errorCode": { "type": "string", "nullable": true }, "receiptId": { "type": "string", "nullable": true }, "channel": { "type": "string", "enum": [ "meta", "baileys" ] }, "submissionState": { "type": "string", "enum": [ "not_started", "submitting", "sent", "uncertain" ] } }, "required": [ "commandId", "instanceId", "projectId", "requestId", "status", "errorCode", "receiptId" ], "additionalProperties": false } }, "required": [ "id", "schemaVersion", "mode", "type", "data" ], "additionalProperties": false }, "MessageWebhookEvent": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "schemaVersion": { "type": "integer", "enum": [ 1, 2 ] }, "mode": { "type": "string", "enum": [ "mock", "real" ] }, "type": { "type": "string", "enum": [ "message.received", "message.echo" ] }, "occurredAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "instanceId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "externalId": { "type": "string" }, "origin": { "type": "string", "enum": [ "cloud_api", "business_app", "baileys" ] }, "channel": { "type": "string", "enum": [ "meta", "baileys" ] }, "commandId": { "type": "string", "format": "uuid", "nullable": true }, "text": { "type": "string", "maxLength": 4096, "description": "Somente Baileys real e destino com conteúdo autorizado." }, "senderId": { "type": "string" }, "senderKind": { "type": "string", "enum": [ "phone", "lid" ] } }, "required": [ "instanceId", "projectId", "externalId" ], "additionalProperties": false } }, "required": [ "id", "schemaVersion", "mode", "type", "occurredAt", "data" ], "additionalProperties": false }, "StatusWebhookEvent": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "schemaVersion": { "type": "integer", "enum": [ 1, 2 ] }, "mode": { "type": "string", "enum": [ "mock", "real" ] }, "type": { "type": "string", "enum": [ "message.status.sent", "message.status.delivered", "message.status.read", "message.status.failed" ] }, "occurredAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "instanceId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "externalId": { "type": "string" }, "origin": { "type": "string", "enum": [ "cloud_api", "business_app", "baileys" ] }, "channel": { "type": "string", "enum": [ "meta", "baileys" ] }, "commandId": { "type": "string", "format": "uuid", "nullable": true } }, "required": [ "instanceId", "projectId", "externalId" ], "additionalProperties": false } }, "required": [ "id", "schemaVersion", "mode", "type", "occurredAt", "data" ], "additionalProperties": false }, "SessionWebhookEvent": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "schemaVersion": { "type": "integer", "enum": [ 1, 2 ] }, "mode": { "type": "string", "enum": [ "mock", "real" ] }, "type": { "type": "string", "enum": [ "session.status" ] }, "occurredAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "instanceId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "externalId": { "type": "string" }, "origin": { "type": "string", "enum": [ "cloud_api", "business_app", "baileys" ] }, "channel": { "type": "string", "enum": [ "meta", "baileys" ] }, "commandId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "type": "string", "enum": [ "queued", "pairing", "connecting", "connected", "verifying", "reconnecting", "simulated_connected", "disconnected", "logged_out", "error" ] }, "revision": { "type": "integer" }, "errorCode": { "type": "string", "nullable": true } }, "required": [ "instanceId", "projectId", "externalId", "status", "revision", "errorCode" ], "additionalProperties": false } }, "required": [ "id", "schemaVersion", "mode", "type", "occurredAt", "data" ], "additionalProperties": false }, "WebhookEvent": { "oneOf": [ { "$ref": "#/components/schemas/CommandWebhookEvent" }, { "$ref": "#/components/schemas/MessageWebhookEvent" }, { "$ref": "#/components/schemas/StatusWebhookEvent" }, { "$ref": "#/components/schemas/SessionWebhookEvent" }, { "$ref": "#/components/schemas/TestWebhookEvent" } ] }, "ErrorMeta": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" } }, "required": [ "requestId" ], "additionalProperties": false }, "WebhookTest": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "webhookId": { "type": "string", "format": "uuid" }, "eventId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "pending", "inflight", "delivered", "dead", "cancelled" ] }, "attempts": { "type": "integer" }, "httpStatus": { "type": "integer", "nullable": true }, "durationMs": { "type": "integer", "nullable": true }, "errorCode": { "type": "string", "nullable": true }, "lastAttemptAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "webhookId", "eventId", "status", "attempts", "httpStatus", "durationMs", "errorCode", "lastAttemptAt", "createdAt" ] }, "TestWebhookEvent": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "schemaVersion": { "type": "integer", "enum": [ 1 ] }, "mode": { "type": "string", "enum": [ "mock" ] }, "type": { "type": "string", "enum": [ "webhook.test" ] }, "diagnostic": { "type": "boolean", "enum": [ true ] }, "occurredAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "additionalProperties": false, "properties": { "projectId": { "type": "string", "format": "uuid" }, "instanceId": { "type": "string", "format": "uuid", "nullable": true }, "commandId": { "type": "string", "format": "uuid", "nullable": true }, "externalId": { "type": "string", "format": "uuid" }, "webhookId": { "type": "string", "format": "uuid" }, "testId": { "type": "string", "format": "uuid" }, "diagnostic": { "type": "boolean", "enum": [ true ] }, "origin": { "type": "string", "enum": [ "chattoo" ] }, "channel": { "type": "string", "nullable": true } }, "required": [ "projectId", "instanceId", "commandId", "externalId", "webhookId", "testId", "diagnostic", "origin", "channel" ] } }, "required": [ "id", "schemaVersion", "mode", "type", "diagnostic", "occurredAt", "data" ] }, "RoutingDecision": { "type": "object", "nullable": true, "description": "Decisão congelada no aceite; revalidação pode encerrar sem alterar a rota. Sem tarifa ou destinatário.", "properties": { "channel": { "type": "string", "enum": [ "meta", "baileys" ] }, "providerMode": { "type": "string", "enum": [ "mock", "real" ] }, "operatingMode": { "type": "string" }, "policyVersion": { "type": "integer" }, "reason": { "type": "string" }, "windowRequired": { "type": "boolean" }, "windowState": { "type": "string", "enum": [ "exempt", "open", "closed", "not_required" ] }, "windowExpiresAt": { "type": "string", "nullable": true }, "windowMinutes": { "type": "integer" }, "decidedAt": { "type": "string" } }, "required": [ "channel", "providerMode", "operatingMode", "policyVersion", "reason", "windowRequired", "windowState", "windowExpiresAt", "windowMinutes", "decidedAt" ] }, "ProjectCosts": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid" }, "currency": { "type": "string", "enum": [ "BRL" ] }, "unit": { "type": "string", "enum": [ "micro_currency" ] }, "source": { "type": "string", "enum": [ "simulation_or_unavailable" ] }, "actualTotalMicros": { "type": "string", "nullable": true }, "estimatedSimulatedMicros": { "type": "string" }, "unknownEstimates": { "type": "integer" }, "commands": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "commandId": { "type": "string", "format": "uuid" }, "tariffVersion": { "type": "integer" }, "source": { "type": "string", "enum": [ "simulation", "unavailable" ] }, "estimateMicros": { "type": "string", "nullable": true }, "actualMicros": { "type": "string", "nullable": true }, "outcome": { "type": "string" }, "attempts": { "type": "integer" }, "submissionState": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "commandId", "tariffVersion", "source", "estimateMicros", "actualMicros", "outcome", "attempts", "submissionState", "createdAt" ] } } }, "required": [ "projectId", "currency", "unit", "source", "actualTotalMicros", "estimatedSimulatedMicros", "unknownEstimates", "commands", "items" ] } } }, "x-webhook-delivery": { "events": [ "command.succeeded", "command.failed", "message.received", "message.status.sent", "message.status.delivered", "message.status.read", "message.status.failed", "message.echo", "session.status", "webhook.test" ], "headers": [ "X-Chattoo-Event-Id", "X-Chattoo-Timestamp", "X-Chattoo-Signature" ], "signature": "sha256=HMAC-SHA256(signingSecret, timestamp + \".\" + exact UTF-8 body)", "semantics": "At least once; até cinco tentativas. HMAC sobre timestamp + ponto + bytes originais. Validar janela de 300 segundos e deduplicar por event ID. v1 mock/metadados; v2 Baileys real. Conteúdo exige opt-in e expira em até 24h, sem limitar a sessão.", "providerEvent": "Provider event callbacks include occurredAt and data={instanceId,projectId,externalId}. No sender, text, media or conversation history. Statuses may arrive out of order; each normalized status has its own event ID. command.succeeded is a processor result, not delivery/read confirmation. Provider data also includes origin=cloud_api|business_app|baileys; business_app identifies coexistence echoes. Echoes never enqueue a send. Command callback data includes channel=meta|baileys.", "schema": { "$ref": "#/components/schemas/WebhookEvent" } }, "externalDocs": { "description": "SDK Node.js e início rápido", "url": "https://app.chattoo.com.br/developers" }, "tags": [ { "name": "Instâncias", "description": "Recursos do projeto do token" }, { "name": "Mensagens", "description": "Texto e comandos de template; aceite não confirma entrega" }, { "name": "Comandos", "description": "Processamento, resultado incerto e conciliação" }, { "name": "Sessões", "description": "Ciclo Baileys real e pareamento restrito" }, { "name": "Webhooks", "description": "Destinos, assinatura e opt-in de conteúdo" }, { "name": "Templates", "description": "Catálogo ainda simulado" }, { "name": "Uso", "description": "Regras e contadores do projeto" } ] }