Skip to main content

Bulk Sender ID Registration - REST API

To create sender IDs in bulk, you can use the SMSGlobal REST API endpoint. Please see the required structure below:

Andrew avatar
Written by Andrew
Updated over a week ago

Endpoint: /v2/sender-id

  • Obtain Sender ID list:

GET /v2/sender-id

Parameters:

Name

Requirement

Type

Description

id

\d+

integer

The sender id identifier.

Return:

Parameter

Type

Versions

Description

total

integer

>=v2

Total number of sender id objects

offset

integer

>=v2

Pagination Offset (default 1)

limit

integer

>=v2

Number of sender id objects to return

senderIds[]

array of objects (SenderIdRegistration)

>=v2

A collection of sender id objects

senderIds[][id]

integer

*

Id

senderIds[][senderId]

string

*

Sender id

senderIds[][createdDate]

DateTime

*

Created date

senderIds[][updatedDate]

DateTime

*

Updated date

senderIds[][country]

string

*

Country

senderIds[][status]

string

*

Status

Status Codes:

Status Code

Description

Returned when successful

Returned when input validation failed

Returned when the user is not authorized

Returned when the contact is not found

Method not allowed

  • Submit new Sender Id:

POST /v2/sender-id stable since v2

Parameters:

Parameter

Type

Required?

Format

Description

senderId

string

TRUE

Sender Id

country

choice

TRUE

Country

description

string

TRUE

A brief description on how are you going to use this Sender Id

businessname

string

TRUE

BusinessName

abn

string

TRUE

ABN/ACN/ARBN/ICN

/CRN

name

string

true

Name

email

string

TRUE

Email

phone

string

TRUE

Phone

industry

string

TRUE

Industry

contactMethod

choice

TRUE

{"Phone":0,"

Email":1}

Contact Method

businessLicense

file

TRUE

Business License Document. Max 10MB

proofOfRelationship

file

TRUE

Proof of Relationship Document. Please provide a document that clearly demonstrates the relationship between the parent and subsidiary company. Max 10MB

proofOfOwnership

file

TRUE

Proof of Ownership Document. Please submit a document that verifies your ownership of, or rights to use, the brand name you wish to register as your sender ID. Suitable forms of evidence include. Max 10MB

Return:

Parameter

Type

Versions

Description

id

integer

*

Id

senderId

string

*

Sender id

createdDate

DateTime

*

Created date

updatedDate

DateTime

*

Updated date

country

string

*

Country

status

string

*

Status

Status Codes:

Status Code

Description

Returned when successful

Returned when input validation failed

Returned when account is out of credits

Returned when the user is not authorized

Method not allowed

  • Get the Sender Id as identified by the given id.

GET /v2/sender-id/{id}

Requirements:

Name

Requirement

Type

Description

id

\d+

integer

The sender id identifier.

Return:

Parameter

Type

Versions

Description

id

integer

*

Id

senderId

string

*

Sender id

createdDate

DateTime

*

Created date

updatedDate

DateTime

*

Updated date

country

string

*

Country

status

string

*

Status

Status Codes:

Status Code

Description

Returned when successful

Returned when the user is not authorized

Returned when the contact is not found

Method not allowed

Did this answer your question?