Skip to main content
GET
/
api
/
openapi
/
v1
/
devices
Listar Dispositivos
curl --request GET \
  --url http://localhost:3000/api/openapi/v1/devices \
  --header 'Authorization: Bearer <token>'
import requests

url = "http://localhost:3000/api/openapi/v1/devices"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:3000/api/openapi/v1/devices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/api/openapi/v1/devices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/api/openapi/v1/devices"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("http://localhost:3000/api/openapi/v1/devices")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/openapi/v1/devices")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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