Docy Child

Get SMS

Estimated reading: 2 minutes 462 views

Base URL

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

Method: GET

Parameters

Header ParametersDescription
APPKEYPlease add provided APPKEY – linked to your Cellcast account.
Content-Typeapplication/json

API Parameters

NameExampleDescription
message_idResponse of Message IDThe Message ID of the sent sms message.

Successful Responses

CodeStatusDescription
200SUCCESSRecord founded

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

StatusCodeDescription
AUTH_FAILED400You are not a registered user

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>>);
                                
				
			
CONTENTS