(PureBasic) Send SMS Text Message to Phone Number

Uses Amazon SNS to send an SMS text message to a phone number.

See SNS Publish for more information.

For more information, see https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkXml.pb"
IncludeFile "CkAuthAws.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

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

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

    ; Connect to the Amazon AWS REST server.
    ; such as https://sns.us-west-2.amazonaws.com/
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    success.i = CkRest::ckConnect(rest,"sns.us-west-2.amazonaws.com",port,bTls,bAutoReconnect)

    ; Provide AWS credentials for the REST call.
    authAws.i = CkAuthAws::ckCreate()
    If authAws.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
    CkAuthAws::setCkSecretKey(authAws, "AWS_SECRET_KEY")
    ; the region should match our URL above..
    CkAuthAws::setCkRegion(authAws, "us-west-2")
    CkAuthAws::setCkServiceName(authAws, "sns")

    CkRest::ckSetAuthAws(rest,authAws)

    CkRest::ckAddQueryParam(rest,"Action","Publish")
    ; ----------------------------------------------------
    ; Please use your own phone number here for testing...
    ; ----------------------------------------------------
    CkRest::ckAddQueryParam(rest,"PhoneNumber","+15551239999")
    CkRest::ckAddQueryParam(rest,"Message","This is a test message from Amazon SNS")

    responseXml.s = CkRest::ckFullRequestNoBody(rest,"GET","/")
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        ProcedureReturn
    EndIf

    ; A successful response will have a status code equal to 200.
    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "response body: " + responseXml
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        ProcedureReturn
    EndIf

    ; Examine the successful XML response.
    xml.i = CkXml::ckCreate()
    If xml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::ckLoadXml(xml,responseXml)
    Debug CkXml::ckGetXml(xml)

    ; To get the MessageId
    Debug "MessageId: " + CkXml::ckChilkatPath(xml,"PublishResult|MessageId|*")

    ; A sample successful response:
    ; <?xml version="1.0" encoding="utf-8"?>
    ; <PublishResponse xmlns="http://sns.amazonaws.com/doc/2010-03-31/">
    ;     <PublishResult>
    ;         <MessageId>5ffca506-6ff6-502c-bca3-f098971bcb9c</MessageId>
    ;     </PublishResult>
    ;     <ResponseMetadata>
    ;         <RequestId>6c815022-050e-5930-a7b4-05bcfde35280</RequestId>
    ;     </ResponseMetadata>
    ; </PublishResponse>


    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkXml::ckDispose(xml)


    ProcedureReturn
EndProcedure