Skip to main content
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çalhoValor
AuthorizationBearer <token>

​
Parâmetros de caminho

ParâmetroTipoDescrição
instanceIdstringO ID da instância (ex.: inst_abc123)

​
Resposta 200

CampoTipoDescrição
idstringID único da instância
namestringRótulo da instância
statusstringCREATED, CONFIGURED ou ACTIVE
metadataobjectMetadados da instância
callQueuearrayChamadas ativas nesta instância
created_atstringTimestamp ISO 8601
updated_atstringTimestamp 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ódigoDescrição
401Token ausente ou inválido
404Instâ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>"