Ruby Requires Chilkat v11.0.0+

VoiceBase -- Upload a Media File with a JSON Configuration

See more VoiceBase Examples

This example uploads a media file and also provides a configuration file. Ruby

require 'chilkat'

success = false

#  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()

req = Chilkat::CkHttpRequest.new()
req.put_HttpVerb("POST")
req.put_Path("/v2-beta/media")
req.put_ContentType("multipart/form-data")

#  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)
req.AddHeader("Authorization",sbAuth.getAsString())

success = req.AddFileForUpload2("media","qa_data/wav/msg_123_abc.wav","audio/x-wav")
if (success == false)
    print req.lastErrorText() + "\n";
    exit
end

#  This is the JSON of the configuration to be added as a parameter to the upload:
#  (Obviously, if you want a callback, you would use a URL that goes to your own web server..)

#  	{ 
#  	   "configuration":{ 
#  	      "publish":{ 
#  	         "callbacks":[
#  	            { 
#  	               "url":"https://www.chilkatsoft.com/dss/update_vm_transcription.asp",
#  	               "method":"POST",
#  	               "include":[
#  	                  "transcripts",
#  	                  "keywords",
#  	                  "topics",
#  	                  "metadata"
#  	               ]
#  	            }
#  	         ]
#  	      },
#  	      "keywords":{ 
#  	         "groups":[]
#  	      }
#  	   }
#  	}

#  This code produces the above JSON.
json = Chilkat::CkJsonObject.new()
json.UpdateString("configuration.publish.callbacks[0].url","https://www.chilkatsoft.com/dss/update_vm_transcription.asp")
json.UpdateString("configuration.publish.callbacks[0].method","POST")
json.UpdateString("configuration.publish.callbacks[0].include[0]","transcripts")
json.UpdateString("configuration.publish.callbacks[0].include[1]","keywords")
json.UpdateString("configuration.publish.callbacks[0].include[2]","topics")
json.UpdateString("configuration.publish.callbacks[0].include[3]","metadata")

jConfig = Chilkat::CkJsonObject.new()
json.ObjectOf2("configuration",jConfig)

jKeywords = Chilkat::CkJsonObject.new()
jConfig.AppendObject2("keywords",jKeywords)

jGroups = Chilkat::CkJsonArray.new()
jKeywords.AppendArray2("groups",jGroups)

#  Add the configuration JSON to the upload.
req.AddParam("configuration",json.emit())

#  Do the upload..
resp = Chilkat::CkHttpResponse.new()
success = http.HttpSReq("apis.voicebase.com",443,true,req,resp)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

#  Examine the response status code and body.
print "Response status code = " + resp.get_StatusCode().to_s() + "\n";

#  The response should be JSON, even if an error.
json.Load(resp.bodyStr())
json.put_EmitCompact(false)

print json.emit() + "\n";

#  A successful response will have a status code = 200
if (resp.get_StatusCode() != 200)
    print "Failed." + "\n";
else
    print "mediaId: " + json.stringOf("mediaId") + "\n";
    print "href: " + json.stringOf("_links.self.href") + "\n";
    print "status: " + json.stringOf("status") + "\n";
    print "Success." + "\n";
end

#  Here is an example of a successful response:

#  	{ 
#  	  "_links": { 
#  	    "self": { 
#  	      "href": "/v2-beta/media/856a1e85-c847-4c3c-b7a4-6cf15cd51db4"
#  	    }
#  	  },
#  	  "mediaId": "856a1e85-c847-4c3c-b7a4-6cf15cd51db4",
#  	  "status": "accepted",
#  	  "metadata": {}
#  	}