Chilkat Online Tools

DescribeQueue phpAx Example

Amazon Connect

<?php

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

$rest = new COM("Chilkat_9_5_0.Rest");

$authAws = new COM("Chilkat_9_5_0.AuthAws");
$authAws->AccessKey = 'AWS_ACCESS_KEY';
$authAws->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->Region = 'us-west-2';
$authAws->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,1,1);
if ($success != 1) {
    print 'ConnectFailReason: ' . $rest->ConnectFailReason . "\n";
    print $rest->LastErrorText . "\n";
    exit;
}

$rest->AddHeader('Content-Type','application/x-amz-json-1.1');
$rest->AddHeader('X-Amz-Target','DescribeQueue');

$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$success = $rest->FullRequestNoBodySb('GET','/queues/{InstanceId}/{QueueId}',$sbResponseBody);
if ($success != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

$respStatusCode = $rest->ResponseStatusCode;
print 'response status code = ' . $respStatusCode . "\n";
if ($respStatusCode != 200) {
    print 'Response Header:' . "\n";
    print $rest->ResponseHeader . "\n";
    print 'Response Body:' . "\n";
    print $sbResponseBody->getAsString() . "\n";
    exit;
}

$jResp = new COM("Chilkat_9_5_0.JsonObject");
$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"
//     }
//   }
// }

?>