With our SMS messaging API you can:

1. Send SMS messages.
2. Receive real time delivery reports (DLR) for all messages sent.
3. Receive replies and inbound SMS messages.

Our simple REST API allows you to get up and running in minutes, just follow the helpful Quick Start guide. For advanced users, dig deeper into our technology and check our reference guides for more detailed functions and calls. We have a wide range of calls to mirror useful functionality on the site at both user and reseller level. We also offer code samples in order to make your experience using the API suite as clean as possible.

So let's now look at how to use and get the best out of the REST API.

Security

To ensure security & privacy the API only works over HTTPS protocol for all requests. Also, for your own security, If you have a website with a form which sends SMS be sure to send the request from your server and not directly from the browser otherwise you will be giving away your API secret and opening the floodgates to unwanted charges.

Authentication

All API requests require your API credentials, We will provide you APPKEY. For Security API credentials must be passed as HTTP Basic Authentication headers not as CGI parameters.

Throttling

To provide the best service to all our customers we limit the number of API calls which can be made by each account to 15 calls per sec. For heavy users we can increase your throttling speed, but please contact us to discuss your requirements. If you exceed this limit we will return two indicators which you can use in your code to detect that you have been throttled. The first is the HTTP status code 429 "Too Many Requests", the second is the error code "OVER_LIMIT" in the error block of the response body.

Pagination

Some responses are too large to be returned in one go so we paginate. To identify which calls use pagination look for the "page" parameters in the parameter descriptions for each API call. These calls include a "page" block in the response with two values, "count" and "number". Count tells you how many pages are available and number indicates the page number you are on. The page parameter is used to request a certain page, it defaults to 1. 25 responses will be returned per page.

Error Reporting

Always check if your API call was successful or resulted in error. You may check the following

1. 200 OK response header. It will be 4xx if an error occurred.
2. error->code structure should equal to 'SUCCESS'Note that some API functions can return custom errors of their own (listed in appropriate document sections). Check the error->description for details, e.g. which field caused an error or which resource you don’t have access to.

We can't wait to see what you build!

Base URL:

https://cellcast.com.au/api/v3/send-sms

Method: POST

Parameters

SMS Data Parameters

Successful Responses

Successful Responses look like:

{
    "meta": {
        "code": 200,
        "status": "SUCCESS"
    },
    "msg": "Queued",
    "data": {
        "messages": [
            {
                "message_id": "6EF87246-52D3-74FB-C319-NNNNNNNNNN",
                "from" : "SENDER_ID",
                "to": "+614NNNNNNNN",
                "body": "SMS body here",
                "date": "2019-06-15 14:02:29",
                "custom_string": "lead",
                "direction": "out"
            }
        ],
        "total_numbers": 1,
        "success_number": 1,
        "credits_used": 1
    },
    "low_sms_alert": "Your account credits are low, you have 36.80 credits remaining, please top-up via the platform"
}

Error Response

Error Responses look like:

{
    "meta": {
        "code": 400,
        "status": "FIELD_INVALID"
    },
    "msg": "You can send the maximum message length of 918 characters, or send a message length of 402 characters for the Unicode character set.",
    "data": []
}

PHP Code Example

You can call following function to send SMS.

Need to pass "SMS text" and "Mobile number array" parameters for this function

function sendSms($text, $phone_number) {
    try {
        $url = 'https://cellcast.com.au/api/v3/send-sms'; //API URL
        $fields = array(
            'sms_text' => $text, //here goes your SMS text
            'numbers' => $phone_number // Your numbers array goes here
        );
        $headers = array(
            'APPKEY: <<APPKEY>>',
            'Accept: application/json',
            'Content-Type: application/json',
        );

        $ch = curl_init(); //open connection
        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, count($fields));
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($fields));
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        if (!$result = curl_exec($ch)) {
            $response_error = json_decode(curl_error($ch));
            return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again", "result" => $response_error));
        }
        curl_close($ch);
        return json_encode(array("status" => 200, "msg" => "SMS sent successfully", "result" => json_decode($result)));
    } catch (\Exception $e) {
        return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again.", "result" => array()));
    }
}
                                

Call Function

//Set text and mobile numbers
$text = "Hi User, This is my first SMS Test!";
$phone_number = array("<<Number1>>","<<Number2>>","<<Number3>>");

//Call function to send SMS
sendSms($text, $phone_number);
                                

Base URL:

https://cellcast.com.au/api/v3/get-sms?message_id=<<message_id>>

Method: GET

Parameters

API Parameters

Successful Responses

Successful Responses look like:

{
    "meta": {
        "code": 200,
        "status": "SUCCESS"
    },
    "msg": "Record founded",
    "data": [
        {
            "to": "+61NNNNNNNNN",
            "body": "Here is sent message content",
            "sent_time": "2019-06-15 14:04:46",
            "message_id": "6EF87246-52D3-74FB-C319-NNNNNNN",
            "status": "Delivered",
            "subaccount_id": ""
        }
    ]
}

Error Response

Error Responses look like:

{
    "meta": {
        "code": 401,
        "status": "AUTH_FAILED"
    },
    "msg": "APPKEY you have provided is invalid",
    "data": []
}

PHP Code Example

You can call following function to get SMS details.

function getSms($message_id) {
    try {
        $url = 'https://cellcast.com.au/api/v3/get-sms?message_id=$message_id'; //API URL

        $headers = array(
            'APPKEY: <<APPKEY>>',
            'Accept: application/json',
            'Content-Type: application/json',
        );

        $ch = curl_init(); //open connection
        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_TIMEOUT, 4);
        if (!$result = curl_exec($ch)) {
            $response_error = json_decode(curl_error($ch));
            return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again", "result" => $response_error));
        }
        curl_close($ch);
        return json_encode(array("status" => 200, "msg" => "Successfully received", "result" => json_decode($result)));

    } catch (\Exception $e) {
        return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again.", "result" => array()));
    }
}
                                

Call Function

//Call function to get sms details
$response_status = getSms(<<message_id>>);
                                

Base URL:

https://cellcast.com.au/api/v3/get-responses?page=<<page_number>>&type=sms

Method: GET

Parameters

API Parameters

Successful Responses

Successful Responses look like:

{
    "meta": {
        "code": 200,
        "status": "SUCCESS"
    },
    "msg": "You have 1 response(s)",
    "data": {
        "page": {
            "count": 1,
            "number": 1
        },
        "total": "1",
        "responses": [
            {
                "from": "+614NNNNNNNN",
                "body": "Received ",
                "received_at": "2024-09-18 07:15:36",
                "custom_string": "",
                "original_body": "Hello Sent outbound",
                "original_message_id": "9ECD7AEC-C92B-B5F4-8EC8-278F028FEB8B",
                "message_id": "5000000001"
            }
        ]
    }
}

Error Response

Error Responses look like:

{
    "meta": {
        "code": 401,
        "status": "AUTH_FAILED"
    },
    "msg": "APPKEY you have provided is invalid",
    "data": []
}

PHP Code Example

You can call following function to get SMS responses.

function getSmsResponses($page = 1) {
    try {
        $url = 'https://cellcast.com.au/api/v3/get-responses?page=' .$page.'&type=sms'; //API URL
        $headers = array(
            'APPKEY: <<APPKEY>>',
            'Accept: application/json',
            'Content-Type: application/json',
        );

        $ch = curl_init(); //open connection
        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_TIMEOUT, 4);
        if (!$result = curl_exec($ch)) {
            $response_error = json_decode(curl_error($ch));
            return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again", "result" => $response_error));
        }
        curl_close($ch);
        return json_encode(array("status" => 200, "msg" => "Successfully received", "result" => json_decode($result)));

    } catch (\Exception $e) {
        return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again.", "result" => array()));
    }
}
                                

Call Function

//Call function to get sms status function
$response_status = getSmsResponses(<<page_number>>);
                                

Base URL:

https://cellcast.com.au/api/v3/inbound-read

Method: POST

Parameters

API Parameters

You can use one parameter at a time. If you want to change status using message_id then you just need to pass message_id. If you want to mark all as read before given timestamp then you can pass only "date_before" parameter.

You can set the status of inbound messages of your account.

Successful Responses

Successful Responses look like:

{
    "meta": {
        "code": 200,
        "status": "SUCCESS"
    },
    "msg": "Inbound messages have been marked as read.",
    "data": []
}

Error Response

Error Responses look like:

{
    "meta": {
        "code": 401,
        "status": "AUTH_FAILED"
    },
    "msg": "APPKEY you have provided is invalid",
    "data": []
}

PHP Code Example

You can call following function to get SMS responses.

function setSmsInboundStatus($timestamp) {
    try {
        $url = 'https://cellcast.com.au/api/v3/inbound-read'; //API URL
        $fields = array(
            'message_id' => $message_id, //here goes your inbound message ID
        );

        // If you want to mark all inbound message as read optionally before a certain date.
        //$fields = array(
        //    'date_before' => $date_before, //here goes your date timestamp
        //);

        $headers = array(
            'APPKEY: <<APPKEY>>',
            'Accept: application/json',
            'Content-Type: application/json',
        );

        $ch = curl_init(); //open connection
        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, count($fields));
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($fields));
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        if (!$result = curl_exec($ch)) {
            $response_error = json_decode(curl_error($ch));
            return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again", "result" => $response_error));
        }
        curl_close($ch);
        return json_encode(array("status" => 200, "msg" => "Successfully set status", "result" => json_decode($result)));
    } catch (\Exception $e) {
        return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again.", "result" => array()));
    }
}
                                

Call Function

//Call function to get sms status function
$response_status = setSmsInboundStatus(<<message_id>>);
                                

Base URL:

https://cellcast.com.au/api/v3/inbound-read-bulk

Method: POST

Parameters

API Parameters

You can use one parameter at a time. If you want to change status using message_id then you just need to pass message_id. If you want to mark all as read before given timestamp then you can pass only "date_before" parameter.

You can set the status of inbound messages of your account.

Successful Responses

Successful Responses look like:

{
    "meta": {
        "code": 200,
        "status": "SUCCESS"
    },
    "msg": "Inbound messages have been marked as read.",
    "data": []
}

Error Response

Error Responses look like:

{
    "meta": {
        "code": 401,
        "status": "AUTH_FAILED"
    },
    "msg": "APPKEY you have provided is invalid",
    "data": []
}

PHP Code Example

You can call following function to get SMS responses.

function setSmsInboundStatus($timestamp) {
    try {
        $url = 'https://cellcast.com.au/api/v3/inbound-read'; //API URL
        $fields = array(
            'message_id' => $message_id, //here goes your inbound message ID
        );

        // If you want to mark all inbound message as read optionally before a certain date.
        //$fields = array(
        //    'date_before' => $date_before, //here goes your date timestamp
        //);

        $headers = array(
            'APPKEY: <<APPKEY>>',
            'Accept: application/json',
            'Content-Type: application/json',
        );

        $ch = curl_init(); //open connection
        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, count($fields));
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($fields));
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        if (!$result = curl_exec($ch)) {
            $response_error = json_decode(curl_error($ch));
            return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again", "result" => $response_error));
        }
        curl_close($ch);
        return json_encode(array("status" => 200, "msg" => "Successfully set status", "result" => json_decode($result)));
    } catch (\Exception $e) {
        return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again.", "result" => array()));
    }
}
                                

Call Function

//Call function to get sms status function
$message_id = array("<>","<>","<>");
$response_status = setSmsInboundStatus($message_id);
                                

To receive SMS messages in real-time, please log in to your Cellcast account to set up the URL where the messages will be forwarded to. Cellcast recommends using a HTTPS URL.

When receiving SMS messages in real-time, Cellcast’s server will send a HTTP POST to the URL you have specified, as soon as a message is received.

Parameters

PHP Code to retrieve POST data:

$json = file_get_contents('php://input');
$data = json_decode($json, true);

Base URL:

https://cellcast.com.au/api/v3/get-optout

Method: GET

Parameters

API Parameters

How do I activate the opt-out list via API?

- Select 'Settings' on the left menu, then select 'Inbound sms settings'.

- Select 'Active' from 'Opt-out for API' dropdown.

Successful Responses

Successful Responses look like:

{
    "meta": {
        "code": 200,
        "status": "SUCCESS"
    },
    "msg": "You have 1 optout contact(s)",
    "data": {
        "page": {
            "count": 1,
            "number": 1
        },
        "total": "3",
        "responses": [
            {
                "number": "+61NNNNNNNNN",
                "first_name": "Peter",
                "last_name": "berg",
                "gender": "Male",
                "post_code": "6688",
                "dob": "2010-11-12",
                "created_at": null
            }
        ]
    }
}

Error Response

Error Responses look like:

{
    "meta": {
        "code": 401,
        "status": "AUTH_FAILED"
    },
    "msg": "APPKEY you have provided is invalid",
    "data": []
}

PHP Code Example

You can call following function to get SMS responses.

function getOptoutList() {
    try {
        $url = 'https://cellcast.com.au/api/v3/get-optout'; //API URL

        $headers = array(
            'APPKEY: <<APPKEY>>',
            'Accept: application/json',
            'Content-Type: application/json',
        );

        $ch = curl_init(); //open connection
        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_TIMEOUT, 4);
        if (!$result = curl_exec($ch)) {
            $response_error = json_decode(curl_error($ch));
            return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again", "result" => $response_error));
        }
        curl_close($ch);
        return json_encode(array("status" => 200, "msg" => "Successfully set status", "result" => json_decode($result)));
    } catch (\Exception $e) {
        return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again.", "result" => array()));
    }
}
                                

Call Function

//Call function to get opt out list function
$response_status = getOptoutList();
                                

The status field describes which state a particular message is in. Please note that statuses of type Intermediate will only be reported if you request a status per recipient (Retrieve a recipient delivery report), no callback will be made to report them.

POST callback-url
[
    {
        "message_id":"0061DF26-B015-D7F6-7B31-C446BA4FDE8B",
        "status":"Delivered",
        "recipient":"61NNNNNNNNN",
        "custom_string":"Custom string",
        "source":"Source"
    }
]

Please contact us to setup Callback URL

NOTE:The security cert must match the domain name being used, self signed certs will not verify and will generate errors.

The following statuses are available when using the REST API:

Base URL:

https://cellcast.com.au/api/v3/account

Method: GET

Parameters

Successful Responses

Successful Responses look like:

{
    "meta": {
        "code": 200,
        "status": "SUCCESS"
    },
    "msg": "Here's your account",
    "data": {
        "account_name": "John",
        "account_email": "john@domain.com",
        "sms_balance": "5831.43",
        "mms_balance": "1006.00"
    }
}

Base URL:

https://cellcast.com.au/api/v3/get-template

Method: GET

Parameters

Successful Responses

Successful Responses look like:

{
    {
    "meta": {
        "code": 200,
        "status": "SUCCESS"
    },
    "msg": "You have 2 Template(s)",
    "data": {
        "page": {
            "count": 1,
            "number": 1
        },
        "total": "2",
        "per_page": 15,
        "responses": [
            {
                "template_id": "5e6786ade15ac71272e139b9f393e345",
                "message_title": "New template u",
                "Message": "Hello {fname},\r\n\r\nTest from Cellcast",
                "created_at": "2023-07-13 01:25:49"
            },
            {
                "template_id": "21b7acea52c12f59517e491fbecee169",
                "message_title": "Test Template",
                "Message": "Hello {fname}\r\n\r\nTest ",
                "created_at": "2023-07-13 01:33:21"
            }
        ]
    }
}
}

Base URL:

https://cellcast.com.au/api/v3/send-sms-template

Method: POST

Parameters

SMS Data Parameters

[{"number":"61413XXXXXX",
"fname":"First name",
"lname":"Last name",
"gender":"Gender",
"post_code":"Post Code",
"dob":"Date of Birth",
"custom_value_1":"Custom Value 1",
"custom_value_2":"Custom Value 2",
"custom_value_3":"Custom Value 3",
"special":"Special"}]

Successful Responses

Successful Responses look like:

{
    "meta": {
        "code": 200,
        "status": "SUCCESS"
    },
    "msg": "Queued",
    "data": {
        "messages": [
            {
                "message_id": "6EF87246-52D3-74FB-C319-NNNNNNNNNN",
                "from" : "SENDER_ID",
                "to": "+614NNNNNNNN",
                "body": "SMS body here",
                "date": "2019-06-15 14:02:29",
                "custom_string": "lead",
                "direction": "out"
            }
        ],
        "total_numbers": 1,
        "success_number": 1,
        "credits_used": 1
    }
}

Error Response

Error Responses look like:

{
    "meta": {
        "code": 400,
        "status": "FIELD_INVALID"
    },
    "msg": "You can send the maximum message length of 918 characters, or send a message length of 402 characters for the Unicode character set.",
    "data": []
}

PHP Code Example

You can call following function to send SMS.

Need to pass "SMS text" and "Mobile number array" parameters for this function

function sendSms($text, $phone_number) {
    try {
        $url = 'https://cellcast.com.au/api/v3/send-sms-template'; //API URL
        $fields = array(
            'sms_text' => $text, //here goes your SMS text
            'numbers' => $phone_number // Your numbers array goes here
        );
        $headers = array(
            'APPKEY: <<APPKEY>>',
            'Accept: application/json',
            'Content-Type: application/json',
        );

        $ch = curl_init(); //open connection
        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, count($fields));
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($fields));
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        if (!$result = curl_exec($ch)) {
            $response_error = json_decode(curl_error($ch));
            return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again", "result" => $response_error));
        }
        curl_close($ch);
        return json_encode(array("status" => 200, "msg" => "SMS sent successfully", "result" => json_decode($result)));
    } catch (\Exception $e) {
        return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again.", "result" => array()));
    }
}
                                

Base URL:

https://cellcast.com.au/api/v3/bulk-send-sms

Method: POST

Parameters

SMS Data Parameters

Successful Responses

Successful Responses look like:

[
{
    "meta": {
        "code": 200,
        "status": "SUCCESS"
    },
    "msg": "Queued",
    "data": {
        "messages": [
            {
                "message_id": "6EF87246-52D3-74FB-C319-NNNNNNNNNN",
                "from" : "SENDER_ID",
                "to": "+614NNNNNNNN",
                "body": "SMS body here",
                "date": "2019-06-15 14:02:29",
                "custom_string": "lead",
                "direction": "out"
            }
        ],
        "total_numbers": 1,
        "success_number": 1,
        "credits_used": 1
    }
},
{
    "meta": {
        "code": 200,
        "status": "SUCCESS"
    },
    "msg": "Queued",
    "data": {
        "messages": [
            {
                "message_id": "6EF87246-52D3-74FB-C319-NNNNNNNNNN",
                "from" : "SENDER_ID",
                "to": "+614NNNNNNNN",
                "body": "SMS body here",
                "date": "2019-06-15 14:02:29",
                "custom_string": "lead",
                "direction": "out"
            }
        ],
        "total_numbers": 1,
        "success_number": 1,
        "credits_used": 1
    }
}

]

Error Response

Error Responses look like:

[
{
    "meta": {
        "code": 400,
        "status": "FIELD_INVALID"
    },
    "msg": "You can send the maximum message length of 918 characters, or send a message length of 402 characters for the Unicode character set.",
    "data": []
},
{
    "meta": {
        "code": 400,
        "status": "FIELD_INVALID"
    },
    "msg": "You can send the maximum message length of 918 characters, or send a message length of 402 characters for the Unicode character set.",
    "data": []
}
]

PHP Code Example

You can call following function to send SMS.

Need to pass "SMS text" and "Mobile number array" parameters for this function

function sendSms($fields) {
    try {
        $url = 'https://cellcast.com.au/api/v3/bulk-send-sms'; //API URL

        $headers = array(
            'APPKEY: <<APPKEY>>',
            'Accept: application/json',
            'Content-Type: application/json',
        );

        $ch = curl_init(); //open connection
        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, count($fields));
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($fields));
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        if (!$result = curl_exec($ch)) {
            $response_error = json_decode(curl_error($ch));
            return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again", "result" => $response_error));
        }
        curl_close($ch);
        return json_encode(array("status" => 200, "msg" => "SMS sent successfully", "result" => json_decode($result)));
    } catch (\Exception $e) {
        return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again.", "result" => array()));
    }
}
                                

Call Function

//Set text and mobile numbers
$message = array(
        array(
            'sms_text' => "Hi User Test one message", //here goes your SMS text
            'numbers' => "<<Number1>>" // Your numbers array goes here
        ),
        array(
            'sms_text' => "Hi User Test two message", //here goes your SMS text
            'numbers' => "<<Number2>>" // Your numbers array goes here
        )
        );
//Call function to send SMS
sendSms($message);
                                

Base URL:

https://www.cellcast.com.au/api/v3/register-alpha-id

Method: POST

Parameters

SMS Data Parameters

Successful Responses

Successful Responses look like:

[{
    "meta": {
        "code": 200,
        "status": "SUCCESS"
    },
    "msg": "Alpha ID is successfully registered! Please check portal for Alpha ID status",
    "data": []
}]

Error Response

Error Responses look like:

[
{
    "meta": {
        "code": 400,
        "status": "ALREADY_EXISTS"
    },
    "msg": "The Alpha ID is already registered",
    "data": []
}
]

PHP Code Example

You can call following function to send SMS.

Need to pass "SMS text" and "Mobile number array" parameters for this function

function registerID($fields) {
    try {
        $url = 'https://www.cellcast.com.au/api/v3/register-alpha-id'; //API URL

        $headers = array(
            'APPKEY: <<APPKEY>>',
            'Accept: application/json',
            'Content-Type: application/json',
        );

        $ch = curl_init(); //open connection
        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, count($fields));
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($fields));
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        if (!$result = curl_exec($ch)) {
            $response_error = json_decode(curl_error($ch));
            return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again", "result" => $response_error));
        }
        curl_close($ch);
        return json_encode(array("status" => 200, "msg" => "Alpha ID is successfully registered! Please check portal for Alpha ID status", "result" => json_decode($result)));
    } catch (\Exception $e) {
        return json_encode(array("status" => 400, "msg" => "Something went to wrong, please try again.", "result" => array()));
    }
}
                                

Call Function

//Set text and mobile numbers
$customIDArr = array(
            'custom_id' => "TestCustomID", //here goes your Custom ID
        );
//Call function to Register Custom ID
registerID($customIDArr);
                                

Regular ID:

For pricing relating to general SMS & MMS messaging using Cellcast Regular ID, please refer to pricing listed online - www.cellcast.com.au

Custom ID:

Messaging containing custom 'numbers' or 'names' are subject to Regular ID pricing plus an additional 33% per message.

Can I send messages in excess of 160 characters?

You have the capability of sending messages in excess of 160 characters through our services.

When sending a message in excess of 160 characters, the message is broken up in to message parts of 153 characters, and sent to the handset. The handset then reassembles the message, displaying the message as one extended-length, concatenated message. When sending an extended-length message you are charged for each 153 character part that is sent. This charging process is dictated by the network operators.

You can send the maximum message length of 918 characters, or send a message length of 402 characters for the Unicode character set.

What characters are part of the Unicode charset?

The Unicode character list contains symbols from the Cyrillic, Chinese, Arabic, Korean and Hangul alphabets. It also contains several special symbols (such as emoticons, emoji and kanji).

Unicode character list: here

GSM Charset: The GSM 03.38 charset is the standard character set for text messaging on GSM-based cell phones. All GSM handsets and network elements support the GSM 7-bit alphabet. The basic GSM charset contains the letters A to Z (uppercase and lowercase), numbers, special symbols and several symbols from the Greek alphabet.

@ Δ   SP  0   ¡   P   ¿   p
£   _   !   1   A   Q   a   q
$   Φ   "   2   B   R   b   r
¥   Γ   #   3   C   S   c   s
è   Λ   ¤   4   D   T   d   t
é   Ω   %   5   E   U   e   u
ù   Π   &   6   F   V   f   v
ì   Ψ   '   7   G   W   g   w
ò   Σ   (   8   H   X   h   x
Ç   Θ   )   9   I   Y   i   y
LF  Ξ   *   :   J   Z   j   z
Ø   ESC +   ;   K   Ä   k   ä
ø   Æ   ,   <    L   Ö   l   ö

Escape Characters: Some characters in the GSM 03.38 extension table can only be used at the cost of two characters. The GSM charset uses 7-bit alphabet encoding, but the escape characters require 14 bits to encode, thus taking up two characters. These symbols are:  |, ^, {, }, €, [, ~, ] and \.

Unicode Symbols: Unicode is a standard for encoding, handling and representing the text expressed in many of the world’s writing systems. The latest list of Unicode symbols contains over 120,000 characters from multiple symbol sets and 129 historic and modern scripts.

Unicode Encoding: Compared to the GSM charset, Unicode encoding supports a huge range of languages and symbols. However, if your text message contains a symbol that isn’t in the 7-bit alphabet, UCS-2 encoding must be used. This type of encoding takes up a lot of space, thus reducing the number of characters allowed in a message to 70.

Australian Mobile format

You can send an SMS to any Australian Mobile number.

Allocation for numbers in the range 04xy z00 000 – 04xy z99 999

Valid Mobile Numbers format:

1. +614NNNNNNNN
2. 04NNNNNNNN

Master List of Emojis

Simply highlight and copy the emoji of your choice from any emoji column below. Then paste it where you want it to appear. This will work well in messages, chats, and social media posts.

"If you cannot see some emojis from the list below, we recommend using the latest version of Chrome since some emojis are part of the new release and may not be viable in your browser just yet. They will still work however if you copy and paste just like any other emoji."

*** Reminder: Unicode characters are larger in bytes and will decrease your SMS character limit from 160 to 70 ***

Importing data into Postman

You can import Cellcast collection specifications directly into Postman

To import your data into Postman:
1. Select Import in the left navigation menu.
2. Select Cellcast Collection JSON file.
3. Select Import to bring your data into Postman

Cellcast V3 Collection: Download

Contact us

Email: info@cellcast.com
Melbourne Office:
Level 2, 40 Porter St, Prahran, VIC 3181, Australia
Australia & NZ: +61 (03) 8560 7025

Get in touch, send us a message to arrange a coffee catch-up