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

Clickatell One API: Upload and send a WhatsApp PDF

See more Clickatell Examples

Send a local invoice.pdf during the customer’s open WhatsApp service window. Upload the binary PDF for one recipient, then reference the returned fileId in a separate message to the same recipient. The upload and message submission have separate acceptance results.

Clickatell API reference

Chilkat SQL Server Downloads

SQL Server
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @sTmp1 nvarchar(4000)
    --  Assumes Chilkat is unlocked. See Global Unlock Sample.
    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    EXEC sp_OASetProperty @http, 'RequireSslCertVerify', 1
    --  Load the key for this One API integration from your application configuration.
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', 'ONE_API_KEY'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'

    DECLARE @recipient nvarchar(4000)
    SELECT @recipient = 'PHONE_NUMBER'
    DECLARE @pdf int
    EXEC @hr = sp_OACreate 'Chilkat.BinData', @pdf OUT

    DECLARE @loaded int
    EXEC sp_OAMethod @pdf, 'LoadFile', @loaded OUT, 'invoice.pdf'
    IF @loaded <> 1
      BEGIN

        PRINT 'Could not read invoice.pdf.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @pdf
        RETURN
      END
    --  Restrict this customer's invoice to that customer's number.
    DECLARE @success int
    EXEC sp_OAMethod @http, 'SetUrlVar', @success OUT, 'recipient', @recipient
    DECLARE @upload int
    EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @upload OUT

    DECLARE @uploaded int
    EXEC sp_OAMethod @http, 'HttpBd', @uploaded OUT, 'POST', 'https://platform.clickatell.com/v1/media?fileName=invoice.pdf&to={$recipient}', @pdf, 'application/pdf', @upload
    EXEC sp_OAGetProperty @upload, 'StatusCode', @iTmp0 OUT
    IF (@uploaded <> 1) or (@iTmp0 <> 201)
      BEGIN

        EXEC sp_OAGetProperty @upload, 'StatusCode', @iTmp0 OUT
        PRINT 'PDF upload failed. HTTP status ' + @iTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @pdf
        EXEC @hr = sp_OADestroy @upload
        RETURN
      END
    DECLARE @media int
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @media OUT

    DECLARE @decoded int
    EXEC sp_OAGetProperty @upload, 'BodyStr', @sTmp0 OUT
    EXEC sp_OAMethod @media, 'Load', @decoded OUT, @sTmp0
    EXEC sp_OAMethod @media, 'BoolOf', @iTmp0 OUT, 'accepted'
    IF (@decoded <> 1) or (@iTmp0 <> 1)
      BEGIN

        EXEC sp_OAMethod @media, 'StringOf', @sTmp0 OUT, 'error.description'
        PRINT 'Upload was not accepted: ' + @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @pdf
        EXEC @hr = sp_OADestroy @upload
        EXEC @hr = sp_OADestroy @media
        RETURN
      END
    DECLARE @fileId nvarchar(4000)
    EXEC sp_OAMethod @media, 'StringOf', @fileId OUT, 'fileId'
    EXEC sp_OAMethod @media, 'JsonTypeOf', @iTmp0 OUT, 'fileId'
    IF (@iTmp0 <> 1) or (@fileId = '')
      BEGIN

        PRINT 'Upload returned no file ID.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @pdf
        EXEC @hr = sp_OADestroy @upload
        EXEC @hr = sp_OADestroy @media
        RETURN
      END
    DECLARE @body int
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @body OUT

    EXEC sp_OAMethod @body, 'UpdateString', @success OUT, 'messages[0].channel', 'whatsapp'
    EXEC sp_OAMethod @body, 'UpdateString', @success OUT, 'messages[0].to', @recipient
    EXEC sp_OAMethod @body, 'UpdateString', @success OUT, 'messages[0].media.fileId', @fileId
    EXEC sp_OAMethod @body, 'UpdateString', @success OUT, 'messages[0].media.contentType', 'application/pdf'
    EXEC sp_OAMethod @body, 'UpdateString', @success OUT, 'messages[0].media.fileName', 'invoice.pdf'

    DECLARE @resp int
    EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @resp OUT

    DECLARE @sent int
    EXEC sp_OAMethod @http, 'HttpJson', @sent OUT, 'POST', 'https://platform.clickatell.com/v1/message', @body, 'application/json', @resp
    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN

        PRINT 'No HTTP response. Check the message report before resending.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @pdf
        EXEC @hr = sp_OADestroy @upload
        EXEC @hr = sp_OADestroy @media
        EXEC @hr = sp_OADestroy @body
        EXEC @hr = sp_OADestroy @resp
        RETURN
      END
    DECLARE @reply int
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @reply OUT

    DECLARE @parsed int
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    EXEC sp_OAMethod @reply, 'Load', @parsed OUT, @sTmp0
    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    IF (@sent <> 1) or (@iTmp0 <> 202)
      BEGIN

        EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
        PRINT 'Send returned HTTP ' + @iTmp0
        EXEC sp_OAMethod @reply, 'HasMember', @iTmp0 OUT, 'error.description'
        IF @iTmp0 = 1
          BEGIN
            EXEC sp_OAMethod @reply, 'StringOf', @sTmp0 OUT, 'error.description'
            PRINT @sTmp0
          END
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @pdf
        EXEC @hr = sp_OADestroy @upload
        EXEC @hr = sp_OADestroy @media
        EXEC @hr = sp_OADestroy @body
        EXEC @hr = sp_OADestroy @resp
        EXEC @hr = sp_OADestroy @reply
        RETURN
      END
    EXEC sp_OAMethod @reply, 'HasMember', @iTmp0 OUT, 'error.code'
    IF @iTmp0 = 1
      BEGIN
        EXEC sp_OAMethod @reply, 'IsNullOf', @iTmp0 OUT, 'error.code'
        IF @iTmp0 <> 1
          BEGIN

            EXEC sp_OAMethod @reply, 'StringOf', @sTmp0 OUT, 'error.code'

            EXEC sp_OAMethod @reply, 'StringOf', @sTmp1 OUT, 'error.description'
            PRINT 'Submission error ' + @sTmp0 + '  ' + @sTmp1
            EXEC @hr = sp_OADestroy @http
            EXEC @hr = sp_OADestroy @pdf
            EXEC @hr = sp_OADestroy @upload
            EXEC @hr = sp_OADestroy @media
            EXEC @hr = sp_OADestroy @body
            EXEC @hr = sp_OADestroy @resp
            EXEC @hr = sp_OADestroy @reply
            RETURN
          END
      END
    --  HTTP acceptance and the recipient result are separate checks.
    EXEC sp_OAMethod @reply, 'JsonTypeOf', @iTmp0 OUT, 'messages[0].accepted'
    IF (@parsed <> 1) or (@iTmp0 <> 5)
      BEGIN

        PRINT 'Missing recipient result. Check the message report.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @pdf
        EXEC @hr = sp_OADestroy @upload
        EXEC @hr = sp_OADestroy @media
        EXEC @hr = sp_OADestroy @body
        EXEC @hr = sp_OADestroy @resp
        EXEC @hr = sp_OADestroy @reply
        RETURN
      END
    EXEC sp_OAMethod @reply, 'BoolOf', @iTmp0 OUT, 'messages[0].accepted'
    IF @iTmp0 <> 1
      BEGIN

        EXEC sp_OAMethod @reply, 'StringOf', @sTmp0 OUT, 'messages[0].error.code'

        EXEC sp_OAMethod @reply, 'StringOf', @sTmp1 OUT, 'messages[0].error.description'
        PRINT 'Message rejected: ' + @sTmp0 + '  ' + @sTmp1
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @pdf
        EXEC @hr = sp_OADestroy @upload
        EXEC @hr = sp_OADestroy @media
        EXEC @hr = sp_OADestroy @body
        EXEC @hr = sp_OADestroy @resp
        EXEC @hr = sp_OADestroy @reply
        RETURN
      END
    EXEC sp_OAMethod @reply, 'JsonTypeOf', @iTmp0 OUT, 'messages[0].apiMessageId'
    IF @iTmp0 <> 1
      BEGIN

        PRINT 'Accepted without a message ID. Check the message report.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @pdf
        EXEC @hr = sp_OADestroy @upload
        EXEC @hr = sp_OADestroy @media
        EXEC @hr = sp_OADestroy @body
        EXEC @hr = sp_OADestroy @resp
        EXEC @hr = sp_OADestroy @reply
        RETURN
      END

    EXEC sp_OAMethod @reply, 'StringOf', @sTmp0 OUT, 'messages[0].apiMessageId'
    PRINT 'Accepted. Message ID: ' + @sTmp0

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @pdf
    EXEC @hr = sp_OADestroy @upload
    EXEC @hr = sp_OADestroy @media
    EXEC @hr = sp_OADestroy @body
    EXEC @hr = sp_OADestroy @resp
    EXEC @hr = sp_OADestroy @reply


END
GO