Documentation Index
Fetch the complete documentation index at: https://docs.cawme.com.br/llms.txt
Use this file to discover all available pages before exploring further.
GET /v1/instances/:instanceId
Retorna os detalhes de uma única instância, incluindo sua fila de chamadas ativa (chamadas nos status QUEUED, RINGING ou IN_PROGRESS).
Requisição
Cabeçalhos
| Cabeçalho | Valor |
|---|
Authorization | Bearer <token> |
Parâmetros de caminho
| Parâmetro | Tipo | Descrição |
|---|
instanceId | string | O ID da instância (ex.: inst_abc123) |
Resposta 200
| Campo | Tipo | Descrição |
|---|
id | string | ID único da instância |
name | string | Rótulo da instância |
status | string | CREATED, CONFIGURED ou ACTIVE |
metadata | object | Metadados da instância |
callQueue | array | Chamadas ativas nesta instância |
created_at | string | Timestamp ISO 8601 |
updated_at | string | Timestamp ISO 8601 |
{
"id": "inst_abc123",
"name": "sales-team-a",
"status": "ACTIVE",
"metadata": {},
"callQueue": [
{
"id": "call_xyz789",
"type": "FIXED_TTS",
"status": "QUEUED",
"target_phone": "+14155550123",
"created_at": "2026-03-01T10:01:00Z"
}
],
"created_at": "2026-03-01T10:00:00Z",
"updated_at": "2026-03-01T10:00:00Z"
}
Erros
| Código | Descrição |
|---|
401 | Token ausente ou inválido |
404 | Instância não encontrada ou não pertence ao usuário autenticado |
Exemplo
curl https://cawme.com/api/v1/instances/inst_abc123 \
-H "Authorization: Bearer <token>"
