v4

latestSwagger 2.02026-08-0343714211.7 MB
as2_outgoing_messages
AS2 Outgoing Messages

List AS2 Outgoing Messages

List AS2 Outgoing Messages

get/as2_outgoing_messages

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are workspace_id, created_at or as2_partner_id.

If set, return records where the specified field is equal to the supplied value. Valid fields are created_at, as2_station_id, workspace_id or as2_partner_id. Valid field combinations are [ as2_station_id, created_at ], [ workspace_id, created_at ], [ as2_partner_id, created_at ], [ workspace_id, as2_station_id ], [ workspace_id, as2_partner_id ], [ workspace_id, as2_station_id, created_at ] or [ workspace_id, as2_partner_id, created_at ].

If set, return records where the specified field is greater than the supplied value. Valid fields are created_at.

If set, return records where the specified field is greater than or equal the supplied value. Valid fields are created_at.

If set, return records where the specified field is less than the supplied value. Valid fields are created_at.

If set, return records where the specified field is less than or equal the supplied value. Valid fields are created_at.

Response

A list of As2OutgoingMessages objects.

idinteger

Id of the AS2 Partner.

workspace_idinteger

ID of the Workspace associated with this AS2 Outgoing Message.

as2_partner_idinteger

Id of the AS2 Partner associated with this message.

as2_station_idinteger

Id of the AS2 Station associated with this message.

uuidstring

UUID assigned to this message.

http_headersobject

HTTP Headers sent with this message.

processing_result'not_started' | 'send_failed' | 'send_success' | 'send_success_mdn_invalid' | 'send_success_mic_mismatch' | 'send_success_message_id_mismatch' | 'send_success_signature_mismatch' | 'send_success_processing_failure' | 'send_failed_unknown_host' | 'send_failed_bad_http_response_code' | 'send_failed_ssl_error' | 'send_failed_connection_refused'

Result of processing.

processing_result_descriptionstring

Result of processing description.

micstring

AS2 Message Integrity Check SHA1

mic_sha_256string

AS2 Message Integrity Check SHA256

as2_tostring

AS2 TO

as2_fromstring

AS2 FROM

datestring

Date Header

message_idstring

AS2 Message Id

body_sizestring

Encrypted Payload Body Size

attachment_filenamestring

Filename of the file being sent.

created_atstring date-time

Message creation date/time

http_response_codestring

HTTP Response Code received for this message

http_response_headersobject

HTTP Headers received for this message.

http_transmission_durationnumber double

HTTP transmission duration in seceonds

mdn_receivedboolean

Did the partner give a response body?

mdn_validboolean

Is the response in MDN format?

mdn_signature_verifiedboolean

MDN signature verified?

mdn_message_id_matchedboolean

MDN message id matched?

mdn_mic_matchedboolean

MDN MIC matched?

mdn_processing_successboolean

MDN disposition indicate a successful processing?

raw_uristring

URL to download the original file contents

smime_uristring

URL to download the file contents encoded as smime

smime_signed_uristring

URL to download the file contents as smime with signature

encrypted_uristring

URL to download the encrypted signed smime that is to sent as AS2 body

mdn_response_uristring

URL to download the http response body

Example response

[
  {
    "id": 1,
    "workspace_id": 1,
    "as2_partner_id": 1,
    "as2_station_id": 1,
    "uuid": "example",
    "http_headers": {
      "key": "example value"
    },
    "processing_result": "example",
    "processing_result_description": "example",
    "mic": "example",
    "mic_sha_256": "example",
    "as2_to": "example",
    "as2_from": "example",
    "date": "example",
    "message_id": "example",
    "body_size": "example",
    "attachment_filename": "example",
    "created_at": "2000-01-01T01:00:00Z",
    "http_response_code": "example",
    "http_response_headers": {
      "key": "example value"
    },
    "http_transmission_duration": 1,
    "mdn_received": true,
    "mdn_valid": true,
    "mdn_signature_verified": true,
    "mdn_message_id_matched": true,
    "mdn_mic_matched": true,
    "mdn_processing_success": true,
    "raw_uri": "example",
    "smime_uri": "example",
    "smime_signed_uri": "example",
    "encrypted_uri": "example",
    "mdn_response_uri": "example"
  }
]