Inbound Read

Estimated reading: 2 minutes 446 views

Base URL:

Method: POST


Header ParametersDescription
APPKEYPlease add provided APPKEY – linked to your Cellcast account.

API Parameters

message_idResponse of Message IDThe Message ID for the inbound message. We are consider first “message_id” parameter.
date_beforeDate timestampAn optional timestamp – mark all as read before this timestamp. If not given, all messages will be marked as read.

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


200SUCCESSYou have <<Total Responses>> response(s)
Successful Responses look like
    "meta": {
        "code": 200,
        "status": "SUCCESS"
    "msg": "Inbound messages have been marked as read.",
    "data": []

Error Response

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 MMS responses.

					function setMmsInboundStatus($message_id) {
    try {
        $url = ''; //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 inbound message ID

        $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));
        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 mms status function
$response_status = setMmsInboundStatus(<<message_id>>);