KUkudosity
Senders

List sender registrations

Changed on

Returns a paginated list of sender registrations for the authenticated account.

  • If the account does not use parent/child accounts, the API returns registrations for the authenticated account.
  • If the account is a parent account, the API returns the registrations it created, for its own account and for its child accounts. Registrations a child account created itself aren't included.

Every registration carries account_id, the account it belongs to. Use the account_id query parameter to narrow the list to some of those accounts.

get/v2/senders/registrations

Request

  • Base URL
    https://api.transmitmessage.com
  • Auth
    API key in header x-api-key

Query parameters

pageinteger

Page number to return (1-based). Default 1.

limitinteger

Maximum number of results per page. Default 25, maximum 100.

child_account_idstring

Deprecated: use account_id, which accepts more than one account. Returns only the registrations of this account: your own account or one of your child accounts. The API returns 404 Not Found for an account that isn't visible to you, and 403 Forbidden for one that's visible but you don't manage. Before these responses were added, an account you couldn't use returned an empty list. Can't be combined with account_id.

account_idstring[]

Returns only registrations whose account_id is one of these accounts. Accepts one or more comma-separated account IDs: your own account and any of your child accounts. The API returns 404 Not Found for an account that isn't visible to you, and 403 Forbidden for one that's visible but you don't manage. Up to 100 values.

The list holds the registrations you created, for your own account or for a child account; registrations a child account created itself aren't included. Can't be combined with account_scope or child_account_id.

account_scope'all'

Set to all to return the registrations you created, for your own account and for any of your child accounts; registrations a child account created itself aren't included. This is also what the API returns when you omit it; the parameter is accepted so you can send the same one as on GET /v2/senders. Combined with child_account_id, it returns that account's registrations only.

searchstring

Returns registrations whose sender, or the company name of the child account they belong to, contains this text. The match ignores case.

senderstring

Filter registrations by sender phone number in E.164 format (e.g., 61412312312).

statusstring

Filter registrations by status. Accepts one or more comma-separated values. Valid values: PENDING_APPROVAL, SUBMITTED_TO_REGISTRY, VERIFIED, REJECTED, CANCELLED.

registry_statusAlphanumericStatus[]

Returns alphanumeric registrations whose details.alphanumeric.status is one of these values. Accepts one or more comma-separated values. Personal mobile number registrations have no registry status, so they're left out when you set it.

[
  "PENDING_CUSTOMER"
]
registry'ACMA'

The registry body an alphanumeric sender registration is submitted to.

  • ACMA — Australian Communications and Media Authority.

Returns alphanumeric registrations submitted to this registry. Personal mobile number registrations are left out when you set it.

sort'created_at' | 'updated_at' | 'sender' | 'status' | 'registry_status'

A field the registrations list can be sorted by. status sorts by the registration's status; registry_status sorts by details.alphanumeric.status, with registrations that have none last.

The field to sort by. Default created_at. Ties are broken by registration_id, so paging through a sorted list doesn't repeat or skip registrations.

order'asc' | 'desc'

The sort direction. Default desc.

Response

Successful response containing a paginated list of sender registrations.

requestobject

Optional metadata (e.g. requestId, traceId)

Example response

{
  "data": {
    "registrations": [
      {
        "account_id": "1234",
        "details": {
          "alphanumeric": {
            "status": "PENDING_CUSTOMER",
            "status_reason": "Customer has not taken any actions"
          }
        }
      }
    ]
  },
  "meta": {
    "pagination": {
      "type": "page",
      "page": 1,
      "limit": 25,
      "total_count": 123
    }
  }
}

Changes

  • 1eb213b51680Revision changes
    • info

      added the new optional query request parameter account_id

    • info

      added the new optional query request parameter account_scope

    • info

      added the new optional query request parameter order

    • info

      added the new optional query request parameter registry

    • info

      added the new optional query request parameter registry_status

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter sort

    • info

      query request parameter child_account_id was deprecated

  • e6206dcd3439Revision changes
    • breaking

      added to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • warning

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

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      response property allOf[subschema #2]/data/registrations/items/child_account_id deprecated

    • info

      added the required property //// to the response with the status