/did/list-all

Este método permite a listagem dos números de telefone virtual contratados na Directcall (DID), sendo que os números podem ser do tipo LOCAIS ou NACIONAIS (4000/3003/4004 ou 0800).





DESCRIÇÃO

Este método permite listar todos os números contratados pelo cliente

ESTRUTURA DA URLhttps://api.directcallsoft.com/did/list-all
MÉTODO

POST

PARÂMETROS
NOMETIPOOBRIGATÓRIODESCRIÇÃO
access_tokenstringsimChave de acesso ao método, para saber como obter clique aqui
formatstringnão

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

statusstringnão

Tipo de filtro. Se omitido, listará todos os números:


A - Ativo
B - Bloqueado
I - Inadimplente
E - Inativo
pagintnão

Número da página (se omitido será mostrado página 1 apenas).

countintnãoNúmero de itens listados por página (se omitido será mostrado 100 itens por página).

OBSERVAÇÕES:

  • Na url é possível passar apenas o did a ser listado utilizando => /did/list-all/NUMERO-DID sem qualquer filtro.
  • Array de resposta da API será sempre em JSON (independente do parâmetro formato)

Retorno


200

Exemplo de resposta em JSON
{
    "api": "did",
    "modulo": "did-list-all",
    "status": "ok",
    "codigo": "000",
    "msg": [],
    "data": [
        {
            "codigo": "codigo-do-cliente",
            "numero": "numero-contratado",
            "data_ativacao": "data-ativacao",
            "data_cancelamento": "data-cancelamento",
            "status": "ativo/bloqueado/inadimplente ou inativo"
        },
        {
             "codigo": "codigo-do-cliente",
            "numero": "numero-contratado",
            "data_ativacao": "data-ativacao",
            "data_cancelamento": "data-cancelamento",
            "status": "ativo/bloqueado/inadimplente ou inativo" 
        },
        {
             "codigo": "codigo-do-cliente",
            "numero": "numero-contratado",
            "data_ativacao": "data-ativacao",
            "data_cancelamento": "data-cancelamento",
            "status": "ativo/bloqueado/inadimplente ou inativo" 
        }
    ],
    "total": quantidade-total-de-numeros,
    "itens_por_pagina": quantidade-de-numeros-por-pagina,
    "pagina_atual": pagina-atual,
    "paginas": quantidade-de-paginas
}

200

Exemplo de resposta em JSON
{
    "codigo": "500",
    "msg": "erro: access_token nao informado"
}

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 requisação de novos tokens.


  • Sem rótulos