Realizar ação em participante da conferência

POST

/requests/{channelID}/acao-em-conferencia

Operações de controle dos Ramais monitorados

Esta função deverá ser utilizada para realizar uma ação em um participante da conferência.

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.

DISPOSITIVO_DESTINO_ACAO

string

requerido

Indica o dispositivo destino que receberá a ação.

ACAO

string

requerido

Indica a ação que será aplicada no dispositivo destino. Acao="MUTE" para colocar um dispositivo em mudo na conferência e Acao="UNMUTE" para retirar um dispositivo de mudo na conferência

ID_CHAMADA

string

opcional

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

ID_CHAMADA_DESTINO

string

opcional

Indica o id de chamada destino para transferência.

ID_SALA

string

opcional

Índice da sala de conferência

Exemplo

{
    "DISPOSITIVO": "1125000",
    "SENHA_DISPOSITIVO": "4567",
    "DISPOSITIVO_DESTINO_ACAO": "1251000",
    "ACAO": "MUTE",
    "ID_CHAMADA": "08/07/24 10:46:19 010A 0974/00",
    "ID_CHAMADA_DESTINO": "08/07/24 19:06:59 010A 802D/00",
    "ID_SALA": "7"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/requests//acao-em-conferencia' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "DISPOSITIVO": "1125000",
    "SENHA_DISPOSITIVO": "4567",
    "DISPOSITIVO_DESTINO_ACAO": "1251000",
    "ACAO": "MUTE",
    "ID_CHAMADA": "08/07/24 10:46:19 010A 0974/00",
    "ID_CHAMADA_DESTINO": "08/07/24 19:06:59 010A 802D/00",
    "ID_SALA": "7"
}'

Respostas

🟢200OK

application/json

Comando recebido com sucesso.

Body

object {0}

Exemplo

{}

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🔴500Erro do servidor

Modificado em 2024-09-23 18:54:51

Página anterior

Alocar sala de conferência

Próxima página

Excluir dispositivo da conferência