(DataFlex) Clickatell Send SMS Text Message

See more Clickatell Examples

Demonstrate how to send a Clickatell SMS text message.

For more information, see https://docs.clickatell.com/channels/sms-channels/sms-api-reference/

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vJson
    Handle hoJson
    Variant vResp
    Handle hoResp
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sErrorCode
    String sError
    String sErrorDescription
    Integer i
    Integer iCount_i
    String sApiMessageId
    Boolean iAccepted
    String sV_to
    String sTemp1
    Boolean bTemp1

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // Implements the following CURL command:

    // curl -i \
    // -X POST \
    // -H "Content-Type: application/json" \
    // -H "Accept: application/json" \
    // -H "Authorization: API_KEY" \
    // -d '{"content": "Test Message Text", "to": ["PHONE_NUMBER"], "from": "FROM_PHONE_NUMBER" }' \
    // -s https://platform.clickatell.com/messages

    // Use this online tool to generate code from sample JSON:
    // Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "content": "Test Message Text",
    //   "to": [
    //     "PHONE_NUMBER"
    //   ]
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "content" "Test Message Text" To iSuccess
    Get ComUpdateString Of hoJson "to[0]" "PHONE_NUMBER" To iSuccess
    Get ComUpdateString Of hoJson "from" "FROM_PHONE_NUMBER" To iSuccess

    Send ComSetRequestHeader To hoHttp "Authorization" "API_KEY"
    Send ComSetRequestHeader To hoHttp "Accept" "application/json"
    Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"

    // If the following URL does not work, then try "https://platform.clickatell.com/v1/message"
    Get pvComObject of hoJson to vJson
    Get ComPostJson3 Of hoHttp "https://platform.clickatell.com/messages" "application/json" vJson To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComStatusCode Of hoResp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComHeader Of hoResp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Send Destroy of hoResp
        Procedure_Return
    End

    Send Destroy of hoResp

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "messages": [
    //     {
    //       "apiMessageId": "66c06ac68e5c4afb953ea9328babfde6",
    //       "accepted": true,
    //       "to": "16302581871",
    //       "errorCode": null,
    //       "error": null,
    //       "errorDescription": null
    //     }
    //   ],
    //   "errorCode": null,
    //   "error": null,
    //   "errorDescription": null
    // }

    // Sample code for parsing the JSON response...
    // Use the following online tool to generate parsing code from sample JSON:
    // Generate Parsing Code from JSON

    Get ComStringOf Of hoJResp "errorCode" To sErrorCode
    Get ComStringOf Of hoJResp "error" To sError
    Get ComStringOf Of hoJResp "errorDescription" To sErrorDescription
    Move 0 To i
    Get ComSizeOfArray Of hoJResp "messages" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "messages[i].apiMessageId" To sApiMessageId
        Get ComBoolOf Of hoJResp "messages[i].accepted" To iAccepted
        Get ComStringOf Of hoJResp "messages[i].to" To sV_to
        Get ComStringOf Of hoJResp "messages[i].errorCode" To sErrorCode
        Get ComStringOf Of hoJResp "messages[i].error" To sError
        Get ComStringOf Of hoJResp "messages[i].errorDescription" To sErrorDescription
        Move (i + 1) To i
    Loop



End_Procedure