Listar mensagens
curl --request GET \ "https://api.iporto.com.br/api/external/v1/messages" \ --header "Authorization: Bearer $IPORTO_API_KEY" \ --header "Accept: application/json"const resposta = await fetch("https://api.iporto.com.br/api/external/v1/messages", { method: "GET", headers: { Authorization: `Bearer ${process.env.IPORTO_API_KEY}`, Accept: "application/json", },});
console.log(await resposta.json());$client = new \GuzzleHttp\Client();
$resposta = $client->get('https://api.iporto.com.br/api/external/v1/messages', [ 'headers' => [ 'Authorization' => 'Bearer '.getenv('IPORTO_API_KEY'), 'Accept' => 'application/json', ],]);
print_r(json_decode((string) $resposta->getBody(), true));import osimport requests
url = 'https://api.iporto.com.br/api/external/v1/messages'headers = {'Authorization': 'Bearer ' + os.environ['IPORTO_API_KEY']}
resposta = requests.get(url, headers=headers)
print(resposta.json())As mensagens da conta, da mais recente para a mais antiga.
⚠️ A resposta não traz o total: contar o histórico a cada requisição exigiria varrer uma coleção de milhões de documentos. Use meta.has_more para saber se há próxima página.
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Query Parameters
Seção intitulada “Query Parameters”O canal: email (padrão) ou sms. Valor inválido responde 422.
O código de rastreio da mensagem — o filtro mais direto.
O identificador do servidor de envio.
O destinatário: endereço de e-mail ou telefone, conforme o canal.
O status de entrega, como aparece em delivery.status.
Uma das etiquetas enviadas com a mensagem. Só no canal de e-mail.
Início do período, no formato AAAA-MM-DD.
Fim do período, no formato AAAA-MM-DD. Inclui o dia inteiro.
Itens por página.
A página, começando em 1.
Responses
Seção intitulada “Responses”A página de mensagens.
object
O mesmo objeto que o webhook entrega em param.details (v1) e data (v2). Cada campo está descrito em https://docs.iporto.com.br/api/webhooks/eventos/
object
object
object
object
object
object
object
Há próxima página. Não existe total — ver a descrição da listagem.
Example
{ "object": "list", "meta": { "channel": "email" }}A chave não foi enviada, ou venceu.
object
Examplegenerated
{ "error": "example"}Um filtro de valor fechado recebeu valor inválido.
object
Examplegenerated
{ "error": "example"}