Endpoint de status da operação de fila

É possível usar o endpoint de status da operação de fila para saber a disponibilidade de uma fila antes de redirecionar uma sessão para ela. Esse endpoint retorna as seguintes propriedades booleanas:

  • after_hours: true se a fila estiver indisponível porque está em um estado após o horário de expediente

  • overcapacity: true se a fila estiver indisponível por estar em um estado de excesso de capacidade

Endpoint:

Método: GET

Tipo: RAW

URL: https://{subdomain}.{domain}/apps/api/v1/queue_operation_statuses

Consulta

Chave Valor Descrição
menu_id integer O ID da fila para a qual você quer informações de disponibilidade. Obrigatório.
lang string O código de idioma de duas letras da fila, no formato ISO 639-1. Obrigatório.
channel_type string O tipo de canal. Os valores possíveis são call e chat. Obrigatório.

Exemplo de solicitação e resposta

Esta seção mostra um exemplo de solicitação e resposta.

Solicitação

https://{subdomain}.{domain}/apps/api/v1/queue_operation_statuses?menu_id=1&lang=en&channel_type=call

Resposta

{
  "menu_id": 1,
  "lang": "en",
  "channel_type": "call",
  "after_hour": false,
  "overcapacity": true
}