JSF Telecom - API Omnichannel

Listar Filas

Esta API fornece uma lista das filas disponíveis.

Endpoint

http://ip-do-servidor/api/v2/listar_queues.php

Método

POST

Parâmetros da Requisição

token (string): Token de autenticação fornecido na solicitação.

Exemplo de Chamada em PHP

Exemplo para Postman

 $curl = curl_init(); 
  curl_setopt_array($curl, array(
CURLOPT_URL => 'http://ip-do-servidor/api/list_queues.php',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('token' => 'token-informado-na-solicitacao'),
CURLOPT_HTTPHEADER => array(
   'Cookie: PHPSESSID=srkhor3h9lqv3d3udlb6srh62d'
),
 ));
 $response = curl_exec($curl);
 curl_close($curl);
 echo $response;

Resposta da API

A resposta da API será em formato JSON e conterá uma lista das filas disponíveis.

[
 { "nome": "Atendimento" },
 { "nome": "Suporte" },
 { "nome": "Comercial" }
]

Erros Possíveis

400 Bad Request: Requisição inválida.
401 Unauthorized: Token de autenticação inválido.
500 Internal Server Error: Erro interno do servidor.

Listar Campanhas

Esta API fornece uma lista das campanhas disponíveis.

Endpoint

http://ip-do-servidor/api/v2/list_campaign.php

Método

POST

Parâmetros da Requisição

token (string): Token de autenticação fornecido na solicitação.

Exemplo de Chamada em PHP

Exemplo para Postman

$curl = curl_init();
 curl_setopt_array($curl, array(
 CURLOPT_URL => 'http://ip-do-servidor/api/list_campaign.php',
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_ENCODING => '',
 CURLOPT_MAXREDIRS => 10,
 CURLOPT_TIMEOUT => 0,
 CURLOPT_FOLLOWLOCATION => true,
 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
 CURLOPT_CUSTOMREQUEST => 'POST',
 CURLOPT_POSTFIELDS => array('token' => 'token-informado-na-solicitacao'),
 CURLOPT_HTTPHEADER => array(
 'Cookie: PHPSESSID=srkhor3h9lqv3d3udlb6srh62d'
 ),
 ));
 $response = curl_exec($curl);
 curl_close($curl);
 echo $response;

Resposta da API

A resposta da API será em formato JSON e conterá uma lista das campanhas disponíveis.


            [
                { "id": 1, "nome": "Campanha 1", "descricao": "Descrição da Campanha 1" },
                { "id": 2, "nome": "Campanha 2", "descricao": "Descrição da Campanha 2" },
                { "id": 3, "nome": "Campanha 3", "descricao": "Descrição da Campanha 3" }
            ]

Erros Possíveis

400 Bad Request: Requisição inválida.
401 Unauthorized: Token de autenticação inválido.
500 Internal Server Error: Erro interno do servidor.

Envio de lista CSV

Esta api fornece o envio de lista CSV

Arquivo não contem cabeçalho das colunas e, as colunas devem ser separadas por ";" (ponto e vírgula).
Os dados multiplos na mesma celula devem ser separados por "," (vírgula).

Endpoint

http://ip-do-servidor/api/v2/import_mailling.php

Método

POST

Parâmetros da Requisição

token (string): Token de autenticação fornecido na solicitação.
import (booleano): true
file (files): localização arquivo

Colunas do CSV, Importante respeitar a ordem informada a seguir:

Ordem	Nome da Coluna	Exemplo
1	Nº Telefones	73991382246,7331989968
2	Nome	JSF Telecom

Demais linhas do arquivo reservado para outras informações.
Coluna 3 á 30 Diponivel para outras informações.
Importante: Informações que ultrapassar a coluna 30 serão descartadas.

Exemplo uma linha do arquivo CSV

Baixar Modelo

73991382246,7331989968; JSF Telecom; outras Informações 1; outras Informações 2; outras Informações 3; outras Informações 4; outras Informações 5; outras Informações 6; outras Informações 7; outras Informações 8; outras Informações 9; outras Informações 10; outras Informações 11; outras Informações 12; outras Informações 13; outras Informações 14; outras Informações 15; outras Informações 16; outras Informações 17; outras Informações 18; outras Informações 19; outras Informações 20; outras Informações 21; outras Informações 22; outras Informações 23; outras Informações 24; outras Informações 25; outras Informações 26; outras Informações 27; outras Informações 28;

Exemplo de Chamada em PHP

Exemplo para Postman

 $curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'http://ip-do-servidor/api/v2/import_mailling.php',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('token' => 'Token-fornecido-na-solicitação','file'=> new CURLFILE('C:\\seu\\diretório\\modelo.csv'),'import' => 'true'),
  CURLOPT_HTTPHEADER => array(
    'Cookie: PHPSESSID=srkhor3h9lqv3d3udlb6srh62d'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Resposta da API

A resposta da API será em formato JSON e conterá status, mensagem, id da lista criada

{
"success":true,
"status":"Arquivo CSV importado com sucesso!",
"id_lista":81
}

Erros Possíveis

400 Bad Request: Requisição inválida.
401 Unauthorized: Token de autenticação inválido.
500 Internal Server Error: Erro interno do servidor.