DESCRIÇÃO

Este método lista SMS enviado ou recebido, com dados de tarifação.

ESTRUTURA DA URL

https://api.directcallsoft.com/extrato/list-sms

VERSÃO

1

MÉTODO

POST

PARÂMETROS

dataInicial obrigatório Data de início de pesquisa no formato "YmdHis"

dataFinal obrigatório Data final de pesquisa no formato "YmdHis"

numeroOrigem opcional Opção de filtro com o número de origem

numeroDestino 

opcional Opção de filtro com o número de destino

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

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

paginaopcional Número da página (se omitido, será mostrada a primeira página)

msgEstornadas opcional Este parâmetro é útil para casos de falha no envio do sms para rede publica, Se este parâmetro for utilizado (ex. msgEstornadas = s), a API listará os SMS que foram estornados. O estorno de cada SMS ocorre caso algum servidor ou aplicação Directcall falhe no envio do SMS para rede publica, o que pode levar até 48h. Por default, caso essa opção não seja enviada, a API entenderá o parâmetro como msgEstornadas=n.

tipo opcional Tipo do SMS utilizar tipo = r para mensagens recebidas, tipo = v para Mensagens de Voz e tipo = e para mensagens enviadas, por padrão retornará as mensagens enviadas e mensagens recebidas.

RETORNO

api Origem API que está 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

msg Array de resposta da API

paginas Quantidade de páginas

Exemplo de resposta em JSON

{
   "api":"extrato",
   "modulo":"extrato",
   "status":"ok",
   "codigo":"000",
   "msg":[
      {
         "callerid":"xxxxxxxxxxxx",
         "cliente":"SIGNALLINK INFORMATICA LTDA",
         "servico":"Directcall Software Web",
         "login":"XXXXX",
         "password":"XXXXX",
         "tipo":"SMS",
         "origem_numero":"554130175726",
         "origem_localidade":"CURITIBA",
         "destino_numero":"554199504077",
         "destino_localidade":"CELULAR - VC1 - REGIAO 41",
         "data_inicio":"2013-02-20 17:53:54",
         "data_fim":"2013-02-20 17:53:54",
         "duracao":"60",
         "status_sms": "XXXXX - Message XXXXX",
         "custo":"0.1700",
         "gravacao_link":null,
         "text_sms":"TEXTO DO SMS ENVIADO",
         "uuid_origem":"xxxxxxxxxxxx"
      }
   ]
   "paginas":"2"
}