(PureBasic) MessageMedia - Send Messages

See more MessageMedia Examples

Submit one or more (up to 100 per request) SMS, MMS, or text to voice messages for delivery.

For more information, see https://support.messagemedia.com/hc/en-us/articles/4413635760527-Messaging-API

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 --request POST \
    ;      --header "Content-Type: application/json" \
    ;      --header "Accept: application/json" \
    ;      --data-binary "{
    ;     \"messages\": [
    ;         {
    ;             \"callback_url\": \"https://my.callback.url.com\",
    ;             \"content\": \"My first message\",
    ;             \"destination_number\": \"+61491570156\",
    ;             \"delivery_report\": true,
    ;             \"format\": \"SMS\",
    ;             \"message_expiry_timestamp\": \"2016-11-03T11:49:02.807Z\",
    ;             \"metadata\": {
    ;                 \"myKey\": \"myValue\",
    ;                 \"anotherKey\": \"anotherValue\"
    ;             },
    ;             \"scheduled\": \"2016-11-03T11:49:02.807Z\",
    ;             \"source_number\": \"+61491570157\",
    ;             \"source_number_type\": \"INTERNATIONAL\"
    ;         },
    ;         {
    ;             \"callback_url\": \"https://my.callback.url.com\",
    ;             \"content\": \"My second message\",
    ;             \"destination_number\": \"+61491570158\",
    ;             \"delivery_report\": true,
    ;             \"format\": \"MMS\",
    ;             \"subject\": \"This is an MMS message\",
    ;             \"media\": [ \"https://images.pexels.com/photos/1018350/pexels-photo-1018350.jpeg?cs=srgb&dl=architecture-buildings-city-1018350.jpg\" ],
    ;             \"message_expiry_timestamp\": \"2016-11-03T11:49:02.807Z\",
    ;             \"metadata\": {
    ;                 \"myKey\": \"myValue\",
    ;                 \"anotherKey\": \"anotherValue\"
    ;             },
    ;             \"scheduled\": \"2016-11-03T11:49:02.807Z\",
    ;             \"source_number\": \"+61491570159\",
    ;             \"source_number_type\": \"INTERNATIONAL\"
    ;         }
    ;     ]
    ; }" \
    ; https://private-anon-ecbaffbc28-messages32.apiary-mock.com/v1/messages

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

    ; {
    ;   "messages": [
    ;     {
    ;       "callback_url": "https://my.callback.url.com",
    ;       "content": "My first message",
    ;       "destination_number": "+61491570156",
    ;       "delivery_report": true,
    ;       "format": "SMS",
    ;       "message_expiry_timestamp": "2016-11-03T11:49:02.807Z",
    ;       "metadata": {
    ;         "myKey": "myValue",
    ;         "anotherKey": "anotherValue"
    ;       },
    ;       "scheduled": "2016-11-03T11:49:02.807Z",
    ;       "source_number": "+61491570157",
    ;       "source_number_type": "INTERNATIONAL"
    ;     },
    ;     {
    ;       "callback_url": "https://my.callback.url.com",
    ;       "content": "My second message",
    ;       "destination_number": "+61491570158",
    ;       "delivery_report": true,
    ;       "format": "MMS",
    ;       "subject": "This is an MMS message",
    ;       "media": [
    ;         "https://images.pexels.com/photos/1018350/pexels-photo-1018350.jpeg?cs=srgb&dl=architecture-buildings-city-1018350.jpg"
    ;       ],
    ;       "message_expiry_timestamp": "2016-11-03T11:49:02.807Z",
    ;       "metadata": {
    ;         "myKey": "myValue",
    ;         "anotherKey": "anotherValue"
    ;       },
    ;       "scheduled": "2016-11-03T11:49:02.807Z",
    ;       "source_number": "+61491570159",
    ;       "source_number_type": "INTERNATIONAL"
    ;     }
    ;   ]
    ; }

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

    CkJsonObject::ckUpdateString(json,"messages[0].callback_url","https://my.callback.url.com")
    CkJsonObject::ckUpdateString(json,"messages[0].content","My first message")
    CkJsonObject::ckUpdateString(json,"messages[0].destination_number","+61491570156")
    CkJsonObject::ckUpdateBool(json,"messages[0].delivery_report",1)
    CkJsonObject::ckUpdateString(json,"messages[0].format","SMS")
    CkJsonObject::ckUpdateString(json,"messages[0].message_expiry_timestamp","2016-11-03T11:49:02.807Z")
    CkJsonObject::ckUpdateString(json,"messages[0].metadata.myKey","myValue")
    CkJsonObject::ckUpdateString(json,"messages[0].metadata.anotherKey","anotherValue")
    CkJsonObject::ckUpdateString(json,"messages[0].scheduled","2016-11-03T11:49:02.807Z")
    CkJsonObject::ckUpdateString(json,"messages[0].source_number","+61491570157")
    CkJsonObject::ckUpdateString(json,"messages[0].source_number_type","INTERNATIONAL")
    CkJsonObject::ckUpdateString(json,"messages[1].callback_url","https://my.callback.url.com")
    CkJsonObject::ckUpdateString(json,"messages[1].content","My second message")
    CkJsonObject::ckUpdateString(json,"messages[1].destination_number","+61491570158")
    CkJsonObject::ckUpdateBool(json,"messages[1].delivery_report",1)
    CkJsonObject::ckUpdateString(json,"messages[1].format","MMS")
    CkJsonObject::ckUpdateString(json,"messages[1].subject","This is an MMS message")
    CkJsonObject::ckUpdateString(json,"messages[1].media[0]","https://images.pexels.com/photos/1018350/pexels-photo-1018350.jpeg?cs=srgb&dl=architecture-buildings-city-1018350.jpg")
    CkJsonObject::ckUpdateString(json,"messages[1].message_expiry_timestamp","2016-11-03T11:49:02.807Z")
    CkJsonObject::ckUpdateString(json,"messages[1].metadata.myKey","myValue")
    CkJsonObject::ckUpdateString(json,"messages[1].metadata.anotherKey","anotherValue")
    CkJsonObject::ckUpdateString(json,"messages[1].scheduled","2016-11-03T11:49:02.807Z")
    CkJsonObject::ckUpdateString(json,"messages[1].source_number","+61491570159")
    CkJsonObject::ckUpdateString(json,"messages[1].source_number_type","INTERNATIONAL")

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    resp.i = CkHttp::ckPostJson3(http,"https://private-anon-ecbaffbc28-messages32.apiary-mock.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": [
    ;     {
    ;       "message_id": "04fe9a97-a579-43c5-bb1a-58ed29bf0a6a",
    ;       "callback_url": "https://my.url.com",
    ;       "status": "delivered",
    ;       "content": "My first message",
    ;       "destination_number": "+61491570156",
    ;       "delivery_report": true,
    ;       "format": "SMS",
    ;       "message_expiry_timestamp": "2016-11-03T11:49:02.807Z",
    ;       "metadata": {
    ;         "myKey": "myValue",
    ;         "anotherKey": "anotherValue"
    ;       },
    ;       "scheduled": "2016-11-03T11:49:02.807Z",
    ;       "source_number": "+61491570157",
    ;       "source_number_type": "INTERNATIONAL"
    ;     }
    ;   ]
    ; }

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

    message_id.s
    callback_url.s
    status.s
    content.s
    destination_number.s
    delivery_report.i
    format.s
    message_expiry_timestamp.s
    MyKey.s
    AnotherKey.s
    scheduled.s
    source_number.s
    source_number_type.s

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"messages")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        message_id = CkJsonObject::ckStringOf(jResp,"messages[i].message_id")
        callback_url = CkJsonObject::ckStringOf(jResp,"messages[i].callback_url")
        status = CkJsonObject::ckStringOf(jResp,"messages[i].status")
        content = CkJsonObject::ckStringOf(jResp,"messages[i].content")
        destination_number = CkJsonObject::ckStringOf(jResp,"messages[i].destination_number")
        delivery_report = CkJsonObject::ckBoolOf(jResp,"messages[i].delivery_report")
        format = CkJsonObject::ckStringOf(jResp,"messages[i].format")
        message_expiry_timestamp = CkJsonObject::ckStringOf(jResp,"messages[i].message_expiry_timestamp")
        MyKey = CkJsonObject::ckStringOf(jResp,"messages[i].metadata.myKey")
        AnotherKey = CkJsonObject::ckStringOf(jResp,"messages[i].metadata.anotherKey")
        scheduled = CkJsonObject::ckStringOf(jResp,"messages[i].scheduled")
        source_number = CkJsonObject::ckStringOf(jResp,"messages[i].source_number")
        source_number_type = CkJsonObject::ckStringOf(jResp,"messages[i].source_number_type")
        i = i + 1
    Wend


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


    ProcedureReturn
EndProcedure