Identificação de ramal por ID

Endpoint: {{HOST}}/service/v1/branch/1

Método: GET

Descrição: Este endpoint permite recuperar informações detalhadas sobre uma filial (branch) específica com base em seu ID. O objetivo é fornecer informações detalhadas sobre uma filial, incluindo seu número de extensão, nome, endereço de e-mail, data de criação e status de habilitação.

Parâmetros:

1 (Parâmetro de caminho): O ID único da filial que você deseja recuperar. Neste caso, o ID é 1.

Resposta de Sucesso:

Código de Status: 200 (OK)

Corpo da Resposta (JSON):

{
    "id": 1,
    "exten": "2000",
    "secret": "2000@2000",
    "name": "Ramal 2000",
    "email": "2000@localhost",
    "created": "2022-10-28T15:05:40-03:00",
    "modified": "2022-10-28T15:05:40-03:00",
    "enabled": true
}

Campo	Tipo	Descrição
`id`	Inteiro	O ID único da filial.
`exten`	String	O número de extensão associado à filial.
`secret`	String	A senha secreta ou chave de acesso à filial.
`name`	String	O nome da filial.
`email`	String	O endereço de e-mail da filial.
`created`	Data e Hora	A data e hora de criação da filial no formato ISO 8601.
`modified`	Data e Hora	A data e hora da última modificação da filial no formato ISO 8601.
`enabled`	Booleano	Indica se a filial está habilitada (true) ou não (false).

Respostas

🟢200Identificação de ramal por ID

application/json

Body

integer

requerido

exten

string

requerido

secret

string

requerido

name

string

requerido

string

requerido

created

string

requerido

modified

string

requerido

enabled

boolean

requerido

Exemplo

{
  "id": 1,
  "exten": "2000",
  "secret": "2000@2000",
  "name": "Ramal 2000",
  "email": "2000@localhost",
  "created": "2022-10-28T15:05:40-03:00",
  "modified": "2022-10-28T15:05:40-03:00",
  "enabled": true
}

Identificação de ramal por ID

Requisição

Exemplos de Requisição

Respostas