PureBasic

VoiceBase -- Hello World (Get the Media Collection Listing)

See more VoiceBase Examples

This example serves to both verify that your Bearer Token is valid by retrieving JSON that contains information about your media collection. PureBasic

IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkDateTime.pb"
IncludeFile "CkDtObj.pb"

Procedure ChilkatExample()

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

    ; Insert your Bearer token here:
    accessToken.s = "VOICEBASE_TOKEN"

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

    ; Add the access (bearer) token to the request, which is a header
    ; having the following format:
    ; Authorization: Bearer <userAccessToken>
    sbAuth.i = CkStringBuilder::ckCreate()
    If sbAuth.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbAuth,"Bearer ")
    CkStringBuilder::ckAppend(sbAuth,accessToken)
    CkHttp::ckSetRequestHeader(http,"Authorization",CkStringBuilder::ckGetAsString(sbAuth))

    strJson.s = CkHttp::ckQuickGetStr(http,"https://apis.voicebase.com/v2-beta/media")
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbAuth)
        ProcedureReturn
    EndIf

    ; The response should be JSON, even if an error.
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(json,strJson)
    CkJsonObject::setCkEmitCompact(json, 0)

    Debug "Response status code = " + Str(CkHttp::ckLastStatus(http))

    If CkHttp::ckLastStatus(http) <> 200
        Debug CkJsonObject::ckEmit(json)
        Debug "Failed"
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbAuth)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    ; See the sample JSON response below..

    ; Iterate over the JSON like this:
    dt.i = CkDateTime::ckCreate()
    If dt.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

    mediaCount.i = CkJsonObject::ckSizeOfArray(json,"media")
    i.i = 0
    While i < mediaCount
        CkJsonObject::setCkI(json, i)

        Debug "-- " + Str(i) + " --"
        Debug "  mediaId: " + CkJsonObject::ckStringOf(json,"media[i].mediaId")
        Debug "  status: " + CkJsonObject::ckStringOf(json,"media[i].status")
        Debug "  contentType: " + CkJsonObject::ckStringOf(json,"media[i].metadata.contentType")
        Debug "  milliseconds: " + CkJsonObject::ckStringOf(json,"media[i].metadata.length.milliseconds")
        Debug "  descriptive: " + CkJsonObject::ckStringOf(json,"media[i].metadata.length.descriptive")
        dateCreated.s = CkJsonObject::ckStringOf(json,"media[i].dateCreated")
        CkDateTime::ckSetFromTimestamp(dt,dateCreated)

        localTime.i = 1
        CkDateTime::ckToDtObj(dt,localTime,dtObj)

        Debug "  " + Str(CkDtObj::ckMonth(dtObj)) + "/" + Str(CkDtObj::ckDay(dtObj)) + "  " + Str(CkDtObj::ckHour(dtObj)) + ":" + Str(CkDtObj::ckMinute(dtObj))

        i = i + 1
    Wend
    Debug "Finished."

    ; A sample JSON response:

    ; { 
    ;   "_links": { 
    ;     "self": { 
    ;       "href": "/v2-beta/media"
    ;     }
    ;   },
    ;   "media": [
    ;     { 
    ;       "mediaId": "26063536-FFFF-4020-93ba-0878112d834b",
    ;       "status": "finished",
    ;       "metadata": { 
    ;         "contentType": "audio/x-wav",
    ;         "length": { 
    ;           "milliseconds": 85141,
    ;           "descriptive": "85.0 sec"
    ;         }
    ;       },
    ;       "dateCreated": "2017-01-19T16:49:32.000Z"
    ;     },
    ;     { 
    ;       "mediaId": "8163fbbc-FFFF-4794-aa95-045420bb321d",
    ;       "status": "finished",
    ;       "metadata": { 
    ;         "contentType": "audio/x-wav",
    ;         "length": { 
    ;           "milliseconds": 65342,
    ;           "descriptive": "65.0 sec"
    ;         }
    ;       },
    ;       "dateCreated": "2017-01-19T20:08:49.000Z"
    ;     },
    ; ...
    ; ...
    ;     { 
    ;       "mediaId": "b01e27be-FFFF-4b62-8802-6dc66a75c4d3",
    ;       "status": "finished",
    ;       "metadata": { 
    ;         "contentType": "audio/x-wav",
    ;         "length": { 
    ;           "milliseconds": 11581,
    ;           "descriptive": "11.0 sec"
    ;         }
    ;       },
    ;       "dateCreated": "2017-02-06T20:55:43.000Z"
    ;     }
    ;   ]
    ; }


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbAuth)
    CkJsonObject::ckDispose(json)
    CkDateTime::ckDispose(dt)
    CkDtObj::ckDispose(dtObj)


    ProcedureReturn
EndProcedure