Chilkat Online Tools

DescribeQueue Ruby Example

Amazon Connect

require 'chilkat'

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

rest = Chilkat::CkRest.new()

authAws = Chilkat::CkAuthAws.new()
authAws.put_AccessKey("AWS_ACCESS_KEY")
authAws.put_SecretKey("AWS_SECRET_KEY")

# Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
authAws.put_Region("us-west-2")
authAws.put_ServiceName("connect")
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)

# URL: https://connect.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("connect.us-west-2.amazonaws.com",443,true,true)
if (success != true)
    print "ConnectFailReason: " + rest.get_ConnectFailReason().to_s() + "\n";
    print rest.lastErrorText() + "\n";
    exit
end

rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","DescribeQueue")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("GET","/queues/{InstanceId}/{QueueId}",sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

respStatusCode = rest.get_ResponseStatusCode()
print "response status code = " + respStatusCode.to_s() + "\n";
if (respStatusCode != 200)
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print "Response Body:" + "\n";
    print sbResponseBody.getAsString() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)

# The following code parses the JSON response.
# A sample JSON response is shown below the sample code.

# Use this online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

Description = jResp.stringOf("Queue.Description")
HoursOfOperationId = jResp.stringOf("Queue.HoursOfOperationId")
MaxContacts = jResp.IntOf("Queue.MaxContacts")
Name = jResp.stringOf("Queue.Name")
OutboundCallerIdName = jResp.stringOf("Queue.OutboundCallerConfig.OutboundCallerIdName")
OutboundCallerIdNumberId = jResp.stringOf("Queue.OutboundCallerConfig.OutboundCallerIdNumberId")
OutboundFlowId = jResp.stringOf("Queue.OutboundCallerConfig.OutboundFlowId")
QueueArn = jResp.stringOf("Queue.QueueArn")
QueueId = jResp.stringOf("Queue.QueueId")
Status = jResp.stringOf("Queue.Status")
v_String = jResp.stringOf("Queue.Tags.string")

# A sample JSON response body parsed by the above code:

# {
#   "Queue": {
#     "Description": "string",
#     "HoursOfOperationId": "string",
#     "MaxContacts": number,
#     "Name": "string",
#     "OutboundCallerConfig": {
#       "OutboundCallerIdName": "string",
#       "OutboundCallerIdNumberId": "string",
#       "OutboundFlowId": "string"
#     },
#     "QueueArn": "string",
#     "QueueId": "string",
#     "Status": "string",
#     "Tags": {
#       "string": "string"
#     }
#   }
# }