Sample code for 30+ languages & platforms
CkPhp Requires Chilkat v11.0.0+

Clickatell One API: Send personalized SMS reminders in a batch

See more Clickatell Examples

Send two appointments in one request with a different text and application ID for each. Use two distinct recipient numbers in international digits. For a US two-way integration, add its provisioned from number to each message.

Read each recipient result even when HTTP 207 reports a mixed outcome. Save the accepted provider ID against the appointment. A missing result calls for checking the message report before retrying. A client message ID helps correlate records and does not guarantee deduplication.

Clickatell API reference

Chilkat CkPhp Downloads

CkPhp
<?php

include("chilkat.php");

//  Assumes Chilkat is unlocked. See Global Unlock Sample.
$http = new CkHttp();
$http->put_RequireSslCertVerify(true);
//  Load the key for this One API integration from your application configuration.
$http->SetRequestHeader('Authorization','ONE_API_KEY');
$http->SetRequestHeader('Accept','application/json');

$firstPhone = 'FIRST_PHONE_NUMBER';
$secondPhone = 'SECOND_PHONE_NUMBER';
$body = new CkJsonObject();
$body->UpdateString('messages[0].channel','sms');
$body->UpdateString('messages[0].to',$firstPhone);
$body->UpdateString('messages[0].content','Your appointment with Lee is at 10:00.');
$body->UpdateString('messages[0].clientMessageId','appt-1042');
$body->UpdateString('messages[1].channel','sms');
$body->UpdateString('messages[1].to',$secondPhone);
$body->UpdateString('messages[1].content','Your appointment with Sam is at 14:30.');
$body->UpdateString('messages[1].clientMessageId','appt-1043');

$resp = new CkHttpResponse();
$sent = $http->HttpJson('POST','https://platform.clickatell.com/v1/message',$body,'application/json',$resp);
if ($resp->get_StatusCode() == 0) {
    print 'No HTTP response. Check the message report before resending.' . "\n";
    exit;
}

$reply = new CkJsonObject();
$parsed = $reply->Load($resp->bodyStr());
if (($sent != true) or (($resp->get_StatusCode() != 202) and ($resp->get_StatusCode() != 207))) {
    print 'Send returned HTTP ' . $resp->get_StatusCode() . "\n";
    if ($reply->HasMember('error.description') == true) {
        print $reply->stringOf('error.description') . "\n";
    }

    exit;
}

if ($reply->HasMember('error.code') == true) {
    if ($reply->IsNullOf('error.code') != true) {
        print 'Submission error ' . $reply->stringOf('error.code') . '  ' . $reply->stringOf('error.description') . "\n";
        exit;
    }

}

//  Look up each submitted appointment in the reply using its unique recipient.
//  This works even if the result order changes or clientMessageId is absent.
$results = new CkJsonObject();
$i = 0;
while (($i < 2)) {
    $body->put_I($i);
    $appointment = $body->stringOf('messages[i].clientMessageId');
    $phone = $body->stringOf('messages[i].to');
    $result = new CkJsonObject();
    $found = $reply->FindRecord2('messages','to',$phone,true,$result);
    $results->put_I($i);
    $results->UpdateString('appointments[i].clientMessageId',$appointment);
    if (($found != true) or ($result->JsonTypeOf('accepted') != 5)) {
        $results->UpdateString('appointments[i].outcome','unknown');
        print $appointment . ' has no confirmed result.' . "\n";
    }
    else {
        if ($result->BoolOf('accepted') == true) {
            $results->UpdateString('appointments[i].outcome','accepted');
            if ($result->JsonTypeOf('apiMessageId') == 1) {
                $results->UpdateString('appointments[i].apiMessageId',$result->stringOf('apiMessageId'));
            }

            print $appointment . ' accepted.' . "\n";
        }
        else {
            $results->UpdateString('appointments[i].outcome','rejected');
            $results->UpdateString('appointments[i].reason',$result->stringOf('error.description'));
            print $appointment . ' rejected: ' . $result->stringOf('error.description') . "\n";
        }

    }

    $i = $i + 1;
}

//  This demo writes a snapshot. In an application, update the two appointment records.
$saved = $results->WriteFile('appointment-send-results.json');
if ($saved != true) {
    print 'Could not save the results. Reconcile the submitted messages before retrying.' . "\n";
    exit;
}

print 'Saved appointment-send-results.json' . "\n";

?>