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 |
string | TRUE |
| ||
phone | string | TRUE |
| Phone |
industry | string | TRUE |
| Industry |
contactMethod | choice | TRUE | Select either {"Phone" or Email"} | Contact Method |
businessLicense | file | TRUE |
| Proof your company is legally registered. (e.g., Certificate of Incorporation, Business License, ABN, ASIC, etc.). Document. Max 10MB |
proofOfRelationship | file | Optional |
| Please provide a document that clearly demonstrates the relationship between the parent and subsidiary company. Confirms the parent-company connection. Max 10MB |
proofOfOwnership | file | Optional |
| 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 |
Endpoint for the ACMA submission:
New Sender Id: Submit new Sender ID
POST /v2/sender-id/acma stable since v2
Requirements:
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 |
| Business Name |
abn | string | TRUE |
| ABN/ACN/ARBN/ICN/CRN |
companyWebsite | string | TRUE |
| Web Address |
companyStreetAddress1 | string | TRUE |
| Company Street Address 1 |
companyStreetAddress2 | string | FALSE |
| Company Street Address 2 |
companyCity | string | TRUE |
| Company City |
companyGoverningDistrict | string | TRUE |
| Company Governing District |
companyPostalCode | string | TRUE |
| Company Postal Code |
companyCountry | choice | TRUE |
| Company Country |
name | string | TRUE |
| First Name |
lastName | string | TRUE |
| Last Name |
string | TRUE |
| ||
phone | string | TRUE |
| Phone |
contactMethod | choice | TRUE | {"Phone":0,"Email":1} | Contact Method |
associate | boolean | FALSE | “False” or “True” | Are you registering sender id to send SMS on behalf of another entity? When it's true, all entity associate fields are required. Entity Associate details only need to be filled once if there's no changes. |
eaBusinessName | string | FALSE |
| Business Name |
eaAbn | string | FALSE |
| ABN/ACN/ARBN/ICN/CRN |
eaCompanyWebsite | string | FALSE |
| Web Address |
eaCompanyStreetAddress1 | string | FALSE |
| Company Street Address 1 |
eaCompanyStreetAddress2 | string | FALSE |
| Company Street Address 2 |
eaCompanyCity | string | FALSE |
| Company City |
eaCompanyGoverningDistrict | string | FALSE |
| Company Governing District |
eaCompanyPostalCode | string | FALSE |
| Company Postal Code |
eaCompanyCountry | choice | FALSE |
| Company Country |
eaTitle | string | FALSE |
| Title |
eaFirstName | string | FALSE |
| First Name |
eaLastName | string | FALSE |
| Last Name |
eaEmail | string | FALSE |
| |
eaPhone | string | FALSE |
| Phone |
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: