Gerar chamada utilizando uma rota específica

POST

/requests/{channelID}/chamada-conta-senha

Operações de controle dos Ramais monitorados

Esta função deve ser utilizada para geração de uma chamada do dispositivo identificado, utilizando uma rota específica (normalmente atribui-se o valor 0). Os campos conta e senha podem (e normalmente são) nulos e IDENTIDADE_DESTINO deve conter as cifras q

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.

ROTA

string

opcional

Indica a rota a ser utilizada.

CONTA

string

opcional

Indica a conta do usuário.

CARTAO

string

opcional

Indica o cartão (pré-pago) que deve ser utilizado para gerar chamada.

SENHA

string

opcional

Indica a senha a ser utilizada para validação da operação requisitada.

IDENTIDADE_DESTINO

string

requerido

Indica a identidade do destino.

DADOS

string

requerido

Dados associados à chamada. (Limite de 100 caracteres)

IDENTIDADE_ORIGINADOR

string

opcional

Indica a identidade a ser usada como originador na geração de chamada.

TEMPO_REATENDIMENTO

string

opcional

Indica o tempo (em segundos) que a chamada ficará estabelecida com o destino além da liberação (destino coloca no gancho), afim de esperar o reatendimento da mesma. O tempo máximo permitido é de 90 segundos.

BLOQUEIO_TELEMARKETING

string

opcional

Indica se deve consultar a lista de números bloqueados do Procon (SIM/NAO).

Exemplo

{
    "DISPOSITIVO": "1125000",
    "SENHA_DISPOSITIVO": "4567",
    "ROTA": "0",
    "CONTA": "1114000",
    "CARTAO": "",
    "SENHA": "1234",
    "IDENTIDADE_DESTINO": "04832817000",
    "DADOS": "111222333-44;Fulano",
    "IDENTIDADE_ORIGINADOR": "1112000",
    "TEMPO_REATENDIMENTO": "10",
    "BLOQUEIO_TELEMARKETING": "NAO"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/requests//chamada-conta-senha' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "DISPOSITIVO": "1125000",
    "SENHA_DISPOSITIVO": "4567",
    "ROTA": "0",
    "CONTA": "1114000",
    "CARTAO": "",
    "SENHA": "1234",
    "IDENTIDADE_DESTINO": "04832817000",
    "DADOS": "111222333-44;Fulano",
    "IDENTIDADE_ORIGINADOR": "1112000",
    "TEMPO_REATENDIMENTO": "10",
    "BLOQUEIO_TELEMARKETING": "NAO"
}'

Respostas

🟢200OK

application/json

Comando recebido com sucesso.

Body

ID_CHAMADA

string

opcional

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

Exemplo

{
    "ID_CHAMADA": "08/07/24 10:46:19 010A 0974/00"
}

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🔴500Erro do servidor

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

Página anterior

Gerar chamada preditiva