Get Responses

Estimated reading: 2 minutes 795 views

Base URL

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

Method: GET

Parameters

Header Parameters	Description
APPKEY	Please add provided APPKEY – linked to your Cellcast account.
Content-Type	application/json

API Parameters

Name	Example	Description
page	Page number	Pass page number.Default value is 1
type	Response of SMS	pass ‘sms’ value to get only responses of sent SMS

Successful Responses

Code	Status	Description
200	SUCCESS	You have <<Total Responses>> response(s)

Response	Description
from	Recipient Mobile Number that sent the reply message.
body	Inbound message body.
received_at	Received date and time.
original_body	Original outgoing SMS message body.
original_message_id	Original SMS message ID. Returned when originally sending the message.
message_id	The Message ID for the inbound message.

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": "2019-04-08 17:37:49",
                "message_id": "dba864ec-e486-4647-82c4-d0b94771080b", // Response Message ID(inbound_id)
            }
        ]
    }
}

Error Response

Status	Code	Description
AUTH_FAILED	400	You are not a registered user
NOT_FOUND	400	No Response are available!

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