List sender IDs

Returns the sender IDs you can send from. Messages must be sent from one of these. Add new sender IDs in the web app at https://app.touchsms.com.au/settings/sender-ids. Not paginated.

GET

https://app.touchsms.com.au/api/v2/account/sender-ids

Authorization

basicAuth
HTTP
required

Query parameters

country
optional
string
ISO country code. Only return sender IDs usable for this destination country.

maxLength: 3 · minLength: 2
message_type
optional
sms
or
mms
Return sender IDs that can send this type of message.

default: "sms"

Returns

200

Allowed sender IDs.

JSON

data
optional
array of
object
- type
  optional
  own
  or
  shared
  or
  dedicated
  or
  verified
  or
  custom
- type_description
  optional
  string
- sender_id
  optional
  string
  Value to pass as from when sending.
- label
  optional
  string
- enabled
  optional
  boolean
- default
  optional
  boolean
  Whether this is your default sender ID.
- acma_unverified
  optional
  boolean
  The sender ID is not yet registered with the ACMA Sender ID Register.
- verify_url
  optional
  string | null
  Where to complete registration, if required.
}

401

Missing, malformed or invalid API credentials.

JSON

message
string
required

422

The request failed validation. errors lists the messages for each invalid field.

JSON

message
optional
string
errors
optional
map of
array<string>

{ "data": [ { "type": "dedicated", "type_description": "Dedicated", "sender_id": "61491570159", "label": "61491570159 (Virtual Number)", "enabled": true, "default": true, "acma_unverified": false, "verify_url": null } ] }