Sample code for 30+ languages & platforms
Delphi ActiveX 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 Delphi ActiveX Downloads

Delphi ActiveX
var
http: TChilkatHttp;
firstPhone: WideString;
secondPhone: WideString;
body: TChilkatJsonObject;
resp: TChilkatHttpResponse;
sent: Integer;
reply: TChilkatJsonObject;
parsed: Integer;
results: TChilkatJsonObject;
i: Integer;
appointment: WideString;
phone: WideString;
result: TChilkatJsonObject;
found: Integer;
saved: Integer;

begin
//  Assumes Chilkat is unlocked. See Global Unlock Sample.
http := TChilkatHttp.Create(Self);
http.RequireSslCertVerify := 1;
//  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 := TChilkatJsonObject.Create(Self);
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 := TChilkatHttpResponse.Create(Self);
sent := http.HttpJson('POST','https://platform.clickatell.com/v1/message',body.ControlInterface,'application/json',resp.ControlInterface);
if (resp.StatusCode = 0) then
  begin
    Memo1.Lines.Add('No HTTP response. Check the message report before resending.');
    Exit;
  end;
reply := TChilkatJsonObject.Create(Self);
parsed := reply.Load(resp.BodyStr);
if ((sent <> 1) or ((resp.StatusCode <> 202) and (resp.StatusCode <> 207))) then
  begin
    Memo1.Lines.Add('Send returned HTTP ' + IntToStr(resp.StatusCode));
    if (reply.HasMember('error.description') = 1) then
      begin
        Memo1.Lines.Add(reply.StringOf('error.description'));
      end;
    Exit;
  end;
if (reply.HasMember('error.code') = 1) then
  begin
    if (reply.IsNullOf('error.code') <> 1) then
      begin
        Memo1.Lines.Add('Submission error ' + reply.StringOf('error.code') + '  ' + reply.StringOf('error.description'));
        Exit;
      end;
  end;

//  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 := TChilkatJsonObject.Create(Self);
i := 0;
while (i < 2) do
  begin
    body.I := i;
    appointment := body.StringOf('messages[i].clientMessageId');
    phone := body.StringOf('messages[i].to');
    result := TChilkatJsonObject.Create(Self);
    found := reply.FindRecord2('messages','to',phone,1,result.ControlInterface);
    results.I := i;
    results.UpdateString('appointments[i].clientMessageId',appointment);
    if ((found <> 1) or (result.JsonTypeOf('accepted') <> 5)) then
      begin
        results.UpdateString('appointments[i].outcome','unknown');
        Memo1.Lines.Add(appointment + ' has no confirmed result.');
      end
    else
      begin
        if (result.BoolOf('accepted') = 1) then
          begin
            results.UpdateString('appointments[i].outcome','accepted');
            if (result.JsonTypeOf('apiMessageId') = 1) then
              begin
                results.UpdateString('appointments[i].apiMessageId',result.StringOf('apiMessageId'));
              end;
            Memo1.Lines.Add(appointment + ' accepted.');
          end
        else
          begin
            results.UpdateString('appointments[i].outcome','rejected');
            results.UpdateString('appointments[i].reason',result.StringOf('error.description'));
            Memo1.Lines.Add(appointment + ' rejected: ' + result.StringOf('error.description'));
          end;
      end;
    i := i + 1;
  end;

//  This demo writes a snapshot. In an application, update the two appointment records.
saved := results.WriteFile('appointment-send-results.json');
if (saved <> 1) then
  begin
    Memo1.Lines.Add('Could not save the results. Reconcile the submitted messages before retrying.');
    Exit;
  end;
Memo1.Lines.Add('Saved appointment-send-results.json');