Desligamento de emergência

Ative ou desative o desligamento de emergência em uma ou mais filas. Essa API permite que sistemas externos controlem remotamente a disponibilidade da fila em situações de emergência.

Parâmetro	Obrigatório	Tipo de dados	Definição
menu_id	verdadeiro	Matriz	Matriz de IDs de fila a serem atualizados.
language	verdadeiro	String	Código de idioma ISO 639-1 (por exemplo, en, es).
emergency_shutdown.enabled	verdadeiro	Booleano	Ative (true) ou desative (false) o desligamento de emergência.
emergency_shutdown.message.type	falso	String	Tipo de mensagem: tts (conversão de texto em voz) ou audio (URL de áudio).
emergency_shutdown.message.content	falso	String	Texto da TTS ou URL do arquivo de áudio. Obrigatório se message.type for especificado.
emergency_shutdown.in_progress_calls	falso	String	Como lidar com chamadas em andamento: allow_finish, end_and_redirect_to_after_hours, end_and_redirect_to_overcapacity.
emergency_shutdown.queued_calls	falso	String	Como lidar com chamadas em fila: disconnect, redirect_to_after_hours, redirect_to_overcapacity.

Observações:

• Se nenhuma mensagem for especificada ao ativar, a mensagem de desligamento de emergência padrão global será usada.

• Os parâmetros in_progress_calls e queued_calls são opcionais. Se não forem especificados, as configurações globais serão herdadas.

• Para usar essa API, ative a API e o recurso de fila de emergência.

Exemplos

Esta seção contém exemplos de código para a API de desligamento de emergência.

Endpoint

Método: POST

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

Cabeçalhos

Chave	Valor	Descrição
Content-Type	application/json
Aceitar	application/json

Exemplo 1: desligamento ativado

Este exemplo ativa a capacidade de desligamento da fila de emergência.

Corpo da solicitação

{
    "menu_id": [
        123,
        456
    ],
    "language": "en",
    "emergency_shutdown": {
        "enabled": true,
        "message": {
            "type": "tts",
            "content": "We are currently experiencing an emergency. Please call back later."
        },
        "in_progress_calls": "allow_finish",
        "queued_calls": "disconnect"
    }
}

Resposta

{
    "menu_id": [
        123,
        456
    ],
    "language": "en",
    "emergency_shutdown": {
        "enabled": true,
        "message": {
            "type": "tts",
            "content": "We are currently experiencing an emergency. Please call back later."
        },
        "in_progress_calls": "allow_finish",
        "queued_calls": "disconnect"
    }
}

Exemplo 2: desligamento ativado, mensagem global padrão

Este exemplo ativa o recurso de encerramento da fila de emergência e usa a mensagem global padrão.

Corpo da solicitação

{
    "menu_id": [
        123
    ],
    "language": "en",
    "emergency_shutdown": {
        "enabled": true
    }
}

Resposta

{
    "success": true,
    "affected_queues": [
        123
    ],
    "emergency_shutdown": {
        "enabled": true,
        "message_source": "global_default",
        "in_progress_calls": null,
        "queued_calls": null
    }
}

Exemplo 3: desligamento desativado

Este exemplo desativa a capacidade de desligamento da fila de emergência.

Corpo da solicitação

{
    "menu_id": [
        123
    ],
    "language": "en",
    "emergency_shutdown": {
        "enabled": false
    }
}

Resposta

{
    "success": true,
    "affected_queues": [
        123
    ],
    "emergency_shutdown": {
        "enabled": false,
        "message_source": null,
        "in_progress_calls": null,
        "queued_calls": null
    }
}