Consultar uma mensagem

GET

/v1/ingest/messages/{id}

A mensagem como o provedor a mandou: método, headers, corpo e o resultado da verificação. Os headers de credencial (Authorization, Cookie, Proxy-Authorization, asaas-access-token) são removidos antes de gravar. body é nulo quando a assinatura não conferiu.

Autorização

• Bearer

Parâmetros

Parâmetros de caminho

id

obrigatório

string

Respostas

200

Sucesso.

Tipo de mídiaapplication/json

object

id

obrigatório

string

sourceId

obrigatório

string

method

obrigatório

string

contentType

obrigatório

null | string

body

obrigatório

null | string

bodyBytes

obrigatório

integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

headers

obrigatório

object

key

propriedades adicionais

string

remoteIp

obrigatório

null | string

providerEventId

obrigatório

null | string

verification

obrigatório

string

fanout

obrigatório

integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

deliveries

obrigatório

object

total

obrigatório

integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

delivered

obrigatório

integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

inFlight

obrigatório

integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

failed

obrigatório

integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

cancelled

obrigatório

integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

createdAt

obrigatório

string formato: date-time

Exemplo^gerado

{
  "id": "example",
  "sourceId": "example",
  "method": "example",
  "contentType": "example",
  "body": "example",
  "bodyBytes": 1,
  "headers": {
    "additionalProperty": "example"
  },
  "remoteIp": "example",
  "providerEventId": "example",
  "verification": "example",
  "fanout": 1,
  "deliveries": {
    "total": 1,
    "delivered": 1,
    "inFlight": 1,
    "failed": 1,
    "cancelled": 1
  },
  "createdAt": "2026-04-15T12:00:00Z"
}

401

Chave de API ausente, inválida ou revogada.

404

A mensagem não existe, ou não é deste ambiente.

429

Limite de requisições por segundo do plano, somado entre todas as chaves da organização.

Headers

Retry-After

integer

Segundos até a próxima janela.