Indentificação de Fila por ID

Endpoint: {{HOST}}/service/v1/queue/{id}

Método: GET

Descrição: Este endpoint permite obter informações sobre uma fila específica com base em seu id. Ele é usado para recuperar os detalhes de uma fila de serviço com um ID válido. Se a fila com o ID fornecido existir, o servidor retornará os detalhes da fila no formato JSON. Se a fila não existir com o ID especificado, o servidor retornará um JSON com um código de erro 404 indicando que a fila não foi encontrada.

Parâmetros:

{id} (Parâmetro de caminho): O ID da fila que você deseja recuperar. Substitua {id} pelo ID real da fila desejada.

Resposta de Sucesso (Caso exista uma fila com o ID especificado):

Código de Status: 200 (OK)

{ "id": 1, "name": "Fila 1", "exten": "700", "enabled": true }

Resposta de Erro (Caso a fila com o ID especificado não exista):

Código de Status: 404 (Não Encontrado)

{ "code": 404, "message": "Queue not found", "address": "10.168.10.215" }

Portanto, ao acessar este endpoint com um ID válido, você obterá os detalhes da fila como resposta. Se o ID não for válido ou não existir, você receberá uma resposta indicando que a fila não foi encontrada, juntamente com um código de erro 404. Certifique-se de substituir {HOST} pelo host real da sua API e usar um ID válido ao fazer a solicitação.

Campo	Tipo	Descrição
`id`	Inteiro	O ID da fila, identificando exclusivamente a fila.
`name`	String	O nome da fila.
`exten`	String	A extensão associada à fila.
`enabled`	Boolean	Indica se a fila está habilitada (true) ou não (false).

Aqui está a explicação de cada campo:

id: Este campo é um número inteiro que representa o ID único da fila. Cada fila possui um ID exclusivo que a identifica no sistema.

name: Este campo é uma string que contém o nome da fila. Geralmente, o nome é uma descrição ou rótulo que identifica a fila de forma mais legível para os usuários.

exten: Este campo é uma string que indica a extensão associada à fila. Essa extensão pode ser usada para rotear chamadas telefônicas para a fila específica.

enabled: Este campo é um valor booleano que indica se a fila está habilitada ou não. Se estiver definido como true, a fila está ativa e aceitará chamadas. Se estiver definido como false, a fila está desativada e não aceitará chamadas.

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Body

integer

requerido

name

string

requerido

exten

string

requerido

enabled

boolean

requerido

Exemplo

{
  "id": 1,
  "name": "Fila 1",
  "exten": "700",
  "enabled": true
}

Indentificação de Fila por ID

Requisição

Exemplos de Requisição

Respostas