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

Clickatell One API: Read the account balance and currency

See more Clickatell Examples

Request the messaging balance associated with a One API integration key. The response supplies both the decimal amount and its currency. Read the amount as text for display to preserve its precision. A zero balance is a valid result. For example, a billing dashboard can display 1267.92865 ZAR.

Clickatell API reference

Chilkat PureBasic Downloads

PureBasic
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.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)
    ;  Supply the key for this One API integration from application configuration.
    CkHttp::ckSetRequestHeader(http,"Authorization","ONE_API_KEY")
    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

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

    success = CkHttp::ckHttpNoBody(http,"GET","https://platform.clickatell.com/v1/balance",resp)
    If CkHttpResponse::ckStatusCode(resp) = 0
        Debug "No HTTP response. Check the connection and retry the lookup."
        CkHttp::ckDispose(http)
        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) <> 200))
        Debug "Clickatell returned HTTP " + Str(CkHttpResponse::ckStatusCode(resp))
        If parsed = 1
            If CkJsonObject::ckHasMember(reply,"error.description") = 1
                Debug CkJsonObject::ckStringOf(reply,"error.description")
            EndIf

        EndIf

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

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

    ;  JsonTypeOf returns 2 for a number and 1 for a string. Zero is a valid amount.
    If (CkJsonObject::ckJsonTypeOf(reply,"balance") <> 2) OR (CkJsonObject::ckJsonTypeOf(reply,"currency") <> 1)
        Debug "The balance response is missing the amount or currency."
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        CkJsonObject::ckDispose(reply)
        ProcedureReturn
    EndIf

    Debug "Account balance: " + CkJsonObject::ckStringOf(reply,"balance") + " " + CkJsonObject::ckStringOf(reply,"currency")


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


    ProcedureReturn
EndProcedure