Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

...

grupo/lista-grupo

DESCRIÇÃO

Este método retorna os grupos cadastrados, podendo filtrar pelo código do grupo

ESTRUTURA DA URL

https://api.directcallsoft.com/grupo/lista-grupo

VERSÃO

1

MÉTODO

POST

PARÂMETROS

format opcional Opção de retorno da API podendo ser JSON ou XML, se não informado JSON será o padrão

acess_token obrigatório Chave de acesso ao método, para saber como

obter 

obter clique aqui

pagina opcional Opção para paginação da lista de grupo. Valor numérico inteiro

id_grupo opcional Opção de filtro por grupo, informando o código do grupo

RETORNO

api Origem da API que esta sendo usado

modulo Módulo que esta sendo usado

status Mensagem de status

codigo Código de retorno - Clique aqui

 para

 para listar os códigos e suas descrições

data Array de resposta da API

pagina_atual Mostra a página atual

itens_por_pagina Quantidade máxima de itens por página

total_de_paginas Total de página gerado pela API

total_pagina_atual Quantidade de itens na página atual.

Exemplo de respostas em JSON
Bloco de código
                                                                                                                                                                                                                             


    "api": "grupo",


    "modulo": "grupo",


    "status": "ok",


    "codigo": "000",


    "data": [


        {


            "id_grupo": "XXXXX",


            "id_empresa": "XXXX",


            "empresa_nome": "NOME EMPRESA",


            "id_usuario": "XXXXX",


            "publico": "0",


            "nome": "NOME GRUPO",


            "criado_em": "2000-01-01 00:00:00",


            "sistema": "0"


        }


    ],


    "pagina_atual": 1,


    "itens_por_pagina": 100,


    "total_de_paginas": 1,


    "total_pagina_atual": 1


}

Informações

Validade dos tokens: Os tokens de acesso têm uma validade limitada, por isso convém que o sistema criado tenha em conta estes timings para que possa desenvolver rotinas de requisição de novos tokens.