Skip to main content
GET
/
api
/
openapi
/
v1
/
devices
Listar Dispositivos
curl --request GET \
  --url https://app.converza.io/api/openapi/v1/devices \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "devices": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "bot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Dispositivo de Suporte 01",
        "status": "stopped",
        "type": "whatsapp",
        "connected": false,
        "blocked": false,
        "phone_number": "+5511999999999",
        "token": "device_token_abc123",
        "pool_url": "https://pool1.server-converza.io",
        "last_disconnect_reason": "<string>",
        "last_disconnect_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 150,
      "totalPages": 8
    }
  }
}

Authorizations

Authorization
string
header
required

Token JWT obtido do endpoint /api/openapi/auth/token

Query Parameters

page
integer
default:1

Número da página (começa em 1)

Required range: x >= 1
Example:

1

limit
integer
default:20

Número de itens por página

Required range: 1 <= x <= 100
Example:

20

team_id
string<uuid>

Filtrar por ID da equipe

name
string

Filtrar por nome do dispositivo (correspondência parcial)

status
enum<string>

Filtrar por status

Available options:
started,
stopped
connected
boolean

Filtrar por status de conexão

Response

200 - application/json

Dispositivos recuperados com sucesso

success
boolean
Example:

true

data
object