(SQL Server) Clickatell Send SMS Text Message

See more Clickatell Examples

Note: This example requires Chilkat v11.0.0 or greater.

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

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

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

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    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"
    --   ]
    -- }

    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content', 'Test Message Text'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'to[0]', 'PHONE_NUMBER'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'from', 'FROM_PHONE_NUMBER'

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', 'API_KEY'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'

    -- If the following URL does not work, then try "https://platform.clickatell.com/v1/message"
    DECLARE @resp int
    EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @resp OUT

    EXEC sp_OAMethod @http, 'HttpJson', @success OUT, 'POST', 'https://platform.clickatell.com/messages', @json, 'application/json', @resp
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @resp
        RETURN
      END

    DECLARE @sbResponseBody int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
    DECLARE @jResp int
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT

    EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
    EXEC sp_OASetProperty @jResp, 'EmitCompact', 0


    PRINT 'Response Body:'
    EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @resp
        EXEC @hr = sp_OADestroy @sbResponseBody
        EXEC @hr = sp_OADestroy @jResp
        RETURN
      END

    -- 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

    DECLARE @errorCode nvarchar(4000)

    DECLARE @error nvarchar(4000)

    DECLARE @errorDescription nvarchar(4000)

    DECLARE @i int

    DECLARE @count_i int

    DECLARE @apiMessageId nvarchar(4000)

    DECLARE @accepted int

    DECLARE @v_to nvarchar(4000)

    EXEC sp_OAMethod @jResp, 'StringOf', @errorCode OUT, 'errorCode'
    EXEC sp_OAMethod @jResp, 'StringOf', @error OUT, 'error'
    EXEC sp_OAMethod @jResp, 'StringOf', @errorDescription OUT, 'errorDescription'
    SELECT @i = 0
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'messages'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'StringOf', @apiMessageId OUT, 'messages[i].apiMessageId'
        EXEC sp_OAMethod @jResp, 'BoolOf', @accepted OUT, 'messages[i].accepted'
        EXEC sp_OAMethod @jResp, 'StringOf', @v_to OUT, 'messages[i].to'
        EXEC sp_OAMethod @jResp, 'StringOf', @errorCode OUT, 'messages[i].errorCode'
        EXEC sp_OAMethod @jResp, 'StringOf', @error OUT, 'messages[i].error'
        EXEC sp_OAMethod @jResp, 'StringOf', @errorDescription OUT, 'messages[i].errorDescription'
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @resp
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO