Sumário

1 Sobre a API via Banco de dados........................................................................................................ 6

2 Discagem via URL.............................................................................................................................. 7
2.1 Parâmetros usados na discagem via URL..................................................................................8
2.1.1 Discando pelo número do agente.......................................................................................8
2.1.2 Discando pelo nome do agente.......................................................................................... 8
2.1.3 Discando pelo ramal........................................................................................................... 8
2.1.3.1 Sobre a discagem....................................................................................................... 8
2.2 Retorno..................................................................................................................................... 10
3 Gerando a autorização..................................................................................................................... 11
4 Integração via banco de dados......................................................................................................... 12
4.1 Lista todas as campanhas........................................................................................................ 13
4.1.1 Nome da StoredProcedure...............................................................................................13
4.1.2 Exemplo de sintaxe: ........................................................................................................ 13
4.1.3 Descrição.......................................................................................................................... 13
4.1.4 Colunas retornadas.......................................................................................................... 13
4.2 Listar informações da fila relacionada a campanha..................................................................15
4.2.1 Nome da StoredProcedure...............................................................................................15
4.2.2 Exemplo de sintaxe: ........................................................................................................ 15
4.2.3 Descrição.......................................................................................................................... 15
4.2.4 Colunas retornadas.......................................................................................................... 15
4.3 Listar informações de números discados por API.....................................................................16
4.3.1 Nome da StoredProcedure...............................................................................................16
4.3.2 Exemplo de sintaxe: ........................................................................................................ 16
4.3.3 Descrição.......................................................................................................................... 16
4.3.4 Colunas retornadas.......................................................................................................... 16
4.4 Listar uma campanha específica..............................................................................................18
4.4.1 Nome da StoredProcedure...............................................................................................18
4.4.2 Exemplo de sintaxe: ........................................................................................................ 18
4.4.3 Descrição.......................................................................................................................... 18
4.4.4 Colunas retornadas.......................................................................................................... 18
4.5 Ativar campanha....................................................................................................................... 19
4.5.1 Nome da StoredProcedure...............................................................................................19
4.5.2 Exemplo de sintaxe: ........................................................................................................ 19
4.5.3 Descrição.......................................................................................................................... 19
4.5.4 Colunas retornadas.......................................................................................................... 19

1 / 52
4.6 Desativar campanha................................................................................................................. 20
4.6.1 Nome da StoredProcedure...............................................................................................20
4.6.2 Exemplo de sintaxe: ........................................................................................................ 20
4.6.3 Descrição.......................................................................................................................... 20
4.6.4 Colunas retornadas.......................................................................................................... 20
4.7 Listar telefones que pertecem a campanha..............................................................................21
4.7.1 Nome da StoredProcedure...............................................................................................21
4.7.2 Exemplo de sintaxe: ........................................................................................................ 21
4.7.3 Descrição.......................................................................................................................... 21
4.7.4 Colunas retornadas.......................................................................................................... 21
4.8 Excluir telefone da campanha..................................................................................................22
4.8.1 Nome da StoredProcedure...............................................................................................22
4.8.2 Descrição.......................................................................................................................... 22
4.9 Adicionar telefones a campanha............................................................................................... 23
4.9.1 Nome da StoredProcedure...............................................................................................23
4.9.2 Descrição.......................................................................................................................... 23
4.10 Consultar todas as chamadas realizadas dentro de um período a partir de um ramal...........24
4.10.1 Nome da StoredProcedure............................................................................................. 24
4.10.2 Exemplo de sintaxe: ...................................................................................................... 24
4.10.3 Descrição........................................................................................................................ 24
4.10.4 Colunas retornadas........................................................................................................ 24
4.11 Consultar todas as chamadas recebidas em um ramal dentro de um período ......................25
4.11.1 Nome da StoredProcedure.............................................................................................25
4.11.2 Exemplo de sintaxe: ....................................................................................................... 25
4.11.3 Descrição........................................................................................................................ 25
4.11.4 Colunas retornadas......................................................................................................... 25
4.12 Listar telefones da campanha que não foram discados..........................................................26
4.12.1 Nome da StoredProcedure............................................................................................. 26
4.12.2 Exemplo de sintaxe: ...................................................................................................... 26
4.12.3 Descrição........................................................................................................................ 26
4.12.4 Colunas retornadas........................................................................................................ 26
4.13 Listar os agentes cadastrados no PBXIP...............................................................................27
4.13.1 Nome da StoredProcedure............................................................................................. 27
4.13.2 Exemplo de sintaxe: ...................................................................................................... 27
4.13.3 Descrição........................................................................................................................ 27
4.13.4 Colunas retornadas........................................................................................................ 27
4.14 Listar as pausas cadastrados no PBXIP.................................................................................28

2 / 52
 4.14.1 Nome da StoredProcedure............................................................................................. 28
4.14.2 Exemplo de sintaxe: ...................................................................................................... 28
4.14.3 Descrição........................................................................................................................ 28
4.14.4 Colunas retornadas........................................................................................................ 28
4.15 Listar os departamentos cadastrados no PBXIP....................................................................29
4.15.1 Nome da StoredProcedure............................................................................................. 29
4.15.2 Exemplo de sintaxe: ...................................................................................................... 29
4.15.3 Descrição........................................................................................................................ 29
4.15.4 Colunas retornadas........................................................................................................ 29
4.16 Listar os eventos de Login e logout dos agentes de um período............................................30
4.16.1 Nome da StoredProcedure............................................................................................. 30
4.16.2 Exemplo de sintaxe: ...................................................................................................... 30
4.16.3 Descrição........................................................................................................................ 30
4.16.4 Colunas retornadas........................................................................................................ 30
4.17 Listar as filas que o agente tem permissão de se logar..........................................................31
4.17.1 Nome da StoredProcedure............................................................................................. 31
4.17.2 Exemplo de sintaxe: ...................................................................................................... 31
4.17.3 Descrição........................................................................................................................ 31
4.17.4 Colunas retornadas........................................................................................................ 31
4.18 Adicionar contato a campanha................................................................................................ 32
4.18.1 Nome da StoredProcedure............................................................................................. 32
4.18.2 Exemplo de sintaxe: ...................................................................................................... 32
4.18.3 Descrição........................................................................................................................ 32
4.18.4 Colunas retornadas........................................................................................................ 32
4.19 Listar telefones do contato pelo id do contato........................................................................33
4.19.1 Nome da StoredProcedure............................................................................................. 33
4.19.2 Exemplo de sintaxe: ...................................................................................................... 33
4.19.3 Descrição........................................................................................................................ 33
4.19.4 Colunas retornadas........................................................................................................ 33
4.20 Listar telefones do contato pela id externa do contato............................................................34
4.20.1 Nome da StoredProcedure............................................................................................. 34
4.20.2 Exemplo de sintaxe: ...................................................................................................... 34
4.20.3 Descrição........................................................................................................................ 34
4.20.4 Colunas retornadas........................................................................................................ 34
4.21 Excluir telefone do contato pelo id do contato........................................................................35
4.21.1 Nome da StoredProcedure............................................................................................. 35
4.21.2 Exemplo de sintaxe: ...................................................................................................... 35

3 / 52
 4.21.3 Descrição........................................................................................................................ 35
4.21.4 Colunas retornadas........................................................................................................ 35
4.22 Excluir telefone do contato pela id externa do contato...........................................................36
4.22.1 Nome da StoredProcedure............................................................................................. 36
4.22.2 Exemplo de sintaxe: ...................................................................................................... 36
4.22.3 Descrição........................................................................................................................ 36
4.22.4 Colunas retornadas........................................................................................................ 36
4.23 Listar ligações de campanha..................................................................................................37
4.23.1 Nome da StoredProcedure............................................................................................. 37
4.23.2 Exemplo de sintaxe: ...................................................................................................... 37
4.23.3 Descrição........................................................................................................................ 37
4.23.4 Colunas retornadas........................................................................................................ 37
4.24 Listar filas de atendimento...................................................................................................... 38
4.24.1 Nome da StoredProcedure............................................................................................. 38
4.24.2 Exemplo de sintaxe: ...................................................................................................... 38
4.24.3 Descrição........................................................................................................................ 38
4.24.4 Colunas retornadas........................................................................................................ 38
4.25 Adicionar campanha............................................................................................................... 39
4.25.1 Nome da StoredProcedure............................................................................................. 39
4.25.2 Exemplo de sintaxe: ...................................................................................................... 39
4.25.3 Descrição........................................................................................................................ 39
4.25.4 Colunas retornadas........................................................................................................ 39
4.26 Remover contatos não trabalhados........................................................................................40
4.26.1 Nome da StoredProcedure............................................................................................. 40
4.26.2 Exemplo de sintaxe: ...................................................................................................... 40
4.26.3 Descrição........................................................................................................................ 40
4.26.4 Colunas retornadas........................................................................................................ 40
4.27 Listar Informações de discagem do contato pelo documento do contato...............................41
4.27.1 Nome da StoredProcedure............................................................................................. 41
4.27.2 Exemplo de sintaxe: ...................................................................................................... 41
4.27.3 Descrição........................................................................................................................ 41
4.27.4 Colunas retornadas........................................................................................................ 41
4.28 Listar histórico de discagem................................................................................................... 42
4.28.1 Nome da StoredProcedure............................................................................................. 42
4.28.2 Exemplo de sintaxe: ...................................................................................................... 42
4.28.3 Descrição........................................................................................................................ 42
4.28.4 Colunas retornadas........................................................................................................ 42

4 / 52
 4.29 Exibir historico de discagem do discador................................................................................43
4.29.1 Nome da stored procedure............................................................................................. 43
4.29.2 Exemplo de sintaxe:....................................................................................................... 43
4.29.3 Descrição........................................................................................................................ 43
4.29.4 Colunas retornadas........................................................................................................ 43
4.30 Exibir histórico das chamadas discadas.................................................................................45
4.30.1 Nome da stored procedure............................................................................................. 45
4.30.2 Exemplo de sintaxe........................................................................................................ 45
4.30.3 Descrição........................................................................................................................ 45
4.30.4 Colunas retornadas........................................................................................................ 45
4.31 Limpar o mailing da campanha............................................................................................... 47
4.31.1 Nome da stored procedure............................................................................................. 47
4.31.2 Exemplo de sintaxe........................................................................................................ 47
4.31.3 Descrição........................................................................................................................ 47
4.31.4 Colunas retornadas........................................................................................................ 47
4.32 Limpar contatos da campanha................................................................................................ 48
5 Consideraçõe finais.......................................................................................................................... 49
5.1 Itens de integração Total IP via banco de dados não abordados..............................................50
5.1.1 Reagendamento, item 1.3.1.5 p.21-22.............................................................................50
5.1.2 Lista de Status de Usuário, item 1.3.1.10 p.24.................................................................50
5.1.3 Lista Status de Campanha, item 1.3.1.14 p.26-27............................................................50
5.1.4 Salvar Status em Campanha, item 1.3.1.15 p.26-27........................................................50
5.1.5 Alterar Status do Ramal, item 1.3.1.16 p.27.....................................................................50
5.2 Acentuação............................................................................................................................... 51
5.3 Acesso ao banco de dados....................................................................................................... 52
5.3.1 Conectando ao banco de dados.......................................................................................52

5 / 52
1 SOBRE A API VIA BANCO DE DADOS

A API de integração da da phone2b foi modificada para contemplar além do WSDL a

integração via banco de dados através de stored procedure.

A API da phone2b possui suporte a integração por meio do WSDL(Web Services Description
Language). O WSDL é uma solução utilizada na integração de sistemas e na comunicação entre
aplicações diferentes. Com esta tecnologia é possível que novas aplicações possam interagir com
aquelas que já existem e que sistemas desenvolvidos em plataformas diferentes sejam compatíveis.
Os Web services são componentes que permitem às aplicações enviar e receber dados em formato
XML.

A nova implementação de API da phone2b fornece acesso as informações via banco de

dados atrabés de Stored Procedures.

Stored Procedures é uma coleção de comandos em SQL que permite que sistemas externos
possam manipular ou ter acesso aos dados sem a necessidade de enviar instruções complexas para
manipular ou consultar os dados, permitindo que com poucas informações e com um código mais
enxuto, possa se ter acesso aos dados do sistema, dessa forma sistemas externos não necessitam
se preocupar em conhecer todos os metadados, tabelas, colunas, indices e etc... para realizar os
diversos relacionamentos necessários e obter a informação deseja. No núcleo da stored procedure já
são realizados todos esses tratamentos basta através de um comando simples realizar a chamada da
stored procedure correspondente a sua necessidade e enviar os parâmetro corretos, quando assim
forem necessários. Pode existir stored procedures que não necessitam da passagem de parâmetros.

6 / 52
2 DISCAGEM VIA URL

Permite realizar a discam para um número através de uma URL é necessário informar o
número de destino (quem irá receber a chamada), a chave da api (uma sequencia de caracteres
que é usada para autorizar a discagem no sistema) e a origem (quem está realizando a ligação).
A origem pode ser informada de 3 (três) formas que são: número do agente cadastrado no
phone2b, nome do agente cadastrada no agente da phone2b ou ramal de origem. Se for informado
o nome do agente ou o número do agente o sistema irá localizar o ramal associado ao agente caso
o agente esteja vinculado a algum ramal no momento da discagem. Para cada uma das 3 (três)
formas de informar a origem é necessário especificar parâmetros diferentes na URL.

7 / 52
2.1 Parâmetros usados na discagem via URL

2.1.1 Discando pelo número do agente

Ao realizar a discagem pelo agente deve ser informado o número do agente. O sistema irá
identificar qual o ramal associado ao agente, após será realizado a discagem para o destino tendo
como origem o ramal associado ao agente. Para realizar a discagem é necessário chamar a seguinte
URL:
http://<ip do phone2b>/pbxip/api/index.php?action=dial&request=number&agent=<número
do agente>&dst=<numero de destino>&key=<chave da api>

2.1.2 Discando pelo nome do agente

Ao realizar a discagem pelo nome do agente deve ser informada o nome do agente tal como
está armazenado no phone2b (aconselhavel não usar acentuação para evitar problemas de
codificação). O sistema irá identificar qual o ramal associado ao agente, após será realizado a
discagem para o destino tendo como origem o ramal associado ao agente. Para realizar a discagem é
necessário chamar a seguinte URL:
http://<ip do phone2b>/pbxip/api/index.php?action=dial&request=number&guest=<nome do
agente>&dst=<numero de destino>&key=<chave da api>

2.1.3 Discando pelo ramal

Será realizado a discagem para o destino tendo como origem o ramal informado. Para
realizar a discagem é necessário chamar a seguinte URL:
http://<ip do phone2b>/pbxip/api/index.php?action=dial&request=number&src=<ramal de
origem>&dst=<numero de destino>&key=<chave da api>

2.1.3.1 Sobre a discagem

Para realizar a discagem na phone2b é necessário chamar a seguinte URL:

http://<ip do phone2b>/pbxip/api/index.php?action=dial&request=number&guest=<nome do

agente>&dst=<numero de destino>&key=<chave da api>

Ao realizar a chamada dessa URL o próprio Servidor PBXIP vai realizar a discagem e enviar
diretamente para o ramal onde o agente estiver logado, esteja ele usando um softphone, ramal,
telefone ATA, smartphone ou etc... basta o agente estar associado ao ramal.

Nesse ambiente não é obrigatório o uso de softphone para que seja

possível realizar a discagem.

8 / 52
 Ao realizar a discagem o servidor exibe imetiatamente o resumo da

discagem em linguagem XML que pode ser facilmente interpretado e usado

em integrações para saber para qual ramal está sendo enviada a ligação ou

mesmo o status da ligação.

9 / 52
2.2 Retorno

A requisião irá retornar um XML com informações sobre o pedido de discagem.

<dial>
<information>
<src>Número do ramal de origem</src>
<dst>Número do destino a ser discado</dst>
<response>Situação da discagem</response>
<message>Descrição da situação da discagem</message>
</information>
</dial>

10 / 52
3 GERANDO A AUTORIZAÇÃO

Para gerar a autorização é necessário se autenticar no phone2b com o usuário de assistência

remota e criar uma chave para acesso. É possível criar uma API para acesso entrando em Sistema /
Configurações / API e clicar no botão de adicionar uma nova API, a chave gerada pela API deverá
ser usada par permitir o acesso a discagem via URL.

A API de discagem pode usar uma das chaves já existentes.

11 / 52
4 INTEGRAÇÃO VIA BANCO DE DADOS

As integrações via banco de dados são executadas através de stored procedures, por meio
delas sistemas externos podem ter acesso a informações do pbxip ou ainda interagir de modo a
alimentar a base de dados:

12 / 52
4.1 Lista todas as campanhas

4.1.1 Nome da StoredProcedure

getCampaignInformation

4.1.2 Exemplo de sintaxe:

CALL api.getCampaignInformation();
Nesse ambiente o acesso é feito através de stored procedure os

dados a serem recuperados são o número da campanha, nome da

campanha, quantidade de números inseridos na campanha, quantidade de

chamadas já atendidas, quantidade de telefones que ainda não foram

discados, quantidade de números que estão sendo discados, quantidede

de números que já foram discados, fila relacionada a campanha e status

da campanha (se está ativo = 1 ou se não está ativo = 0).

4.1.3 Descrição

A Stored Procedure irá exibir todas as campanhas cadastradas no PBXIP esteja ela ativa ou
não. Essa stored procedure não necessita da passagem de parâmetros.

4.1.4 Colunas retornadas

• id (INT): Número da campanha

• name (VARCHAR(64)): Nome da campanha

• total (INT): Quantide de números inseridos na campanha

• answered (INT): Chamadas atendidas

• nodial (INT): Quantidede números não discados

• dialing (INT): Quantidade de números que estão sendo discados

• dial (INT): Quantidede de números que já foram discados (inclui as chamadas que obtiverem
sucesso e falha)

• queue (CHAR(4)): Número da fila de atendimento vinculada a campanha

• contact (INT): Quantidade de contatos cadastrados na campanha

13 / 52
• contact_pending: Quantidade de contatos não trabalhados

• contact_finished: Quantidade de contatos trabalhados

• status (ENUM('0','1')): Informa se a campanha está ativada (valor '1') ou desativada (valor '0').

14 / 52
4.2 Listar informações da fila relacionada a campanha

4.2.1 Nome da StoredProcedure

getQueueInformation

4.2.2 Exemplo de sintaxe:

CALL api.getQueueInformation();

As ligações da campanha são relacionadas a uma fila de espera,

esse relacionamento permite definr infomações relativas a origem das

chamadas.

4.2.3 Descrição

A Stored Procedure irá exibir informações sobre as filas relacionadas as campanhas

cadastradas no PBXIP estejam elas ativa ou não.

4.2.4 Colunas retornadas

• id (INT): Número da campanha

• name (VARCHAR(64)): Nome da campanha

• agents (INT): Quantidade de agentes vinculados a fila associada a campanha

• agents_logged (INT): Quantidade de agentes logados vinculados a fila associada a

campanha

• queue (CHAR(4)): Número da fila de atendimento vinculada a campanha

• queuename (VARCHAR(128)): Nome da fila de atendimento vinculada a campanha

• status: Informa se a campanha está ativada (valor '1') ou desativada (valor '0').

15 / 52
4.3 Listar informações de números discados por API

4.3.1 Nome da StoredProcedure

GetStatusFromDialAPI

4.3.2 Exemplo de sintaxe:

CALL api.GetStatusFromDialAPI('2');

Nesse caso o phone2b traz campos a menos, pois não envia

diretamente as informações de tarifação. Para o funcionamento dessa

stored procedure é necessário a passagem de parâmetro, esse parâmetro é

o ID da fila.

4.3.3 Descrição

Essa Stored Procedure necessida da passagem de parâmetro o parâmetro a ser informado é

um número inteiro, esse parâmetro indica quantos dias anteriores a data atual devem ser
analisados. Os dados serão analisados sempre a partir das 00h 00 min 00s do dia. Se o valor
informado for 0 será alisado o registro de ligação desde o dia atual às 00:00:00 até o momento atual.
Essa stored procedure irá trazer registros de ligação de todos os números discados pela API usado o
recurso CLICK2CALL. Os resultados das chamadas realizadas por discagem via URL podem ser
consultados a partir dessa stored procedure.

4.3.4 Colunas retornadas

• datestart - (Datetime): Data do início da chamada

• dateend (Datetime): Data do fim da chamada

• src (VARCHAR(80)): Número que originou a chamada

• dst (VARCHAR(80)): Número de destino da chamada

• duration (INT): Duração da chamada

• status (VARCHAR(45)): Situação da chamada os valores possíveis são: ANSWERED

(chamadas atendidas), BUSY (número de destino estava ocupado), FAILED (falha ao realizar
a chamada) ou NO ANSWER (não atendida).

16 / 52
• type (VARCHAR(1)) : Informa o tipo da chamada os valores possíveis são: E (Entrante), S
(Saínte) ou I (Interna).

17 / 52
4.4 Listar uma campanha específica

4.4.1 Nome da StoredProcedure

getCampaignInformationByNumber

4.4.2 Exemplo de sintaxe:

CALL api.getCampaignInformationByNumber('2');

4.4.3 Descrição

Essa Stored Procedure necessida de passagem de parâmetro o parâmetro a ser informado é

o número da campanha, se for informado uma campanha que não existe a coluna total terá o valor 0
e as demais colunas o valor nulo.

4.4.4 Colunas retornadas

• id (INT): Número da campanha

• name (VARCHAR(64)): Nome da campanha

• total (INT): Quantide de números inseridos na campanha

• answered (INT): Chamadas atendidas

• nodial (INT): Quantidede números não discados

• dialing (INT): Quantidade de números que estão sendo discados

• dial (INT): Quantidede de números que já foram discados (inclui as chamadas que obtiverem
sucesso e falha)

• queue (CHAR(4)): Número da fila de atendimento vinculada a campanha

• contact (INT): Quantidade de contatos cadastrados na campanha

• contact_pending: Quantidade de contatos não trabalhados

• contact_finished: Quantidade de contatos trabalhados

• status (ENUM('0','1')): Informa se a campanha está ativada (valor '1') ou desativada (valor '0')

18 / 52
4.5 Ativar campanha

4.5.1 Nome da StoredProcedure

turnOnCampaign

4.5.2 Exemplo de sintaxe:

CALL api.turnOnCampaign('2');

4.5.3 Descrição

Essa Stored Procedure necessita de passagem de parâmetro o parâmetro a ser informado é

um número inteiro, esse parâmetro é o número da campanha, essa stored procedure não retorna
resultados. Ao ser executada irá ativar a campanha.

4.5.4 Colunas retornadas

Não há retornos para essa stored procedure

19 / 52
4.6 Desativar campanha

4.6.1 Nome da StoredProcedure

turnOffCampaign

4.6.2 Exemplo de sintaxe:

CALL api.turnOffCampaign('2');

4.6.3 Descrição

Essa Stored Procedure necessita de passagem de parâmetro o parâmetro a ser informado é

o número da campanha, essa stored procedure não retorna resultados. Ao ser executada irá
desativar a campanha.

4.6.4 Colunas retornadas

Não há retornos para essa stored procedure

20 / 52
4.7 Listar telefones que pertecem a campanha

4.7.1 Nome da StoredProcedure

getCampaignNumbers

4.7.2 Exemplo de sintaxe:

CALL api.getCampaignNumbers('2');

4.7.3 Descrição

Essa Stored Procedure necessida de passagem de parâmetro o parâmetro a ser informado é

o número da campanha.

4.7.4 Colunas retornadas

• id (INT) : Número único de identificação do telefone

• phone (VARCHAR(128)): Número do telefone vinculado a campanha a ser discado

• reference (VARCHAR(128)): Identificação do número do telefone vinculado a campanha a ser

discado.

• status (ENUM('0','1','2','3')): Informação sobre chamada realizadas pela campanha, os valores

possíveis são: '0' (Não foi enviada ligação), '1' (Tentando realizar a discagem), 2 (Falha ao
realizar a discagem) ou 3 (Chamada realizada com sucesso).

• attempts (INT): Quantidade de tentativas de discagem realizadas para o número.

• time_retry (TIMESTAMP): Data da proxima tentativa de discagem.

21 / 52
4.8 Excluir telefone da campanha

4.8.1 Nome da StoredProcedure

deletePhoneFromCampaign

4.8.2 Descrição

Essa Stored Procedure foi removida, o motivo é que sua funcionalidade foi desenvolvida para
remover o contato e seu telefone, quando o discador suportava suporta apenas um telefone por
contato, não atendendo necessidades dos clientes, para remover telefones à campanha consulte um
dos seguintes itens:

4.21 Excluir telefone do contato pelo id do contato p. 35

4.22 Excluir telefone do contato pela id externa do contato p. 36

22 / 52
4.9 Adicionar telefones a campanha

4.9.1 Nome da StoredProcedure

addPhoneToCampaign

4.9.2 Descrição

Essa Stored Procedure foi removida, o motivo é que somente suporta um telefone por
contato, não atendendo necessidades dos clientes, para adicionar telefones à campanha consulte o
item: 4.18 Adicionar contato a campanha p.32

23 / 52
4.10 Consultar todas as chamadas realizadas dentro de um período a partir de um
ramal

4.10.1 Nome da StoredProcedure

listOutgoingCall

4.10.2 Exemplo de sintaxe:

CALL api.listOutgoingCall('2');

4.10.3 Descrição

Essa Stored Procedure necessita da passagem de parâmetro o parâmetro a ser informado é

um número inteiro, esse parâmetro indica quantos dias anteriores a data atual devem ser
analisados.

Os dados serão analisados sempre a partir das 00h 00 min 00s do dia. Se o valor informado
for 0 será alisado o registro de ligação desde o dia atual as 00:00:00 até o momento atual. Essa
stored procedure irá trazer registros de ligação de todas as chamadas saíntes do PBXIP dentro do
período definido realizadas para um ramal.

Exibe todas as chamadas saíntes para ramais dos ultimos N dias.

4.10.4 Colunas retornadas

• datestart - (Datetime): Data do início da chamada

• dateend (Datetime): Data do fim da chamada

• branch (VARCHAR(80)): Ramal que originou a chamada

• phone (VARCHAR(80)): Número de destino da chamada

• duration (INT): Duração da chamada

• status (VARCHAR(45)): Situação da chamada os valores possíveis são: ANSWERED

(chamadas atendidas), BUSY (número de destino estava ocupado), FAILED (falha ao realizar
a chamada) ou NO ANSWER (não atendida).

24 / 52
4.11 Consultar todas as chamadas recebidas em um ramal dentro de um período

4.11.1 Nome da StoredProcedure

listIncomingCall

4.11.2 Exemplo de sintaxe:

CALL api.listIncomingCall('2');

4.11.3 Descrição

Essa Stored Procedure necessita da passagem de parâmetro o parâmetro a ser informado é

um número inteiro, esse parâmetro indica quantos dias anteriores a data atual devem ser
analisados.

Os dados serão analisados sempre a partir das 00h 00 min 00s do dia. Se o valor informado
for 0 será alisado o registro de ligação desde o dia atual as 00:00:00 até o momento atual. Essa
stored procedure irá trazer registros de ligação de todas as chamadas entrantes do PBXIP dentro do
período definido, realizadas para um ramal.

4.11.4 Colunas retornadas

• datestart - (Datetime): Data do início da chamada

• dateend (Datetime): Data do fim da chamada

• phone (VARCHAR(80)): Número que originou a chamada

• branch (VARCHAR(80)): Ramal que recebeu a chamada

• duration (INT): Duração da chamada

• status (VARCHAR(45)): Situação da chamada os valores possíveis são: ANSWERED

(chamadas atendidas), BUSY (número de destino estava ocupado), FAILED (falha ao realizar
a chamada) ou NO ANSWER (não atendida).

25 / 52
4.12 Listar telefones da campanha que não foram discados

4.12.1 Nome da StoredProcedure

getCampaignNumberNotCalled

4.12.2 Exemplo de sintaxe:

CALL api.getCampaignNumberNotCalled('2');

4.12.3 Descrição

Essa Stored Procedure necessida da passagem de parâmetro o parâmetro a ser informado é

o número da campanha.

4.12.4 Colunas retornadas

• id (INT) : Número único de identificação do telefone

• phone (VARCHAR(128)): Número do telefone vinculado a campanha a ser discado

• reference (VARCHAR(128)): Identificação do número do telefone vinculado a campanha a ser

discado.

• attempts (INT): Quantidade de tentativas de discagem realizadas para o número.

• time_retry (TIMESTAMP): Data da proxima tentativa de discagem.

26 / 52
4.13 Listar os agentes cadastrados no PBXIP

4.13.1 Nome da StoredProcedure

getAgents

4.13.2 Exemplo de sintaxe:

CALL api.getAgents();

4.13.3 Descrição

Essa Stored Procedure não necessida da passagem de parâmetro, após executada irá listar
todos os agentes cadastrados no phone2b.

4.13.4 Colunas retornadas

• agent (VARCHAR(16)) : Número do agente

• agentname (VARCHAR(150)): Nome do agente

• email (VARCHAR(50)): E-mail do agente

• departmentname (VARCHAR(255)): Nome do departamento ao qual o agente está vinculado

(se o agente não estiver vinculado a nenhum departamento esse valor será nulo).

• login (INT): Informa se o agente está logado o campo assumirá o valor '1' se o agente estiver
logando, ou assumirá o valor '0' se o agente estiver deslogado.

• branch (VARCHAR(11)): Ramal ao qual o agente está associado (se o agente não estiver
associado a nenhum ramal esse campo terá o valor nulo).

27 / 52
4.14 Listar as pausas cadastrados no PBXIP

4.14.1 Nome da StoredProcedure

getPauses

4.14.2 Exemplo de sintaxe:

CALL api.getPauses();

4.14.3 Descrição

Essa Stored Procedure não necessida da passagem de parâmetro, após executada irá listar
todas as pausas cadastrados no phone2b.

4.14.4 Colunas retornadas

• reason (INT) : Número do da pausa

• name (VARCHAR(255)): Nome da pausa

28 / 52
4.15 Listar os departamentos cadastrados no PBXIP

4.15.1 Nome da StoredProcedure

getDepartments

4.15.2 Exemplo de sintaxe:

CALL api.getDepartments();

4.15.3 Descrição

Essa Stored Procedure não necessida da passagem de parâmetro, após executada irá listar
todas os departamentos cadastrados no phone2b.

4.15.4 Colunas retornadas

• number (INT) : Número do departamento

• departmentname (VARCHAR(255)): Nome do departamento

29 / 52
4.16 Listar os eventos de Login e logout dos agentes de um período

4.16.1 Nome da StoredProcedure

getAgentLoginStatus

4.16.2 Exemplo de sintaxe:

CALL api.getAgentLoginStatus('2');

4.16.3 Descrição

Essa Stored Procedure necessita da passagem de parâmetro o parâmetro a ser informado é

um número inteiro, esse parâmetro indica quantos dias anteriores a data atual devem ser
analisados. Os dados serão analisados sempre a partir das 00h 00 min 00s do dia. Se o valor
informado for 0 será alisado o registro de ligação desde o dia atual as 00:00:00 até o momento atual.
Essa stored procedure irá trazer registros de login de todos os agentes que se logaram a partir do
inicio do período definido.

4.16.4 Colunas retornadas

• datestart (DATETIME) : Data em que o agente se logou no pbxip.

• dateend (DATETIME): Data em que o agente se deslogou do pbxip.

• logintime(INT): Tempo que o agente ficou logado no sistema (a unidade de medida de tempo
são os segundos).

• branch (VARCHAR(80)): Ramal que estava associado ao agente durante o tempo que ele
estava logado.

• agent (VARCHAR(16)) : Número do agente.

• uid: Número único interno de identificação do evento analisado para extrair a informação.

30 / 52
4.17 Listar as filas que o agente tem permissão de se logar

4.17.1 Nome da StoredProcedure

getAgentQueueStatus

4.17.2 Exemplo de sintaxe:

CALL api.getAgentQueueStatus('100');

4.17.3 Descrição

Essa Stored Procedure necessita da passagem de parâmetro o parâmetro a ser informado é

o número do agente.

4.17.4 Colunas retornadas

• queue (VARCHAR(4)) : Número da fila

• queuename (VARCHAR(128)): Nome da fila

• login (INT): Informa se o agente está logado na fila (o campo assumirá o valor '1' se o agente
estiver logado) ou se o agente está deslogado (o campo assumirá o valor '0' se o agente
estiver deslogado)

• paused (VARCHAR(11)): Informa se o agente está pausado na fila o campo assumirá o valor
'1' se o agente estiver pausado ou assumirá o valor '0' se o agente estiver despausado.

31 / 52
4.18 Adicionar contato a campanha

4.18.1 Nome da StoredProcedure

addContactToCampaign

4.18.2 Exemplo de sintaxe:

CALL
api.addContactToCampaign('2','5521987654321','Telefone','0000000','12345678900','23');

4.18.3 Descrição

Essa Stored Procedure necessita de passagem de parâmetros os parâmetros a serem

informados são respectivamente o número da campanha, número do telefone, referência (usado
para identificar o telefone de uma forma mais amigável) , número do documento (usado para
identificar o contato como único, pode ser um CPF, CNPJ ou etc..) , extra (campo extra para passar
informações adicionais, podendo ser um texto de até 64 caracteres), id extra (campo extra para
passar informações adicionais sendo um inteiro).

4.18.4 Colunas retornadas

• code (INT): Exibe o código do erro, os valores possíveis são: -1 (Se o código do campanha
informada não for encontrado), -2 (Se o número de telefone informado já estiver associado a
campanha) ou número único de identificação do contato (id do contato) da campanha
informada se não ocorrer nenhum erro.

• message (TEXT): Exibe uma mensagem relativa ao erro, os valores possíveis são:
“Campaign not found” (se o código do campanha informada não for encontrado), “Phone
already exists” (se o número de telefone informado já estiver associado a campanha) ou
“Sucess” (se o número for inserido com sucesso).

32 / 52
4.19 Listar telefones do contato pelo id do contato

4.19.1 Nome da StoredProcedure

listPhoneContactById

4.19.2 Exemplo de sintaxe:

CALL api.listPhoneContactById('2');

4.19.3 Descrição

Essa Stored Procedure necessita de passagem de parâmetro o parâmetro a ser informado é

o id do contato. Ela exibe os números de telefone cadastrados para um contato. Cada registro trará
as informações do contato e um número de telefone.

Na phone2b são exibidos todos os telefones do contato, assim como o status de cada um.
Para realizar essa consulta é necessário informar o ID do contato.

4.19.4 Colunas retornadas

• contactId (INT): ID do contato, número único de identificação do contato no equipamento

phone2b.

• campaignId (INT): ID da campanha, número único de identificação da campanha no

equipamento phone2b.

• name (VARCHAR(128)): Nome do contato.

• optional (VARCHAR(255)): Campo opcional cadastrado para o contato.

• document (VARCHAR(64)): Documento do contato.

• phoneId (INT): ID do telefone do contato, número único de identificação do telefone do

contato no equipamento phone2b.

• phone (VARCHAR(32)) : Número de telefone do contato.

• date (Datetime): Data da ultima tentativa de discagem para o número, se não tiver sido
efetuanada nenhuma tentativa esse valor será nulo.

• status (INT): Informação sobre chamada realizada pela campanha, os valores possíveis são:
'0' (Não foi enviada ligação), '1' (Tentando realizar a discagem), 2 (Falha ao realizar a
discagem) ou 3 (Chamada realizada com sucesso).

33 / 52
4.20 Listar telefones do contato pela id externa do contato

4.20.1 Nome da StoredProcedure

listPhoneContactByGuestId

4.20.2 Exemplo de sintaxe:

CALL api.listPhoneContactByGuestId('2');

4.20.3 Descrição

Essa Stored Procedure necessita de passagem de parâmetro o parâmetro a ser informado é

o guestId1. Ela exibe os números de telefone cadastrados para um contato. Cada registro trará as
informações do contato e um número de telefone.

4.20.4 Colunas retornadas

• contactId (INT): ID do contato, número único de identificação do contato no equipamento

phone2b.

• campaignId (INT): ID da campanha, número único de identificação da campanha no

equipamento phone2b.

• name (VARCHAR(128)): Nome do contato.

• optional (VARCHAR(255)): Campo opcional cadastrado para o contato.

• document (VARCHAR(64)): Documento do contato.

• phoneId (INT): ID do telefone do contato, número único de identificação do telefone do

contato no equipamento phone2b.

• phone (VARCHAR(32)) : Número de telefone do contato.

• date (Datetime): Data da ultima tentativa de discagem para o número, se não tiver sido
efetuanada nenhuma tentativa esse valor será nulo.

• status (INT): Informação sobre chamada realizada pela campanha, os valores possíveis são:
'0' (Não foi enviada ligação), '1' (Tentando realizar a discagem), 2 (Falha ao realizar a
discagem) ou 3 (Chamada realizada com sucesso).

1 O guestId é um número fornecido pela entidade que está realizando a integração, foi criado para
que o integrador possa enviar por exemplo a sua próprio identificado (chave primaria ou etc...)
para facilitar na consulta dos dados.

34 / 52
4.21 Excluir telefone do contato pelo id do contato

4.21.1 Nome da StoredProcedure

deleteContactPhoneByContactId

4.21.2 Exemplo de sintaxe:

CALL api.deleteContactPhoneByContactId('2', '9087654321');

4.21.3 Descrição

Essa Stored Procedure necessita de passagem de parâmetro os parâmetros a serem

informados são id contato e o número de telefone a ser excluído.

4.21.4 Colunas retornadas

Essa stored procedure não retorna nenhum dado

35 / 52
4.22 Excluir telefone do contato pela id externa do contato

4.22.1 Nome da StoredProcedure

deleteContactPhoneByGuestId

4.22.2 Exemplo de sintaxe:

CALL api.deleteContactPhoneByGuestId('2', '9087654321');

4.22.3 Descrição

Essa Stored Procedure necessita de passagem de parâmetro os parâmetros a serem

informados são guestId2 (id externo do contato) e o número de telefone a ser excluído.

4.22.4 Colunas retornadas

Essa stored procedure não retorna nenhum dado

2 O guestId é um número fornecido pela entidade que está realizando a integração, foi criado para
que o integrador possa enviar por exemplo a sua próprio identificado (chave primaria ou etc...)
para facilitar na consulta dos dados.

36 / 52
4.23 Listar ligações de campanha

4.23.1 Nome da StoredProcedure

listCallsFromCampaign

4.23.2 Exemplo de sintaxe:

CALL api.listCallsFromCampaign();

4.23.3 Descrição

Essa Stored Procedure não necessita de passagem de parâmetro, através dela é possível
visualizar todas as ligações de campanha que estão ocorrendo do PBXIP e ainda não foram
visualizadas, após a execução dessa stored procedure as chamadas já exibidas não serão mostradas
novamente, mesmo que ainda estejam ocorrendo no PBXIP.

4.23.4 Colunas retornadas

• campaign_id (INT): ID da campanha, número único de identificação da campanha no

equipamento phone2b.

• campaign_name (VARCHAR(64)): Nome da campanha.

• spool_id (INT): Número interno de controle.

• src VARCHAR(100)): Número do ramal que está originando a chamada.

• dst (VARCHAR(32)) : Número de telefone do contato.

• queue (CHAR(4)) : Número da fila relacionada a campanha.

• queuename (VARCHAR(128)) : Nome da fila relacionada a campanha

• date (Datetime): Data que a ligação foi registrada no sistema

• document (VARCHAR(64)): Documento do contato.

• optional (VARCHAR(255)): Campo opcional cadastrado para o contato.

• guest_id (INT): É um número fornecido pela entidade que está realizando a integração.

• agent (VARCHAR(16)): Número do agente.

• agentname(VARCHAR(150)): Nome do agente.

37 / 52
4.24 Listar filas de atendimento

4.24.1 Nome da StoredProcedure

getQueues

4.24.2 Exemplo de sintaxe:

CALL api.getQueues();

4.24.3 Descrição

Essa Stored Procedure não necessita de passagem de parâmetro, através dela é possível
visualizar todas as filas de atendimento cadastradas no PBXIP.

4.24.4 Colunas retornadas

• id (INT): ID da fila de atendimento , número único de identificação da fila de atendimento no

equipamento phone2b.

• queue (VARCHAR(4)): Número da fila de atendimento.

• queuename (VARCHAR(128)): Nome da fila de atendimento.

38 / 52
4.25 Adicionar campanha

4.25.1 Nome da StoredProcedure

addCampaign

4.25.2 Exemplo de sintaxe:

CALL api.addCampaign('1','Teste','Campnha de testes');

4.25.3 Descrição

Essa Stored Procedure necessita de passagem de parâmetro os parametros a serem

informados são: id da fila de atendimento, nome da campanha, descrição da campanha. O nome
da campanha deve ser único, o sistema não irá cadastrar campanhas com nome duplicado.

4.25.4 Colunas retornadas

• id (INT): ID da campanha, número único de identificação da campanha no equipamento

phone2b (caso a campanha já exista, irá retornar o id da campanha cadastrada).

39 / 52
4.26 Remover contatos não trabalhados

4.26.1 Nome da StoredProcedure

deleteContactNotWorked

4.26.2 Exemplo de sintaxe:

CALL api.deleteContactNotWorked('1');

4.26.3 Descrição

Essa Stored Procedure necessita de passagem de parâmetro os parametros a serem

informados são: id da campanha. Ela irá remover todos os contatos ainda não trabalhados da
campanha.

4.26.4 Colunas retornadas

• Não há retorno

40 / 52
4.27 Listar Informações de discagem do contato pelo documento do contato

4.27.1 Nome da StoredProcedure

getDialInformationFromContactByDocument

4.27.2 Exemplo de sintaxe:

CALL api.getDialInformationFromContactByDocument('1010121321');

4.27.3 Descrição

Essa Stored Procedure necessita de passagem de parâmetro o parametro a ser informado é

o : número do documento do contato. O sistema irá retornar todos os telefones do contato e suas
respectivas situações de discagem.

4.27.4 Colunas retornadas

• campaign_id (INT): ID da campanha, número único de identificação da campanha no

equipamento phone2b

• phone (VARCHAR(32)): Número do telefone do contato

• name (VARCHAR(128)): Nome do contato

• document (VARCHAR(64)): Número do documento do contato

• optional (VARCHAR(255)): Campo opcional de informação do contato, fornecido ao cadastrar

o contato

• guest_id (INT): campo extra usado para identificar o contato

• date (Datetime): Data do último evento de ligação para o número do contato

• status (INT): Status da discagem

• reason (INT): Motivo usado pelo operador para classificar a ligação

• queue (VARCHAR(4)): Fila de atendimento associada a campanha

• queuename (VARCHAR(128)): Nome da fila de atendimento associada a campanha

41 / 52
4.28 Listar histórico de discagem

4.28.1 Nome da StoredProcedure

getCallHistory

4.28.2 Exemplo de sintaxe:

CALL api.getCallHistory();

4.28.3 Descrição

Essa Stored Procedure não necessita de passagem de parâmetro. O sistema irá retornar
todos os números discados nos ultimos 3 dias a partir das 00h 00min e 00s.

4.28.4 Colunas retornadas

• datestart (Datetime): Data do inicio da chamada

• dateend (Datetime): Data do fim da chamada

• src (VARCHAR(80)):Número de origem

• dst (VARCHAR(80)): Número de destino

• duration (INT): Duração da chamada

• status (VARCHAR(45)): Indica a situação do chamada, os valores possíveis são:

'ANSWERED' (atendida), 'BUSY' (ocupada), 'FAILED' (falha), 'NO ANSWER' (não atendida).

• type CHAR(1): Indica o tipo de chamada, os valores possíveis são: 'E' (entrante), 'S' (sainte)
e 'I' (interna)

• id_campaign (INT): ID da campanha

• guest_id (INT): campo extra usado para identificar o contato

• contact_name (VARCHAR(128)): Nome do contato

• optional (VARCHAR(255)): Campo opcional de informação do contato, fornecido ao cadastrar

o contato

• document (VARCHAR(64)): Número do documento do contato

42 / 52
4.29 Exibir historico de discagem do discador

4.29.1 Nome da stored procedure

getDialStatusByQueue

4.29.2 Exemplo de sintaxe:

CALL `api`.`getDialStatusByQueue` ('706',DATE_SUB(CURRENT_TIMESTAMP, INTERVAL 2

HOUR), CURRENT_TIMESTAMP());

4.29.3 Descrição

Essa Stored Procedure necessita de passagem de parâmetro o parâmetro a ser informado é

o número da fila de espera, a data inicial e a data final. Ela exibe estatisticas sobre os numeros já
discados pelo campanha.

As estatisticas exibidas pode apresentar um valores superiores a quantidade de numeros

cadastrados na companha, pois o discador pode ligar para um numero mais de uma vez afim de
tentar um contato valido com o numero de telefone do contato.

4.29.4 Colunas retornadas

• total (INT): Quantidade de discagem no período analizado.

• abandon (INT): Quantidade de discagens que após entrarem na fila de atendimento
abandonaram a chamada.
• busy (INT): Quantidade de discagem realizadas que receberam o sinal de ocupado
• cancel (INT): Quantidade de discagem canceladas (rejeitou a chamada ou tocou e não
atendeu)
• congestion (INT): Quantidade de discagem com falhas ou que não conseguiram ser
completadas pois os troncos estavam ocupados.
• dial (INT): Quantidades de discagem que estao sendo iniciadas
• failure (INT): Quantidade de discagens que falharam (numero invalido, inexistente, desativado
, rota invalida, não processado pelo tronco e etc...).
• inqueue (INT): Quantidades de discagem que foram enviadas para a fila de espera.
• noroute (INT): Quantidades de discagem que não tinham rota de saida (sem permissao para
realizar a discagem)
• machine (INT): Quantidade de discagem que foram reconhecida como maquina (caixa postal,
mensagem da operadora, ligacao muda e etc...)

43 / 52
• success (INT): Quantidade de discagem que foram enviadas para a fila de atendimento.
• timeout (INT): Quantidade de discagem que encerraram por timeout (atingiu o tempo máximo
de espera na discagem e não foi atendida).
• trying (INT): Quantidade de discagem que estão tentando discar.
• unavailable (INT): Quantidade de discagem que foram geradas mas não foram realizadas por
todos os canais do tronco estarem em uso.
• Date (DATETIME): Data do período analisado.
• queue (VARCHAR(16)): Fila de atendimento que esta sendo analisada.
• interval (TIME): Periodo que esta sendo analisado (o periodo analisado é agrupado po
quantidade de registros a cada 5 minutos)

44 / 52
4.30 Exibir histórico das chamadas discadas

4.30.1 Nome da stored procedure

getLastDialByQueue

4.30.2 Exemplo de sintaxe

call api.getLastDialByQueue('706',DATE_SUB(CURRENT_TIMESTAMP, INTERVAL 2

HOUR), CURRENT_TIMESTAMP());

4.30.3 Descrição

Essa Stored Procedure necessita de passagem de parâmetro o parâmetro a ser informado é

o número da fila de espera, a data inicial e a data final. Ela exibe estatisticas sobre os numeros já
discados pelo campanha.

As estatisticas exibidas pode apresentar um valores superiores a quantidade de numeros

cadastrados na companha, pois o discador pode ligar para um numero mais de uma vez afim de
tentar um contato valido com o numero de telefone do contato.

4.30.4 Colunas retornadas

iddialer_log (INT): ID do da tabela usado para identificar o registro como único.

campaignId (INT): ID da campanha
campaignname (VARCHAR(255)): Nome da campanha
contactId (INT): ID do contato
contactname (VARCHAR(255)): Nome da contato
contactdocument (VARCHAR(255)): Documento do contato
contactoptional (VARCHAR(255)): Dado adicional do contato
phoneId (INT): ID do telefone do contato
number (VARCHAR(64)): Numero de telefone a ser discado
planRouteId (INT): ID da rota de saida a ser usada
trunkId (INT): ID do tronco a ser usado
queue (VARCHAR(16)) : Numero da fila de espera
queuename (VARCHAR(255)): Nome da fila de espera
status (INT): Informa o status da discagem pode ter um dos seguintes valores ('0' => Nao
discou, '1' => Esta realizando a discagem, '2'=> Falha ao realizar a discagem, '3' => Discagem
efetuada com sucesso e numero enviado para a fila de atendimento)
log (TINYTEXT): Exibe uma mensagem informando qual o status da chamada, os valores

45 / 52
possíveis são: ("ABANDON" => Chamada enviada para a fila de atendimento e encerrada antes de
ser atendida pelo agente, "BUSY" => Discagem recebeu sinal de ocupado, "CANCEL" => Rejeitou a
chamada ou tocou e não atendeu, "CONGESTION" => Discagem com falhas ou que não
conseguiram ser completadas devido aos troncos estavam ocupados, "DIAL" => Discagem sendo
realizada, "FAILURE" => Discagem que falhou devido a numero invalido, inexistente, desativado ,
rota invalida, não processado pelo tronco e etc..., "INQUEUE" => Discagem que já foi enviada para a
fila de atendimento, posteriormente esse estado sera alterado para ”SUCCESS” ou ”ABANDON”,
"MACHINE" => discagem que foram reconhecida como maquina (caixa postal, mensagem da
operadora, ligacao muda e etc...), "NO ROUTE OR PERMISSION" => Discagem que não tinham rota
de saida (sem permissao para realizar a discagem), "SUCCESS" => Discagem que foram enviadas
para a fila de atendimento., "TIMEOUT" =>Atingiu o tempo máximo de espera na discagem e não foi
atendida, "TRYING" => Tentando discar, "UNAVALIABLE" =>Discagem que foram geradas mas não
foram realizadas por todos os canais do tronco estarem em uso, ”INVALID NUMBER” => Numero
invalido)
pool (INT): Informa se a chamada ainda está sendo trabalhada pelo serviço de discagem,
pode ter o valor 1 ou 0.
sent(DATETIME): Data e hora que a discagem foi iniciada
connect (DATETIME): Data e hora que a discagem, após ser atendida, foi enviada para a fila
de atendimento

46 / 52
4.31 Limpar o mailing da campanha

4.31.1 Nome da stored procedure

DropMailingFromCampaignById

4.31.2 Exemplo de sintaxe

call api.DropMailingFromCampaignById('4')

4.31.3 Descrição

Essa Stored Procedure necessita de passagem de parâmetro o parâmetro a ser informado é

o número da campanha. Remove todos os contatos da campanha e seus telefones.

4.31.4 Colunas retornadas

Essa procedure não retorna dados

47 / 52
4.32 Limpar contatos da campanha

clearCampaign

48 / 52
5 CONSIDERAÇÕE FINAIS

49 / 52
5.1 Itens de integração Total IP via banco de dados não abordados

5.1.1 Reagendamento, item 1.3.1.5 p.21-22

O reagendamento é feito automaticamente via software do agente, dependendo do status da

ligação.

5.1.2 Lista de Status de Usuário, item 1.3.1.10 p.24

O status do usuário é exbido na stored procedure do item 4.13; Listar os agentes cadastrados
no PBXIP p.27

5.1.3 Lista Status de Campanha, item 1.3.1.14 p.26-27

O status da campanha é exibido em duas stored procedures nos item: 4.1; Lista todas as
campanhas p. 13 e no item: 4.4; Listar uma campanha específica p.18

5.1.4 Salvar Status em Campanha, item 1.3.1.15 p.26-27

O status da ligação da campanha é feito via software do agente. É possível realizar a consulta
do status de 3 (três ) formas distintas: item 4.19; Listar telefones do contato pelo id do contato p. 33,
item 4.20; Listar telefones do contato pela id externa do contato p.34 e item: 4.23; Listar ligações de
campanha p.37

5.1.5 Alterar Status do Ramal, item 1.3.1.16 p.27

O status do ramal e alterado diretamente no dispositivo (ramal ip, softphone e etc...)

50 / 52
5.2 Acentuação

Os caracteres acentuados estão convertidos no padrão HTML.

51 / 52
5.3 Acesso ao banco de dados

Para ter acesso a stored procedure é necessário se conectar ao banco de dados com o
usuário view e sua respectiva senha, para gerar a senha do usuário view é necessário acessar
Sistemas / Configurações / Básicas e definir a senha na seção “Consulta a base de dados”, após
definido a senha basta se conectar ao banco de dados.

5.3.1 Conectando ao banco de dados

• Banco de dados: MySQL

• Porta: 3306

• Usuário: view

• Senha: <Senha definida na consulta a base de dados>

• IP: Caso o equipamento possua um servidor de call center, o IP do host deverá ser o IP do
servidor secundário de call center, do contrário deve ser o IP do servidor principal.

52 / 52