Versões comparadas

Versão antiga 3

changes.mady.by.user Jaci Junior

Gravado em

comparado com

Nova versão 4

changes.mady.by.user Jaci Junior

Gravado em

Chave

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

/numero/disponivel



DESCRIÇÃO

Este método permite listar todos os números disponíveis para contratação

ESTRUTURA DA URLhttps://api.directcallsoft.com/numero/disponivel
VERSÃO1
MÉTODOPOST
PARÂMETROS

access_token obrigatório Chave de acesso ao método, para saber como obter clique aqui

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

num_vip opcional Filtro de número PREMIUM ou COMUM (se omitido será listado ambos).

   1 - COMUM
   2 - PREMIUM

ddd opcional Filtro de número por DDD. exemplo 41

cidade opcional Filtro de número por CIDADE. exemplo Curitiba

tipo opcional Tipo de filtro. Se omitido, listará todos os serviços:

   29 - Linha Telefônica Virtual - BR (DID)
   40 - 0800IP A
   43 - Número Único Nacional (NUN)

pagina opcional Número da página (se omitido será mostrada a primeira página)

itens_por_pagina opcional Número de itens listados na página (se omitido será mostrado 10 itens)

  1. RETORNO

api Origem API que esta sendo usada

modulo Módulo que está sendo chamado

status Mensagem de status

codigo Código de retorno - Clique aqui para listar os códigos e suas descrições

data Lista com os números disponíveis


Bloco de código
firstline1
titleExemplo de resposta em JSON
linenumberstrue
{
   "api":"numero",
   "modulo":"numero",
   "status":"ok",
   "codigo":"000",
   "data":[
      {
         "id_num":"19179",
         "cd_area":"41",
         "nr_tel":"35145100",
         "nome_cidade":"CURITIBA"
      }
   ],
   "pagina_atual":1,
   "itens_por_pagina":10,
   "total_de_paginas":1,
   "total_de_registros":1
}


Exemplos:

Linguagem
Descrição
Arquivo
PHPArquivo em PHP com exemplo de como requisitar o access_token por meio da APIRequisitarToken.php

...

Informações
titleValidade 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.


Veja também:

...