(PureBasic) WhatsApp - Send a Linked Media Message

Demonstrates how to send a media message where the media content is a link to an external URL. This example demonstrates sending an image (JPG) media message.

For more information, see https://developers.facebook.com/docs/whatsapp/api/messages/media

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

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

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

    success.i

    ; Implements the following CURL command:

    ; curl -X POST https://example.com/v1/messages \
    ;   -H "Authorization: Bearer your-auth-token" \
    ;   -d '
    ; {
    ;     "recipient_type": "individual-or-group",
    ;     "to": "whatsapp-id-or-group-id",
    ;     "type": "image",
    ;     "image": {
    ;       "link": "http(s)://the-url",
    ;       "provider": {
    ;         "name" : "provider-name"
    ;       },
    ;     "caption": "your-image-caption"
    ;   }
    ; }'

    ; Use the following online tool to generate HTTP code from a CURL command
    ; Convert a cURL Command to HTTP Source Code

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

    ; The following JSON is sent in the request body.

    ; {
    ;   "recipient_type": "individual-or-group",
    ;   "to": "whatsapp-id-or-group-id",
    ;   "type": "image",
    ;   "image": {
    ;     "link": "http(s)://the-url",
    ;     "provider": {
    ;       "name": "provider-name"
    ;     },
    ;     "caption": "your-image-caption"
    ;   }
    ; }

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

    CkJsonObject::ckUpdateString(json,"recipient_type","individual-or-group")
    CkJsonObject::ckUpdateString(json,"to","whatsapp-id-or-group-id")
    CkJsonObject::ckUpdateString(json,"type","image")
    CkJsonObject::ckUpdateString(json,"image.link","http(s)://the-url")
    CkJsonObject::ckUpdateString(json,"image.provider.name","provider-name")
    CkJsonObject::ckUpdateString(json,"image.caption","your-image-caption")

    ; Adds the "Authorization: Bearer your-auth-token" header.
    CkHttp::setCkAuthToken(http, "your-auth-token")

    resp.i = CkHttp::ckPostJson3(http,"https://example.com/v1/messages","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

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

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

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

    ; {
    ;   "messages": [
    ;     {
    ;       "id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
    ;     }
    ;   ]
    ; }

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

    id.s

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"messages")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        id = CkJsonObject::ckStringOf(jResp,"messages[i].id")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure