Account Functions

Get valid sending numbers and sender IDs

Get the virtual numbers, personal numbers and verified alphanumeric sender IDs the account can send from, plus the shared-pool row

get/get-validnumbers/

Request

  • Base URL: http://api.smsfusion.com.au
  • URL: http://api.smsfusion.com.au/get-validnumbers/
  • Auth: one of:
    • API key in query parameter key
    • HTTP basic

Query parameters

keystring required

API Key as generated from the <a href='https://www.smsfusion.com.au/admin/api/'>admin panel</a>

Response

Successfull response

numberstring

The virtual number, personal number, or alphanumeric sender ID; the literal string 'shared' for the shared-pool row

namestring

Friendly name, or the number/sender ID itself if no friendly name is set

type'virtual' | 'personal' | 'senderid' | 'shared'

The kind of sending identity. 'shared' is the always-present shared-pool row: the actual sending number is chosen per destination at send time, so its region is nominal

regionstring

Country the number is registered to (virtual numbers and the shared-pool row only)

Example response

[
  {
    "number": "61412345678",
    "name": "My Number",
    "region": "AU"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.