ORory
courier

List Messages

Changed on

Lists all messages by given status and recipient.

get/admin/courier/messages

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /admin/courier/messages
  • Auth
    API key in header Authorization

Query parameters

page_sizeinteger

Items per Page

This is the number of items per page to return. For details on pagination please head over to the pagination documentation.

page_tokenstring

Next Page Token

The next page token. For details on pagination please head over to the pagination documentation.

status'queued' | 'sent' | 'processing' | 'abandoned'

A Message's Status

Status filters out messages based on status. If no value is provided, it doesn't take effect on filter.

recipientstring

Recipient filters out messages based on recipient. If no value is provided, it doesn't take effect on filter.

Response

Paginated Courier Message List Response

bodystring required
channelstring
created_atstring date-time required

CreatedAt is a helper struct field for gobuffalo.pop.

idstring uuid required
recipientstring required
send_countinteger required
status'queued' | 'sent' | 'processing' | 'abandoned' required

A Message's Status

subjectstring required
template_type'recovery_invalid' | 'recovery_valid' | 'recovery_code_invalid' | 'recovery_code_valid' | 'verification_invalid' | 'verification_valid' | 'verification_code_invalid' | 'verification_code_valid' | 'stub' | 'login_code_valid' | 'registration_code_valid' required

recovery_invalid TypeRecoveryInvalid recovery_valid TypeRecoveryValid recovery_code_invalid TypeRecoveryCodeInvalid recovery_code_valid TypeRecoveryCodeValid verification_invalid TypeVerificationInvalid verification_valid TypeVerificationValid verification_code_invalid TypeVerificationCodeInvalid verification_code_valid TypeVerificationCodeValid stub TypeTestStub login_code_valid TypeLoginCodeValid registration_code_valid TypeRegistrationCodeValid

type'email' | 'phone' required

It can either be email or phone

updated_atstring date-time required

UpdatedAt is a helper struct field for gobuffalo.pop.

Example response

[
  {
    "dispatches": [
      {
        "updated_at": "2000-01-23T04:56:07.000+00:00",
        "created_at": "2000-01-23T04:56:07.000+00:00",
        "message_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "error": "{}",
        "status": "failed"
      },
      {
        "updated_at": "2000-01-23T04:56:07.000+00:00",
        "created_at": "2000-01-23T04:56:07.000+00:00",
        "message_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "error": "{}",
        "status": "failed"
      }
    ],
    "updated_at": "2000-01-23T04:56:07.000+00:00",
    "subject": "subject",
    "channel": "channel",
    "recipient": "recipient",
    "created_at": "2000-01-23T04:56:07.000+00:00",
    "send_count": 0,
    "template_type": "recovery_invalid",
    "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "body": "body",
    "type": "email",
    "status": "queued"
  }
]

Changes

  • 4f071812f3eaRevision changes
    • warning

      added the new login_code_valid enum value to the / response property for the response status

    • warning

      added the new registration_code_valid enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      removed the otp enum value from the / response property for the response status

  • 3f9901877db9Revision changes
    • warning

      deleted the query request parameter page

    • warning

      deleted the query request parameter per_page

    • info

      added the new optional query request parameter page_size

    • info

      added the new optional query request parameter page_token

    • info

      added the optional property / to the response with the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status