Indentificação de Agente por ID

Claro, vou explicar a URL {{HOST}}/service/v1/agent/{{ID}} no formato GET e o formato de resposta JSON associado:

Endpoint: {{HOST}}/service/v1/agent/{{ID}}

Método: GET

Descrição: Este endpoint permite recuperar informações detalhadas sobre um agente específico com base em seu ID. O objetivo é fornecer informações detalhadas sobre um agente, incluindo seu nome, e-mail, data de criação, status de habilitação, extensão e outras propriedades relacionadas ao agente.

Parâmetros:

{{ID}} (Parâmetro de caminho): O ID único do agente que você deseja recuperar. Substitua {{ID}} pelo ID real do agente desejado.

Resposta de Sucesso:

Código de Status: 200 (OK)

Corpo da Resposta (JSON):

{
    "id": 1005,
    "name": "Agente 5",
    "email": "404@localhost",
    "created": "2022-10-28T15:05:37-03:00",
    "modified": "2022-10-28T15:05:37-03:00",
    "enabled": true,
    "standard": false,
    "externalAccounts": [],
    "scope": "ROLE_AGENT",
    "exten": "404",
    "secret": "44488353",
    "paused": false,
    "onCampaign": false,
    "queues": [],
    "t_type": "agent"
}

Campo	Tipo	Descrição
`id`	Inteiro	O ID único do agente.
`name`	String	O nome do agente.
`email`	String	O endereço de e-mail do agente.
`created`	Data e Hora	A data e hora de criação do agente no formato ISO 8601.
`modified`	Data e Hora	A data e hora da última modificação do agente no formato ISO 8601.
`enabled`	Booleano	Indica se o agente está habilitado (true) ou não (false).
`standard`	Booleano	Indica se o agente é padrão (true) ou não (false).
`externalAccounts`	Array	Uma matriz de contas externas associadas ao agente.
`scope`	String	O escopo do agente, geralmente representando sua função ou papel.
`exten`	String	A extensão associada ao agente.
`secret`	String	A senha secreta do agente.
`paused`	Booleano	Indica se o agente está pausado (true) ou não (false).
`onCampaign`	Booleano	Indica se o agente está em uma campanha (true) ou não (false).
`queues`	Array	Uma matriz de filas às quais o agente está associado.
`t_type`	String	O tipo do agente, geralmente indicando que é um agente.

Respostas

🟢200Indentificação de Agente por ID

application/json

Body

integer

requerido

name

string

requerido

string

requerido

created

string

requerido

modified

string

requerido

enabled

boolean

requerido

standard

boolean

requerido

externalAccounts

array

requerido

scope

string

requerido

exten

string

requerido

secret

string

requerido

paused

boolean

requerido

onCampaign

boolean

requerido

queues

array

requerido

t_type

string

requerido

Exemplo

{
  "id": 1003,
  "name": "Agente 3",
  "email": "402@localhost",
  "created": "2022-10-28T15:05:31-03:00",
  "modified": "2022-10-28T15:05:31-03:00",
  "enabled": true,
  "standard": false,
  "externalAccounts": [],
  "scope": "ROLE_AGENT",
  "exten": "402",
  "secret": "06237657",
  "paused": false,
  "onCampaign": false,
  "queues": [],
  "t_type": "agent"
}

Indentificação de Agente por ID

Requisição

Exemplos de Requisição

Respostas