Endereço de Chamada da API
GET /api/manageRingGroups/API_TOKEN/API_KEY/0
Este Ponto de Acesso permite que você obtenha os Grupos de Chamadas 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 Grupos 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/manageRingGroups/API_TOKEN/API_KEY/0
Ponto de acesso para atualizar um Perfil de Horário existente:
Parâmetros:
id_record: ID do registro a ser atualizado
id_cliente: ID do Cliente dono do Registro
descricao: Nome/Descrição do Perfil
strategy: Estratégia de Distribuição
ringall: Tocar todos ao mesmo tempo
random: Tocar aleatório
linear: Tocar sequencial
devices: array contendo o ID das linhas pertencentes a esse grupo, exemplo:
devices: [1,5,9,6,3]
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": "Ramais Recepção", "strategy": "linear", "devices": [1,4,19,23], "status": 1}' 'https://sip.nextbilling.com.br/api/manageRingGroups/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/manageRingGroups/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 |