Obter mensagem
curl --request GET \ "https://api.iporto.com.br/api/external/v1/messages/3f2a7c18-9d4e-4b6a-8c1f-5e2d7a0b3f49" \ --header "Authorization: Bearer $IPORTO_API_KEY" \ --header "Accept: application/json"const resposta = await fetch("https://api.iporto.com.br/api/external/v1/messages/3f2a7c18-9d4e-4b6a-8c1f-5e2d7a0b3f49", { 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/3f2a7c18-9d4e-4b6a-8c1f-5e2d7a0b3f49', [ '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/3f2a7c18-9d4e-4b6a-8c1f-5e2d7a0b3f49'headers = {'Authorization': 'Bearer ' + os.environ['IPORTO_API_KEY']}
resposta = requests.get(url, headers=headers)
print(resposta.json())Uma mensagem, pelo tracking_code que o envio devolveu ou pelo message.id da listagem.
Só aqui vêm delivery.bounce — o código e a frase do servidor de destino — e delivery.recipients, o resultado de cada destinatário. Na listagem o primeiro é nulo e o segundo é lista vazia, porque buscá-los para cada item deixaria a lista lenta.
⚠️ O tracking_code continua resolvendo depois do arquivamento, que acontece poucos minutos depois de a mensagem terminar. É por isso que ele, e não o id, é o identificador para guardar.
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”O message.tracking_code que o envio devolveu (o caminho normal), ou o message.id que veio na listagem. Os dois resolvem a mesma mensagem.
Query Parameters
Seção intitulada “Query Parameters”O canal: email (padrão) ou sms. Valor inválido responde 422.
Responses
Seção intitulada “Responses”A mensagem.
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
Examplegenerated
{ "object": "example", "event": "example", "channel": "example", "message": { "id": "example", "tracking_code": "example", "message_id": "example", "message_id_relay": "example", "subject": "example", "body": "example", "from": "example", "from_visible": "example", "to": "example", "recipients": [ "example" ], "tags": [ "example" ], "smtp_domain_id": 1, "smtp_account_id": 1, "plan_type": "example", "attachments_dropped": [ "example" ], "sent_at": "example" }, "delivery": { "status": "example", "hard_bounce": 1, "soft_bounce": 1, "discarded": 1, "trap": 1, "bounce": { "kind": "example", "code": "example", "answer": "example", "domain": "example" }, "recipients": [ { "email": "example", "domain": "example", "kind": "example", "code": "example", "answer": "example", "discard_reason": "example" } ] }, "engagement": { "link": "example", "ip": "example", "user_agent": "example", "device": "example", "platform": "example", "referer": "example" }}A chave não foi enviada, ou venceu.
object
Examplegenerated
{ "error": "example"}A mensagem não existe ou é de outra conta — respondemos igual nos dois casos, de propósito: um 403 confirmaria que o identificador existe.
object
Examplegenerated
{ "error": "example"}