Pular para o conteúdo principal
GET
/
api
/
v1
/
accounts
/
{account_id}
/
agents
Listar agentees em conta
curl --request GET \
  --url https://airys.chat/api/v1/accounts/{account_id}/agents \
  --header 'api_access_token: <api-key>'
import requests

url = "https://airys.chat/api/v1/accounts/{account_id}/agents"

headers = {"api_access_token": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};

fetch('https://airys.chat/api/v1/accounts/{account_id}/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://airys.chat/api/v1/accounts/{account_id}/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_access_token: <api-key>"
  ],
]);

$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 := "https://airys.chat/api/v1/accounts/{account_id}/agents"

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

	req.Header.Add("api_access_token", "<api-key>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://airys.chat/api/v1/accounts/{account_id}/agents")
  .header("api_access_token", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://airys.chat/api/v1/accounts/{account_id}/agents")

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

request = Net::HTTP::Get.new(url)
request["api_access_token"] = '<api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "id": 123,
    "account_id": 123,
    "auto_offline": true,
    "confirmed": true,
    "email": "<string>",
    "available_name": "<string>",
    "name": "<string>",
    "thumbnail": "<string>",
    "custom_role_id": 123
  }
]
{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Autorizações

​
api_access_token
string
header
obrigatório

Este token pode ser obtido visitando a página de perfil ou por meio do console rails. Fornece acesso a endpoints com base nos níveis de permissões do usuário. Este token pode ser salvo por um sistema externo quando o usuário é criado via API, para realizar atividades em nome do usuário.

Parâmetros de caminho

​
account_id
integer
obrigatório

O ID numérico da conta

Resposta

Sucesso

​
id
integer
​
account_id
integer
​
availability_status
enum<string>

O status de disponibilidade do agente calculado pelo Chatwoot.

Opções disponíveis:
available,
busy,
offline
​
auto_offline
boolean

Se o status de disponibilidade do agente está configurado para ficar offline automaticamente quando ausente.

​
confirmed
boolean

Se o agente confirmou o endereço de e-mail.

​
email
string

O e-mail do agente

​
available_name
string

O nome disponível do agente

​
name
string

O nome do agente

​
role
enum<string>

A função do agente

Opções disponíveis:
agent,
administrator
​
thumbnail
string

A miniatura do agente

​
custom_role_id
integer | null

O id de função personalizada do agente