Usando a API para bloquear números

Para bloquear números usando a API é preciso utilizar a interface do sistema para gerar um
token de acesso da API.

Cumprindo esse requisito, siga os passos descritos abaixo:

1. Criar lista de bloqueio

A lista de bloqueio agrupa números que não devem ser discados pela campanha. E pode ser criada tanto pela interface quanto pela API.

Exemplo de chamada:

var axios = require("axios").default;

var options = {
  method: 'POST',
  url: 'https://exemplo.callix.com.br/api/v1/outbound_blacklists',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer {seu_token
  }'}
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

Exemplo de resposta:

{
  "data": {
    "id": 1,
    "type": "outbound_blacklists",
    "attributes": {
      "name": "Lista de bloqueios de discagem 1"
    }
  }
}

No exemplo acima, é criada uma lista de nome Lista de bloqueios de discagem 1. No retorno temos o ID 1, atribuído para a lista recém criada e que vamos utilizar para adicionar números.

2. Adicionar números a lista de bloqueio

Essa chamada adiciona um ou mais números a uma lista de bloqueio específica. O processamento dessa chamada é feito de forma assíncrona.

Exemplo de chamada:

var axios = require("axios").default;

var options = {
  method: 'POST',
  url: 'https://exemplo.callix.com.br/api/v1/outbound_blacklist_async',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer {seu_token
  }'}
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

Na chamada, no atributo import_data, deve-se enviar os números a serem bloqueados juntamente do evento 'bloqueado'.

Exemplo de resposta:

{
  "data": {
    "id": 1,
    "type": "outbound_blacklist_async",
    "attributes": {
      "status": 1,
      "import_results": []
    }
  }
}

Como o processamento é feito de forma assíncrona, no retorno da chamada temos o status da importação e também um ID do serviço de importação (job) que tratará a importação assíncrona:

Usando o ID (no exemplo, ID 1), é possível consultar o progresso da importação.

3. Consultar progresso da importação de números bloqueados

Essa chamada retorna a situação da importação. Para usá-la é necessário usar o ID do job de importação obtida no fim do passo 2 acima.

Exemplo de chamada:

var axios = require("axios").default;

var options = {
  method: 'GET',
  url: 'https://exemplo.callix.com.br/api/v1/outbound_blacklist_async/1',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer {seu_token
  }'}
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

Como neste exemplo a lista de bloqueio consultada possui ID 1, a rota chamada é a https://exemplo.callix.com.br/api/v1/outbound_blacklist_async/1.

Exemplo de resposta:

{
  "data": {
    "id": 1,
    "type": "outbound_blacklist_async",
    "attributes": {
      "status": 1,
      "import_results": []
    }
  }
}

O campo status pode assumir os seguintes valores: