Skip to end of banner
Go to start of banner

[ API ] Gerenciar Filas de Atendimento

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

Endereço de Chamada da API

GET /api/manageQueue/API_TOKEN/API_KEY/0

Este Ponto de Acesso permite que você obtenha os Perfis de Horário de um Cliente. Repare que no final da URL, você poderá informar o número 0 ou informar o ID de um Assinante para listar apenas os Perfis desse Assinante.

Para nosso exemplo, iremos deduzir que o endereço do servidor será sip.nextbilling.com.br. Nesse caso, o endereço da API para atualizar um registro:

Endereço da API exemplo

POST https://sip.nextbilling.com.br/api/manageQueue/API_TOKEN/API_KEY/0

Ponto de acesso para atualizar um Perfil de Horário existente:

Parâmetros:

  • id_cliente: ID do Cliente dono do Registro

  • descricao: Nome/Descrição do Registro

  • strategy: Estratégia de Distribuição

    • ringall: Tocar todas as linhas

    • rrmemory: Tocar aleatório lembrando última posição

    • random: Tocar aleatoriamente

    • fewestcalls: Tocar quem atendeu menos

    • linear: Tocar sequencialmente

  • musiconhold: custom: Utilizar audio customizado | default: Utilizar audio padrão da Plataforma

  • announce: Objeto informando o ID do audio para anuncio da Fila, ex: "announce": {"id": 23}

  • announce_frequency: Tempo em segundos para a frequência que os anúncios serão reproduzidos

  • announce_holdtime: Informar tempo de espera para o Cliente / 0 - desligado | 1 - ligado

  • announce_position: Informar para o cliente a posição dele na fila de espera / 0 - desligado | 1 - ligado

  • retry: Tempo em segundos para tentar chamar um atendente novamente

  • timeout: Tempo máximo em segundos que um Cliente poderá ficar na fila de espera

  • wrapuptime: Tempo em segundos que um atendente ficará sem receber uma nova chamada

  • reportholdtime: Informar ao atendente quanto tempo o cliente ficou esperando na fila

  • ringinuse: Tocar Linhas mesmo se estiverem ocupadas / 0 - desligado | 1 - ligado

  • queue_type: Tipo de Fila de Atendimento: 0 - Basic | 1 - Power | 2 - Full

  • play_agent_audio: Reproduzir música de espera para os atendentes caso queue_type = 2 / 0 - desligado | 1 - ligado

  • id_backup1: ID da Fila de Transbordo caso o Cliente não seja atendido nessa Fila

  • devices: Array informando os IDs das Linhas que pertencem a essa fila, exemplo: "devices": [1,55,88,99]

  • status: Status atual do Registro / 0 - Inativo | 1 - Ativo

A chamada para obter os dados da consulta, é realizado utilizando um HTTP GET para o endereço de consumo da API. Um exemplo de chamada a essa API para criar um novo registro seria:

Exemplo de chamada a API utilizando cURL

$ curl -X PUT -d '{"id_cliente": 9, "descricao": "Fila de Atendimento Principal", "strategy": "linear", "musiconhold": "custom", "announce": {id: 23}, "devices": [1,55,99], "status": 1}' 'https://sip.nextbilling.com.br/api/manageQueue/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629/0'

Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:

A chamada para excluir um registro, é realizado utilizando um HTTP DELETE informando o na query o parâmetro id_record com o ID do registro a ser removido:

Exemplo de chamada a API utilizando cURL

$ curl -X DELETE 'https://sip.nextbilling.com.br/api/manageQueue/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629/0?id_record=4'

Campo

Descrição

error

1 em caso de erro

reason

Descrição caso tenha ocorrido algum erro

new_record

ID do novo Registro

  • No labels