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

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

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# 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 = "VOICEBASE_TOKEN"

http = Chilkat::CkHttp.new()

# Add the access (bearer) token to the request, which is a header
# having the following format:
# Authorization: Bearer <userAccessToken>
sbAuth = Chilkat::CkStringBuilder.new()
sbAuth.Append("Bearer ")
sbAuth.Append(accessToken)
http.SetRequestHeader("Authorization",sbAuth.getAsString())

strJson = http.quickGetStr("https://apis.voicebase.com/v2-beta/media")
if (http.get_LastMethodSuccess() != true)
    print http.lastErrorText() + "\n";
    exit
end

# The response should be JSON, even if an error.
json = Chilkat::CkJsonObject.new()
json.Load(strJson)
json.put_EmitCompact(false)

print "Response status code = " + http.get_LastStatus().to_s() + "\n";

if (http.get_LastStatus() != 200)
    print json.emit() + "\n";
    print "Failed" + "\n";
    exit
end

# See the sample JSON response below..

# Iterate over the JSON like this:
dt = Chilkat::CkDateTime.new()
mediaCount = json.SizeOfArray("media")
i = 0
while i < mediaCount
    json.put_I(i)

    print "-- " + i.to_s() + " --" + "\n";
    print "  mediaId: " + json.stringOf("media[i].mediaId") + "\n";
    print "  status: " + json.stringOf("media[i].status") + "\n";
    print "  contentType: " + json.stringOf("media[i].metadata.contentType") + "\n";
    print "  milliseconds: " + json.stringOf("media[i].metadata.length.milliseconds") + "\n";
    print "  descriptive: " + json.stringOf("media[i].metadata.length.descriptive") + "\n";
    dateCreated = json.stringOf("media[i].dateCreated")
    dt.SetFromTimestamp(dateCreated)

    localTime = true
    # dtObj is a CkDtObj
    dtObj = dt.GetDtObj(localTime)
    print "  " + dtObj.get_Month().to_s() + "/" + dtObj.get_Day().to_s() + "  " + dtObj.get_Hour().to_s() + ":" + 
        dtObj.get_Minute().to_s() + "\n";

    i = i + 1
end
print "Finished." + "\n";

# 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"
#     }
#   ]
# }