Integração para Telefonia

Introdução

Com essa nossa API os desenvoldedores de sistemas de telefonia poderão interagir com as aplicações fornecidas pela ClearSale.

Fluxo de interação

A partir da integração do sistema de telefonia com a Clearsale, torna-se possível realizar chamadas telefônicas a partir da nossa aplicação. Os telefones que poderão ser usados estarão na tela de pedido, integrados juntamente com o mesmo. Ao clicar no botão “Ligar para Telefone”, ocorre uma requisição HTTP onde será feito o envio dos parâmetros de chamada. Um listner HTTP fará a tratativa dos parâmetros para iniciar a ligação através do sistema de telefonia. Ao concluir a chamada telefônica, deve-se retornar para a ClearSale o resultado da chamada para que possamos armazenar.

Requisição

O cliente deverá optar por utilizar a requisição usando modo GET ou POST, conforme os exemplos abaixo:

POST https://{domain}:{port}/{path} HTTP/1.1
Content-Type:application/json
Accept:application/json
                                                                                      {
    "Ddi": 55,
    "Ddd": 11,
    "Number": 987654321,
    "OrderID": "ABC1234",
    "User": "joao.silva"
}

GET https://{domain}:{port}/{path}?Ddi=55&Ddd=11&Number=987654321&OrderID=1234&User=joao.silva HTTP/1.1
Content-Type:application/json

Dicionário de variáveis

Nome	Descrição	Tipo
Domain	O domínio da requisição. Exemplo: localhost	String
Port	Caso seja necessário utilizar uma porta específica para a requisição	Numérico
Path	Caso seja necessário utilizar um caminho específico. Na ausência de um caminho a requisição será feita na raiz	String
DDI	O DDI do número desejado	Numérico
DDD	O DDD do número desejado	Numérico
Number	O número de telefone desejado	Numérico
OrderID	O ID do pedido do cliente	String
User	O nome de usuário que está logado na aplicação da ClearSale	String

Retorno da Chamada

O resultado da tentativa de ligação pode ser retornado para a aplicação ClearSale na resposta da requisição HTTP realizada para o início do processo, conforme exemplo abaixo.

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "ResultID": 1,
    "CallID": "1234"
}

Dicionário de variáveis

Nome	Descrição	Tipo	Tamanho	Obrigatório
ResultID	Identificador do resultado da chamada. Onde: 1 - Sucesso 2 - Ocupado 3 - Ninguém Atende 4 - Telefone não Existe	Int	4	Sim
CallID	Identificador de chamada realizada.	Numérico	10	Sim