Acesse a API de integração de voz do Sonax CLICANDO AQUI para obter as requisições em diversas linguagens.
Click to Call direcionado para o ramal:
URL: https://click2call.sonax.net.br/sonax-click2call.php?numero=XXXXXXXXXX&ramal=XXX&token=XXXXXXXXXXXXXXX
Click to call direcionado para a fila:
URL: https://api.sonax.net.br/sonax-queue2call.php?telefone=Numero_discado&fila=ID_FILA&token=TOKEN_SONAX
A chamada será direcionada para um ramal disponível, caso contrário, será retornada a mensagem "Sem ramal disponível para atender a ligação".
ACÃO DO DISCADOR SONAX ENVIAR INFORMAÇÃO DO NÚMERO ATENDIDO PARA
O CRM DO CLIENTE
As seguintes variáveis podem ser informadas na URL para enviar detalhes da chamada ao CRM:
<ID_CHAMADA>: Identificador da chamada (para campanhas ou chamadas manuais).<ID_CHAMADA_ORIGINADOR>: Identificador de chamadas receptivas (quando passarem pela URA).<ID_CONTATO>: Identificação do contato (CPF, RG, ou código de cliente).<ID_CONTATO2>: Identificação do contato (apenas para chamadas manuais). Parâmetro extra que pode ser definido no momento do disparo da chamada. Exemplo: Caso o id_contato não seja informado no evento da ligação, o valor ficará em branco. Por outro lado, se for informado — por exemplo, id_contato = 1 — esse valor " 1 " poderá ser acessado posteriormente por meio da variável correspondente.<RAMAL>: Ramal direcionado.<ALIASRAMAL>: Apelido do ramal.<ALIAS2>: ID de integração do ramal no PABX.<NUMERO>: Número telefônico de origem (ou destino em campanhas).<NUMERO_REC>: Número de origem em chamadas receptivas.<AT_LOGIN>: Login do atendente.<AT_DESCRICAO>: Descrição do atendente.<ID_FILA>: Identificador da fila.<ID_CAMPANHA>: Identificador da campanha.<DATA_INICIO>: Data e hora de início da ligação.<DATA_FIM>: Data e hora de término da ligação.<STATUS_CHAMADA>: Status atual da chamada (ex.: discando, desligada, ocupada).<STATUS_ATENDIMENTO>: Indica se a ligação foi atendida (S) ou não (N).<DURACAO_CHAMADA>: Duração da chamada (disponível após o desligamento).<URA_NOME>: Nome da URA utilizada no atendimento.<URA_ITEM>: Opção da URA escolhida.<OBS_CALLTEMP>: Retorna o texto digitado no campo de OBSERVAÇÃO da tela de Agente.<URL_GRAVACAO>: Link de download da gravação. Utilizável somente na URL DE DESLIGAMENTO essa irá enviar junto do evento do desligamento da chamada a URL para download da gravação. Exemplo do formato da URL enviada:
https://gravacoes.sonax.cloud/?a=d&v=c09Vq3RDbkNSdVVaTnBRaG8yTGxITm5UOHgvWEJwOUNYNHFQWXlDb09yNVpaSVB1bmNVTUgrbFd3YWNNcVaNYndzTXZTTEVwOHl5cVdNY1Brc0NoNTZGR05T0ZDRlFYUnk1ZHRHa3JpTU5TQ0t3UExWOC15dXBPbjhwdjdqcXJtTVluMnZBNEVuM2FFK1FXVld0dlFOQklaemhheXRYMmR4Z055b0NmTjc0YXNoZnJKTnBMa1FZZk50dEhySjlLNlY1c3VQNzI3NFNOdzdmaXRKUE0rUnZhODFxMlJOeW5YZS81N0tqNW15TT0=<TABULACAO>: Tabulação realizada durante a ligação em curso. Essa variável funciona somente na URL DE DESLIGAMENTO quando a ligação for tabulada durante a chamada em curso. Ou seja, o atendente tabula a ligação enquanto está conversando e assim que desliga a chamada, a tabulação é enviada no Webhook de desligamento da fila e/ou da campanha manual<VAR1>até<VAR5>: Variáveis customizadas disponíveis apenas na API de Click to Call. Essas variáveis podem ser utilizadas para passar informações adicionais que você deseja receber de volta no retorno da chamada.Para setar cada variável utilize o formato
var_1 = X,var_2 = Ye assim sucessivamente atévar_5.O conteúdo pode ser qualquer valor definido pelo cliente, como ID de lead, token de autenticação, identificador de tarefa, chave de sessão ou outra informação relevante para rastreio.
Essas variáveis não estão disponíveis em outros fluxos de webhook ou APIs (ex.: disparos automáticos, webhooks de filas, etc.), funcionando exclusivamente na API de Click to Call.
O valor definido será retornado junto com os demais dados da chamada no Webhook de desligamento, permitindo capturar e utilizar essas informações no sistema de destino.
Exemplo de uso no disparo da chamada:
https://click2call.sonax.net.br/sonax-click2call.php?numero=5511999999999&ramal=101&var_1=ID_Lead123&var_2=TokenABC
Retorno
<VAR1> = ID_Lead123
<VAR2> = TokenABC
Exemplo de URL para utlizar em WebHook:
empresaxyz.com.br/index.php?id_chamada=<ID_CHAMADA>&id_contato=<ID_CONTATO>&ramal=<ALIASRAMAL>&Login_CRM=<ALIAS2>&numero_cli=<NUMERO>&atendente=<AT_LOGIN>&id_fila=<ID_FILA>&id_campanha=<ID_CAMPANHA>&data_inicio=<DATA_INICIO>&data_fim=<DATA_FIM>&status_chamada=<STATUS_CHAMADA>&status_atendimento=<STATUS_ATENDIMENTO>&duracao=<DURACAO_CHAMADA>
Exemplos de clientes que usam outros tipos de URL, acesse aqui.
100.90.0.8:59106/LANCallerIDService/RecordCallerID/<ALIASRAMAL>|<NUMERO>|<NUMERO>
* Lembrando que o cliente poderá enviar ou não todos os parâmetros da URL. Caso não deseja
enviar todos, apenas excluir os parâmetros indesejados
Status de Chamada:
- campanha: O contato está inserido na campanha e será trabalhado.
- andamento: Chamada em andamento.
- ramal atendeu: Chamada atendida pelo ramal.
- ramal falhou: O ramal não atendeu a chamada.
- discando: Chamada está sendo discada para o número de destino.
- falando: O ramal e o número de destino estão em conversação.
- ocupado: O número de destino está ocupado.
- indisponível: O número de destino não está disponível ou não atendeu.
- desligada: A chamada foi encerrada após ser bem-sucedida.
Autenticação
Os campos id_cliente e token são obrigatórios para todas as transações. Eles garantem a autenticação da requisição e identificam o cliente responsável pela chamada. Esses dados serão fornecidos no momento da criação da campanha dentro do gerenciador.
Atenção: Transações que retornarem "404 not found" três vezes consecutivas serão automaticamente bloqueadas para novos envios.
AÇÃO LOGIN DO ATENDENTE Parâmetros: acao=login id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_atendente=<ID_ATENDENTE> ramal=<RAMAL> apelido do ramal. Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=login&id_cliente=12345&token=AVKOF45F6S1W3F6IA&id_atendente=123456&ramal=101 Retorno: 1 para transação bem-sucedida ou "404 not found" para transação recusada.
AÇÃO LOGOUT DO ATENDENTE Parâmetros: acao=logout id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_atendente=<ID_ATENDENTE> Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=logout&id_cliente=12345&token=AVKOF45F6S1W3F6IA&id_atendente=123 Retorno: 1 para transação bem-sucedida ou "404 not found" para transação recusada.
AÇÃO PAUSA DO ATENDENTE Parâmetros: acao=pausar id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_atendente=<ID_ATENDENTE> id_motivo=<ID_MOTIVO> (Campo opcional) ID do motivo da pausa. Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=pausar&id_cliente=12345&token=AVKOF45F6S1W3F6IA&id_atendente=123 Retorno: 1 para transação bem sucedida ou "404 not found" para transação recusada.
AÇÃO RETORNAR DA PAUSA DO ATENDENTE Parâmetros: acao=play id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_atendente=<ID_ATENDENTE> Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=play&id_cliente=12345&token=AVKOF45F6S1W3F6IA&id_atendente=123 Retorno: 1 para transação bem-sucedida ou "404 not found" para transação recusada.
AÇÃO STATUS DO ATENDENTE Parâmetros: acao=status_atendente id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_atendente=<ID_ATENDENTE> Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=status_atendente&id_cliente=12345&token=AVKOF45F6S1W3F6IA&id_atendente=123 Retorno: Disponível, Indisponível, Pausado, Chamando, Falando ou Deslogado para status do atendente ou "404 not found" para transação recusada.
AÇÃO INSERIR CHAMADA MANUAL DIRETO NO RAMAL (CLICK2CALL PARA SITES WEB) Utilizar seguinte link: https://click2call.sonax.net.br/sonax-click2call.php?numero=33988887777&ramal=XXX&token=XXXXXXXXXXXXXXXXXXXX Alterar os seguintes campos, conforme especificações: numero – preencher com o número de destino no formato DDD + número. ramal – deve ser preenchido com o número do ramal a qual será entregue a ligação do número de destino ( EX.: 100). token – senha para liberação da integração do cliente (A senha deve ser composta por no mínimo 20 dígitos, sendo letras maiúsculas e números). Retorno: O número do protocolo <p> Ligação realizada com sucesso para o numero</p> ou "404 not found" para transação recusada.
AÇÃO INSERIR CHAMADA EM CAMPANHA DO DISCADOR Parâmetros: acao=chamada id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_contato=<ID_CONTATO> Pode ser um numero de identificação do contato (CPF, RG, id do cliente e etc). numero=<NUMERO> Número do telefone do contato no formato DDD com 2 dígitos (sem o zero) + número. id_campanha=<ID_CAMPANHA> data_hora=<DATA_HORA> Opcionalmente, pode ser fornecido data e hora para que a chamada seja discada apenas a partir desse dia e hora. Formato: aaaa-mm-dd hh:mm:s. prioridade=<PRIORIDADE> Descrição da Prioridade de Chamadas: Se o `id_contato` tiver mais de um número de telefone associado, a prioridade da chamada deve começar em "1" para o primeiro número e aumentar progressivamente em "1" para cada número adicional desse mesmo contato. Ou seja: - Para o primeiro número de telefone do `id_contato`, a prioridade será "1". - Para o segundo número de telefone do mesmo `id_contato`, a prioridade será "2", e assim por diante. A prioridade será reiniciada para "1" quando o `id_contato` for alterado. Importante: Se a prioridade não for informada no envio da requisição, a plataforma definirá automaticamente a prioridade como "1". Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=chamada&id_cliente=123&token=AVKOF4S1W3F6IA&id_contato=12345678901&numero=33999570046&id_campanha=1234&prioridade=1&data_hora=2018-08-03 08:00:00 Retorno: Código de identificação da chamada para ser consultado posteriormente ou "404 not found" para transação recusada.
AÇÃO CONSULTAR CHAMADA Parâmetros: acao=status_chamada id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_chamada=<ID_CHAMADA> id da chamada fornecido na inserção da mesma. Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=status_chamada&id_cliente=215&token=AVKOF45F6S1W3F6IA&id_chamada=4782133 Retorno: status* da chamada ou "404 not found" para transação recusada. Resposta: status da ligação | id do ramal | id da fila | data inicio da ligação | data final da ligação | status atendido | duração da chamada | número da ramal | numero discado
AÇÃO CONSULTAR CHAMADAS EM ANDAMENTO Parâmetros: acao=status_chamadas_andamento id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_campanha=<ID_CAMPANHA> id da campanha ao qual deseja consultar as chamadas. Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=status_chamadas_andamento&id_cliente=215&token=AVKOF45F6S1W3F6IA&id_campanha=4782 Retorno: todas as chamadas que estão em andamento no momento, inclusive as que estão falando ou "404 not found" para transação recusada. Tem "|" como separador de coluna para os campos ID_CHAMADA, STATUS*, ID_RAMAL, ID_FILA e <br> como sinalizador de quebra de linha (novo registro após ele).
AÇÃO CONSULTAR CHAMADAS FALANDO Parâmetros: acao=status_chamadas_falando id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_campanha=<ID_CAMPANHA> id da campanha ao qual deseja consultar as chamadas. Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=status_chamadas _falando&id_cliente=215&token=AVKOF45F6S1W3F6IA&id_campanha=4782 Retorno: todas as chamadas que estão em conversação (falando) ou "404 not found" para transação recusada. Tem "|" como separador de coluna para os campos ID_CHAMADA, STATUS*, ID_RAMAL, ID_FILA e <br> como sinalizador de quebra de linha (novo registro após ele).
AÇÃO CONSULTAR STATUS DAS CHAMADAS NA FILA Parâmetros: acao= status_chamadas_na_fila id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_fila=<ID_FILA> id da fila ao qual deseja consultar os status das chamadas. Para mais de uma fila, informe separando-as por vírgula (,). Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=status_chamadas_na_fila&id_cliente=12345&token=AVKOF45F6S1W3F6IA&id_fila=1234 Retorno: todos os status das chamadas que estão na fila no momento, inclusive as que estão falando ou "404 not found" para transação recusada. Tem "|" como separador de coluna para os campos CONTADOR_CHAMADA, ID_CHAMADA, STATUS, RAMAL, ID_FILA, NUMERO_ORIGEM, TEMPO_ESPERA e <br> como sinalizador de quebra de linha (novo registro após ele).
AÇÃO LISTAR TODAS AS CAMPANHA Parâmetros: acao=lista_campanha id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_campanha=todas Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=lista_campanha&id_cliente=215&token=AVKOF45F6S1W3F6IA&id_campanha=todas Retorno: Irá retornar os dados da campanha na seguinte ordem ( ID DA CAMPANHA | DESCRIÇÃO DA CAMPANHA | DATA DE CRIAÇÃO DA CAMPANHA | ID DA FILA | QUANTIDADE DE CONTATOS DA CAMPANHA | QUANTIDADE DE CONTATOS JÁ PROCESSADOS | STATUS DA CAMPANHA | QUANTIDADE DE SIMULTANEAS POR PA | QUANTIDADE DE VEZES QUE A CAMPANHA FOI REPROCESSADO ) ou "404 not found" para transação recusada. Usamos "|" como separador de coluna para os para todos os campos.
AÇÃO LISTAR CAMPANHA ESPECIFICA Parâmetros: acao=lista_campanha id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_campanha=<ID_CAMPANHA> Exemplo: https://api.sonax.net.br/vingadora_pro/dbdial_webapi.php?acao=lista_campanha&id_cliente=1111&token=dc1VYZFGJp3MeD&id_campanha=4211 Retorno: Irá retornar os dados da campanha na seguinte ordem ( ID DA CAMPANHA | DESCRIÇÃO DA CAMPANHA | DATA DE CRIAÇÃO DA CAMPANHA | ID DA FILA | QUANTIDADE DE CONTATOS DA CAMPANHA | QUANTIDADE DE CONTATOS JÁ PROCESSADOS | STATUS DA CAMPANHA | QUANTIDADE DE SIMULTANEAS POR PA | QUANTIDADE DE VEZES QUE A CAMPANHA FOI REPROCESSADO ) ou "404 not found" para transação recusada. Usamos "|" como separador de coluna para os para todos os campos.
AÇÃO LISTAR TABULAÇÃO Parâmetros: acao=lista_tabulacao id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=lista_tabulacao&id_cliente=215&token=AVKOF45F6S1W3F6IA Retorno: todas as tabulações previamente cadastradas ou "404 not found" para transação recusada. Tem "|" como separador de coluna para os campos ID_TABULACAO, DESCRIÇÃO, TIPO (‘P’ positiva, ‘N’ negativa, ‘I’ indiferente) e <br> como sinalizador de quebra de linha (novo registro após ele).
AÇÃO ATUALIZA TABULAÇÃO NO CONTATO Parâmetros: acao=atualiza_tabulacao_contato id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_campanha=<ID_CAMPANHA> id da campanha ao qual deseja atualizar o contato. id_tabulacao=<ID_TABULACAO> id da tabulação ao qual deseja atualizar o contato. id_contato_campanha=<ID_CONTATO_CAMPANHA> id da chamada a qual deseja atualizar. Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=atualiza_tabulacao_contato&id_cliente=215&token=AVKOF45F6S1W3F6IA&id_campanha=1111&id_tabulacao=1111&id_contato_campanha=1111 Retorno: 1 se bem sucedido ou "404 not found" para transação recusada.
AÇÃO CRIAR CAMPANHA DE DISCADOR ENVIANDO LIGAÇÃO PRA FILA Parâmetros: acao=cria_campanha id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> descricao_campanha=<DESCRICAO_CAMPANHA> até 60 caracteres. id_fila=<ID_FILA> id da fila que deseja enviar chamadas da campanha. descarte_caixa_postal=<DESCARTE_CAIXA_POSTAL> ‘S’ para caso deseje descartar ligações de caixa postal ou ‘N’para não descartar. qtd_simultanea=<QTD_SIMULTANEA> quantidade de chamadas simultâneas por PA. auto_concluir=<AUTO_CONCLUIR> ‘S’ para caso deseje que a campanha conclua automaticamente ao discar todos os contatos ou ‘N’ para que não conclua. dia_semana_ini=<DIA_SEMANA_INI> (não obrigatório) número do dia da semana inicial para campanha (os números dos dias da semana vão de 1 ao 7, sendo 1 para domingo e 7 para sábado), valor default para este campo é 2. dia_semana_fim=<DIA_SEMANA_FIM> (não obrigatório) número do dia da semana final para campanha (os números dos dias da semana vão de 1 ao 7, sendo 1 para domingo e 7 para sábado), valor default para este campo é 6. hora_ini=<HORA_INI> (não obrigatório) hora inicial para campanha começar. O formato deve ser: xx:xx:xx, valor default para este campo é 08:30:00. hora_fim=<HORA_FIM> (não obrigatório) hora inicial para campanha começar. O formato deve ser: xx:xx:xx, valor default para este campo é 18:00:00. tabulacoes_positivas=<TABULACOES_POSITIVAS> tabulações positivas separadas por vírgula (,). tabulacoes_negativas=<TABULACOES_NEGATIVAS> tabulações negativas separadas por vírgula (,). id_campanha_tabulacoes_positivas=<ID_CAMPANHA_TABULACOES_POSITIVAS> (não obrigatório) id da campanha na qual deseja copiar tabulações positivas. id_campanha_tabulacoes_negativas=<ID_CAMPANHA_TABULACOES_NEGATIVAS> (não obrigatório) id da campanha na qual deseja copiar tabulações negativas. pausas=<PAUSAS> pausas separadas por vírgula (,). id_campanha_pausas=<ID_CAMPANHA_PAUSAS> (não obrigatório) id da campanha na qual deseja copiar pausas. Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=cria_campanha&id_cliente=215&token=AVKOF45F6S1W3F6IA&descricao_campanha=TesteCampanha&id_fila=1234&descarte_caixa_postal=S&qtd_simultanea=2&auto_concluir=S&dia_semana_ini=2&dia_semana_fim=6&hora_ini=08:30:00&hora_fim=18:00:00&tabulacoes_positivas=Atendimento,Orcamento,Venda Concluida&tabulacoes_negativas=Numero nao existe,Numero nao e do cliente&id_campanha_tabulacoes_positivas=56789&id_campanha_tabulacoes_negativas=56789&pausas=Banheiro,Almoco,Cafe,Atendimento&id_campanha_pausas=56789 Retorno: Código da campanha criada ou "404 not found" para transação recusada.
AÇÃO LIMPAR CONTATOS DA CAMPANHA Parâmetros: acao=limpa_contatos_campanha id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_campanha=<ID_CAMPANHA> Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=limpa_contatos_campanha&id_cliente=215&token=AVKOF45F6S1W3F6IA&id_campanha=123456 Retorno: 1 se bem sucedido ou "404 not found" para transação recusada.
AÇÃO PEGA GRAVAÇÃO Parâmetros: acao=pega_gravacao id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_chamada=<ID_CHAMADA> campo numérico único que identifica a chamada dentro do sistema. recordmp3=1 (para baixar a gravação em formato mp3 caso necessário) Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=pega_gravacao&id_cliente=215&token=AVKOF45F6S1W3F6IA&id_chamada=123456 Retorno: arquivo da gravação (ou um zip se encontrar mais de uma gravação para mesma chamada, no caso de chamada com transferências) ou "404 not found" para transação recusada.
AÇÃO LIMPA CONTATOS DA CAMPANHA Parâmetros: acao=limpa_contatos_campanha id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_campanha=<ID_CAMPANHA> Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=limpa_contatos_campanha&id_cliente=215&token=AVKOF45F6S1W3F6IA&id_campanha=123456 Retorno: 1 se bem sucedido ou "404 not found" para transação recusada.
AÇÃO PLAY CAMPANHA Parâmetros: acao=play_campanha id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_campanha=<ID_CAMPANHA> Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=play_campanha&id_cliente=215&token=AVKOF45F6S1W3F6IA&id_campanha=123456 Retorno: 1 se bem sucedido ou "404 not found" para transação recusada.
AÇÃO STOP CAMPANHA Parâmetros: acao=stop_campanha id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_campanha=<ID_CAMPANHA> Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=stop_campanha&id_cliente=215&token=AVKOF45F6S1W3F6IA&id_campanha=123456 Retorno: 1 se bem sucedido ou "404 not found" para transação recusada.
AÇÃO LISTA PAUSAS Parâmetros: acao=lista_pausas id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=lista_pausas&id_cliente=215&token=AVKOF45F6S1W3F6IA Retorno: todas as pausas previamente cadastradas ou "404 not found" para transação recusada. Tem "|" como separador de coluna para os campos ID_PAUSA e DESCRIÇÃO e <br> comosinalizador de quebra de linha (novo registro após ele).
AÇÃO UPLOAD ARQUIVO CONTATO (POST)
Parâmetros:
acao=upload_arquivo_contato
id_cliente=<ID_CLIENTE>
token=<TOKEN_20_DIGITOS_ALFANUMERICOS>
id_campanha=<ID_CAMPANHA>
prioridade=<PRIORIDADE DA DISCAGEM, INICIANDO EM 1>
arquivo=<ARQUIVO> arquivo (deve ser em formato CSV. Obrigatoriamente devem existir 3 colunas.
A primeira coluna é o Identificador do Contato,
segunda coluna é o número a ser discado,
terceira coluna é campo extra podem ser informações do contato(podem existir até 20 colunas de informações extra).
Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php
Retorno: todas as ligações com contatos previamente cadastradas com <br> como sinalizador de quebra de linha (novo registro após ele) ou "404 not found" para transação recusada.AÇÃO DOWNLOAD ARQUIVO CONTATO Parâmetros: acao=download_arquivo_contato id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_campanha=<ID_CAMPANHA> Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=download_arquivo_contato&id_cliente=215&token=AVKOF45F6S1W3F6IA&id_campanha=1234 Retorno: todos os contatos importados na campanha ou "404 not found" para transação recusada. Tem "," como separador de coluna para os campos PROTOCOLO (ID_CHAMADA), ID_CLIENTE, NÚMERO, ATENDIDO, DATA_INÍCIO, DURAÇÃO (EM SEGUNDOS), TENTATIVAS, TABULAÇÃO (DESCRIÇÃO), ID_TABULAÇÃO, TIPO_TABULAÇÃO, LOGIN_AGENTE, OBSERVAÇÃO e <br> como sinalizador de quebra de linha (novo registro após ele).
AÇÃO LIMPA ESTATÍSTICAS DE UMA FILA Parâmetros: acao=limpa_estatisticas_fila id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_fila=<ID_FILA> Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=limpa_estatisticas_fila&id_cliente=215&token=AVKOF45F6S1W3F6IA&id_fila=123456 Retorno: 1 se bem sucedido ou "404 not found" para transação recusada.
AÇÃO LISTA FILAS Parâmetros: acao=lista_filas id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=lista_filas&id_cliente=215&token=AVKOF45F6S1W3F6IA Retorno: todas as filas previamente cadastradas ou "404 not found" para transação recusada. Tem "|" como separador de coluna para os campos ID_FILA e DESCRIÇÃO e <br> como sinalizador de quebra de linha (novo registro após ele).
AÇÃO CRIAR ÁUDIO DE URA (POST) Parâmetros: acao=criar_audio id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> descricao=<DESCRIÇÃO> descrição do áudio. audio=<AUDIO> arquivo de áudio (deve ser em formato mp3 ou wav de até 10MB). Retorno: ID do novo áudio cadastrado ou código de erro e descrição em formato JSON.
AÇÃO MUDAR ÁUDIO DE UMA URA Parâmetros: acao=mudar_audio_ura id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_ura=<ID_URA> ID da URA que deseja mudar o áudio. id_audio=<ID_AUDIO> ID do novo áudio para URA. Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=mudar_audio_ura&id_cliente=215&token=AVKOF45F6S1W3F6IA&id_ura=123456&id_audio=123456 Retorno: 1 se bem sucedido ou "404 not found" para transação recusada.
AÇÃO RELATÓRIO DE URA Parâmetros: acao=relatorio_ura id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_campanha=<ID_CAMPANHA>Não obrigatório desde que ID_URA seja preenchido. id_ura=<ID_URA>Não obrigatório desde que ID_CAMPANHA seja preenchido. data_ini=<DATA_INI>Formato ‘Y-m-d H:i:s’. (Obrigatório somente se id_campanha não for preenchido). data_fim=<DATA_FIM>Formato ‘Y-m-d H:i:s’. (Obrigatório somente se id_campanha não for preenchido). Exemplo: https://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=relatorio_ura&id_cliente=12345&token=AVKOF45F6S1W3F6IA&id_campanha=123456&data_ini=2020-01-01%2000%3A00%3A00&&data_fim=2020-01-01%2023%3A59%3A59 Retorno: todos os registros de URA de acordo com os dados informados. Tem “|” como separador de coluna para os campos DATA, NÚMERO e DÍGITO e <br> como sinalizador de quebra de linha (novo registro após ele). Ou “A Campanha informada é inválida.” para caso a campanha não seja de URA Reversa ou não seja do cliente. Ou “404 not found” para caso não encontrar nenhum registro da URA no período informado, falta de parâmetros obrigatórios ou parâmetros que não sejam referentes à conta.
AÇÃO CRIAR CAMPANHA URA REVERSA Parâmetros: acao=criar_campanha_ura_reversa id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> descricao_campanha=<DESCRICAO_CAMPANHA> até 60 caracteres. id_ura=<ID_FILA> id da URA que deseja enviar chamadas da campanha. descarte_caixa_postal=<DESCARTE_CAIXA_POSTAL> ‘S’ para caso deseje descartar ligações de caixa postal ou ‘N’para não descartar. qtd_simultanea=<QTD_SIMULTANEA> quantidade de chamadas simultâneas por PA. auto_concluir=<AUTO_CONCLUIR> ‘S’ para caso deseje que a campanha conclua automaticamente ao discar todos os contatos ou ‘N’ para que não conclua. dia_semana_ini=<DIA_SEMANA_INI> (não obrigatório) número do dia da semana inicial para campanha (os números dos dias da semana vão de 1 ao 7, sendo 1 para domingo e 7 para sábado), valor default para este campo é 2. dia_semana_fim=<DIA_SEMANA_FIM> (não obrigatório) número do dia da semana final para campanha (os números dos dias da semana vão de 1 ao 7, sendo 1 para domingo e 7 para sábado), valor default para este campo é 6. hora_ini=<HORA_INI> (não obrigatório) hora inicial para campanha começar. O formato deve ser: xx:xx:xx, valor default para este campo é 08:30:00. hora_fim=<HORA_FIM> (não obrigatório) hora inicial para campanha começar. O formato deve ser: xx:xx:xx, valor default para este campo é 18:00:00. tabulacoes_positivas=<TABULACOES_POSITIVAS> tabulações positivas separadas por vírgula (,). tabulacoes_negativas=<TABULACOES_NEGATIVAS> tabulações negativas separadas por vírgula (,). id_campanha_tabulacoes_positivas=<ID_CAMPANHA_TABULACOES_POSITIVAS> (não obrigatório) id da campanha na qual deseja copiar tabulações positivas. id_campanha_tabulacoes_negativas=<ID_CAMPANHA_TABULACOES_NEGATIVAS> (não obrigatório) id da campanha na qual deseja copiar tabulações negativas. pausas=<PAUSAS> (não obrigatório) pausas separadas por vírgula (,). id_campanha_pausas=<ID_CAMPANHA_PAUSAS> (não obrigatório) id da campanha na qual deseja copiar pausas. Exemplo: http://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=criar_campanha_ura_reversa&id_cliente=215&token=AVKOF45F6S1W3F6IA&descricao_campanha=Teste Campanha&id_item=1234&descarte_caixa_postal=S&qtd_simultanea=2&auto_concluir=S&dia_semana_ini=2&dia_semana_fim=6&hora_ini=08:30:00&hora_fim=18:00:00&tabulacoes_positivas=Atendimento,Orcamento,Venda Concluida&tabulacoes_negativas=Numero nao existe,Numero nao e do cliente&id_campanha_tabulacoes_positivas=56789&id_campanha_tabulacoes_negativas=56789&pausas=Banheiro,Almoco,Cafe,Atendimento&id_campanha_pausas=56789 Retorno: Código da campanha criada ou "404 not found" para transação recusada.
AÇÃO CRIAR URA Parâmetros: acao=criar_ura id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> arquivo_audio=<ARQUIVO_AUDIO>. No do arquivo de áudio com a extensão. descricao=<DESCRICAO> descrição da URA. tentativas_entrada=<TENTATIVAS_ENTRADA> ‘S’ para caso deseje descartar ligações de caixa postal ou ‘N’para não descartar. timeout_entrada=<TIMEOUT_ENTRADA> quantidade de chamadas simultâneas por PA. itens[]=<ITENS> Array de itens da URA, cada item do array deve conter 4 informações: invalido, número, tipo e id da entidade do item. Exemplo: http://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=criar_ura&id_cliente=955&token=sUmulAIbqodRMVB3PaCn&arquivo_audio=955_89971566502716.wav&descricao=ura+joabe+via+vingadora&tentativas_entrada=2&timeout_entrada=3&itens[0][invalido]=1&itens[0][numero]=9&itens[0][tipo]=F&itens[0][id]=15975&itens[1][invalido]=0&itens[1][numero]=1&itens[1][tipo]=U&itens[1][id]=80595 Retorno: Código da URA criada ou "404 not found" para transação recusada.
AÇÃO AGENDAR LIGAÇÃO Parâmetros: acao=agendar_ligacao id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> atendente_id=<ATENDENTE_ID>. ID do atendente que fará a ligação dt_agendamento=<DT_AGENDAMENTO> Data do agendamento. Formato ‘Y-m-d H:i:s’ numero=<NUMERO> obs=<OBS> Observação para o agendamento (não obrigatório). Exemplo: http://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=agendar_ligacao&token=sUmulAIbqodRMVB3PaCn&id_cliente=955&atendente_id=44425&dt_agendamento=2021-04-23+17%3A45&numero=44425&obs=alguma+observacao+qualquer Retorno: Código da ligação agendada criada ou "404 not found" para transação recusada.
AÇÃO ALTERAR SIMULTANEIDADE DA CAMPANHA Parâmetros: acao=alterar_simultaneidade_campanha id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_campanha=<ID_CAMPANHA>. ID da campanha que será alterada nova_quantidade=<NOVA_QUANTIDADE> Nova quantidade de simultaneidade. Exemplo: http://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=alterar_simultaneidade_campanha&token=asdf15313asdf51a5s&id_cliente=123&id_campanha=123456&nova_quantidade=123 Retorno: Código da campanha alterada ou o erro ocorrido para transação recusada.
AÇÃO INSERIR NA BLACKLIST
Bloqueio receptivo
Parâmetros:
acao=inserir_blacklist
id_cliente=<ID_CLIENTE>
token=<TOKEN_20_DIGITOS_ALFANUMERICOS>
numero_bloqueado: Informar ddd para bloqueio ou numero que tenha 10 ou 11 digitos , ou informar a palavra {ANONYMOUS} para deletar chamadas anonimas para o did
numero_virtual: Informar um de seus numeros virtuais ou a palavra {todos} caso queira que o numero informado seja bloqueado em todos os DIDs.
ativo_receptivo: R para Receptivo
Exemplo: http://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=inserir_blacklist&token=asdf15313asdf51a5s&id_cliente=123&numero_bloqueado=123456&numero_virtual=123&ativo_receptivo=R
Retorno: Inserido com sucesso ou o erro ocorrido para transação recusada.
Parâmetros:
Bloqueio ativo
acao: inserir_blacklist
id_cliente=<ID_CLIENTE>
token=<TOKEN_20_DIGITOS_ALFANUMERICOS>
numero_bloqueado: Informar ddd para bloqueio ou numero que tenha 10 ou 11 digitos
ativo_receptivo: A para ligações Ativo
Exemplo: http://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=inserir_blacklist&token=asdf15313asdf51a5s&id_cliente=123&numero_bloqueado=123456&ativo_receptivo=A
Retorno: Inserido com sucesso ou o erro ocorrido para transação recusada.AÇÃO DELETAR DA BLACKLIST
Parâmetros:
acao=deletar_blacklist
id_cliente=<ID_CLIENTE>
token=<TOKEN_20_DIGITOS_ALFANUMERICOS>
numero_bloqueado= Informar ddd/numero que tenha 10 ou 11 digitos , ou informar a palavra {ANONYMOUS} para deletar chamadas anonimas para o did
ativo_receptivo=R ou A (R para Receptivo e A para ligações ativas).
Exemplo: http://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=inserir_blacklist&token=asdf15313asdf51a5s&id_cliente=123&numero_bloqueado=123456&ativo_receptivo=R
Retorno: Deleltado com sucesso ou o erro ocorrido para transação recusada. AÇÃO CONSULTAR A BLACKLIST
Parâmetros:
acao=buscar_blacklist
id_cliente=<ID_CLIENTE>
token=<TOKEN_20_DIGITOS_ALFANUMERICOS>
numero_bloqueado: Informar ddd/numero que tenha 10 ou 11 digitos , ou informar a palavra {ANONYMOUS} para deletar chamadas anonimas para o did
Exemplo: http://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=inserir_blacklist&token=asdf15313asdf51a5s&id_cliente=123&numero_bloqueado=123456
Retorno: Deleltado com sucesso ou o erro ocorrido para transação recusada. AÇÃO VERIFICAR STATUS DO RAMAL Parâmetros: acao=verifica_status_ramal id_cliente=<ID_CLIENTE> token=<TOKEN_20_DIGITOS_ALFANUMERICOS> id_ramal=<ID_RAMAL> Exemplo: http://api.sonax.net.br/a2billing_v2/admin/Public/dbdial_webapi.php?acao=verifica_status_ramal&id_cliente=955&id_ramal=24051&token=2hMW5Te45rsd54resG1 Retorno: Ira retorna o status do ramal. exemplo:Ramal não registrado: ramal esta sem registro, indisponivel para receber chamadas. ramal disponivel: ramal esta registrado e habito a receber chamadas. ramal falando: Ramal esta em uma chamadas receptiva ou ativa.
AÇÃO INSERIR CHAMADA MANUAL DIRETO PARA RAMAL DISPONIVEL NA FILA (CLICK2CALL PARA SITES WEB) Utilizar seguinte link: https://click2call.sonax.net.br/sonax-queue2call.php?telefone=33988887777&fila=XXX&token=XXXXXXXXXXXXXXXXXXXX Alterar os seguintes campos, conforme especificações: telefone – preencher com o número de destino no formato DDD + número. fila – deve ser preenchido com o número da fila a qual será entregue a ligação para o ramal disponivel. token – senha para liberação da integração do cliente (A senha deve ser composta por no mínimo 20 dígitos, sendo letras maiúsculas e números). Retorno: O número do protocolo <p> Ligação realizada com sucesso para o numero</p> ou "404 not found" para transação recusada.