Colocar chamada em espera

POST

/requests/{channelID}/hold

Operações de controle dos Ramais monitorados

Deve estar em estado: "Atendido"

Requisição

Parâmetros Path

channelID

integer

requerido

ID do Canal recebido no EVENTO_DE_ABERTURA_DE_CANAL

Parâmetros Header

x-api-key

string

requerido

Chave de acesso para controle via CTI

Parâmetros Bodyapplication/json

DISPOSITIVO

string

requerido

Indica o dispositivo que está requisitando um serviço.

SENHA_DISPOSITIVO

string

requerido

Senha do dispositivo.

ID_CHAMADA

string

opcional

Este campo é a identificação da chamada em andamento.

Exemplo

{
  "DISPOSITIVO": "1125000",
  "SENHA_DISPOSITIVO": "4567",
  "ID_CHAMADA": "08/07/24 10:46:19 010A 0974/00"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/requests//hold' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "DISPOSITIVO": "1125000",
    "SENHA_DISPOSITIVO": "4567",
    "ID_CHAMADA": "08/07/24 10:46:19 010A 0974/00"
}'

Respostas

🟢200OK

application/json

Comando recebido com sucesso.

Body

object {0}

Exemplo

{}

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🔴500Erro do servidor

Página anterior

Predefinir destino após encerramento da chamada

Próxima página

Recuperar chamada em espera