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

Clickatell HTTP API: Send an SMS with query parameters

See more Clickatell Examples

Use an SMS integration configured for HTTP in the Clickatell Portal. The endpoint takes apiKey, to, and content as query parameters. Pass raw values to Chilkat so it can encode spaces, ampersands, and other reserved characters. Supply a country code and phone number as digits. Set from when your two-way integration requires a sender.

The URL contains the API key, recipient, and message text. Keep full request URLs out of logs and browser history. Check the per-message result after HTTP 202. If the connection is interrupted, check the Portal message report before resending. For the header-authenticated JSON workflow, see Send an SMS with One API.

Clickatell API reference

Chilkat PureBasic Downloads

PureBasic
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttpRequest.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  Assumes Chilkat is unlocked. See Global Unlock Sample.
    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttp::setCkRequireSslCertVerify(http, 1)

    ;  Use the key issued for this HTTP integration. Chilkat encodes each query value.
    query.i = CkHttpRequest::ckCreate()
    If query.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpRequest::setCkHttpVerb(query, "GET")
    CkHttpRequest::ckAddHeader(query,"Accept","application/json")
    CkHttpRequest::ckAddParam(query,"apiKey","HTTP_API_KEY")
    CkHttpRequest::ckAddParam(query,"to","PHONE_NUMBER")
    CkHttpRequest::ckAddParam(query,"content","Test message: pickup between 2 & 4.")
    sender.s = ""
    If sender <> ""
        CkHttpRequest::ckAddParam(query,"from",sender)
    EndIf

    resp.i = CkHttpResponse::ckCreate()
    If resp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckHttpReq(http,"https://platform.clickatell.com/messages/http/send",query,resp)
    If CkHttpResponse::ckStatusCode(resp) = 0
        Debug "The send outcome is unknown. Check the message report before resending."
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(query)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    reply.i = CkJsonObject::ckCreate()
    If reply.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    parsed.i = CkJsonObject::ckLoad(reply,CkHttpResponse::ckBodyStr(resp))
    If (success <> 1) OR ((CkHttpResponse::ckStatusCode(resp) <> 202))
        Debug "Clickatell returned HTTP " + Str(CkHttpResponse::ckStatusCode(resp))
        If parsed = 1
            If CkJsonObject::ckHasMember(reply,"errorDescription") = 1
                Debug CkJsonObject::ckStringOf(reply,"errorDescription")
            EndIf

        EndIf

        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(query)
        CkHttpResponse::ckDispose(resp)
        CkJsonObject::ckDispose(reply)
        ProcedureReturn
    EndIf

    If parsed <> 1
        Debug "Expected a JSON response."
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(query)
        CkHttpResponse::ckDispose(resp)
        CkJsonObject::ckDispose(reply)
        ProcedureReturn
    EndIf

    ;  A request-level error applies to the submission as a whole.
    If CkJsonObject::ckHasMember(reply,"errorCode") = 1
        If CkJsonObject::ckIsNullOf(reply,"errorCode") <> 1
            Debug "Submission error " + CkJsonObject::ckStringOf(reply,"errorCode") + "  " + CkJsonObject::ckStringOf(reply,"errorDescription")
            CkHttp::ckDispose(http)
            CkHttpRequest::ckDispose(query)
            CkHttpResponse::ckDispose(resp)
            CkJsonObject::ckDispose(reply)
            ProcedureReturn
        EndIf

    EndIf

    count.i = CkJsonObject::ckSizeOfArray(reply,"messages")
    If count <= 0
        Debug "No recipient results returned. Check the message report before resending."
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(query)
        CkHttpResponse::ckDispose(resp)
        CkJsonObject::ckDispose(reply)
        ProcedureReturn
    EndIf

    i.i = 0
    While (i < count)
        CkJsonObject::setCkI(reply, i)
        resultNumber.i = i + 1
        ;  JsonTypeOf returns 5 for a JSON boolean.
        If CkJsonObject::ckJsonTypeOf(reply,"messages[i].accepted") <> 5
            Debug "Result " + Str(resultNumber) + " has no acceptance flag."
        Else
            If CkJsonObject::ckBoolOf(reply,"messages[i].accepted") = 1
                messageId.s = CkJsonObject::ckStringOf(reply,"messages[i].apiMessageId")
                If (CkJsonObject::ckJsonTypeOf(reply,"messages[i].apiMessageId") <> 1) OR (messageId = "")
                    Debug "Result " + Str(resultNumber) + " was accepted without a tracking ID."
                Else
                    Debug "Result " + Str(resultNumber) + " accepted. Message ID: " + messageId
                EndIf

            Else
                Debug "Result " + Str(resultNumber) + " rejected: " + CkJsonObject::ckStringOf(reply,"messages[i].errorCode") + "  " + CkJsonObject::ckStringOf(reply,"messages[i].errorDescription")
            EndIf

        EndIf

        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkHttpRequest::ckDispose(query)
    CkHttpResponse::ckDispose(resp)
    CkJsonObject::ckDispose(reply)


    ProcedureReturn
EndProcedure