Chilkat Online Tools

UpdateSipRule phpExt Example

Amazon Chime

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

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

$rest = new CkRest();

$authAws = new CkAuthAws();
$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('chime');
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
$rest->SetAuthAws($authAws);

// URL: https://chime.us-west-2.amazonaws.com/
// Use the same region as specified above.
$success = $rest->Connect('chime.us-west-2.amazonaws.com',443,true,true);
if ($success != true) {
    print 'ConnectFailReason: ' . $rest->get_ConnectFailReason() . "\n";
    print $rest->lastErrorText() . "\n";
    exit;
}

// The following code creates the JSON request body.
// The JSON created by this code is shown below.

// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON

$json = new CkJsonObject();
$json->UpdateInt('Disabled',123);
$json->UpdateString('Name','string');
$json->UpdateString('TargetApplications[0].AwsRegion','string');
$json->UpdateInt('TargetApplications[0].Priority',123);
$json->UpdateString('TargetApplications[0].SipMediaApplicationId','string');

// The JSON request body created by the above code:

// {
//   "Disabled": boolean,
//   "Name": "string",
//   "TargetApplications": [
//     {
//       "AwsRegion": "string",
//       "Priority": number,
//       "SipMediaApplicationId": "string"
//     }
//   ]
// }

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

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);
$sbResponseBody = new CkStringBuilder();
$success = $rest->FullRequestSb('PUT','/sip-rules/{sipRuleId}',$sbRequestBody,$sbResponseBody);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

$respStatusCode = $rest->get_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 CkJsonObject();
$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

$CreatedTimestamp = $jResp->IntOf('SipRule.CreatedTimestamp');
$Disabled = $jResp->IntOf('SipRule.Disabled');
$Name = $jResp->stringOf('SipRule.Name');
$SipRuleId = $jResp->stringOf('SipRule.SipRuleId');
$TriggerType = $jResp->stringOf('SipRule.TriggerType');
$TriggerValue = $jResp->stringOf('SipRule.TriggerValue');
$UpdatedTimestamp = $jResp->IntOf('SipRule.UpdatedTimestamp');
$i = 0;
$count_i = $jResp->SizeOfArray('SipRule.TargetApplications');
while ($i < $count_i) {
    $jResp->put_I($i);
    $AwsRegion = $jResp->stringOf('SipRule.TargetApplications[i].AwsRegion');
    $Priority = $jResp->IntOf('SipRule.TargetApplications[i].Priority');
    $SipMediaApplicationId = $jResp->stringOf('SipRule.TargetApplications[i].SipMediaApplicationId');
    $i = $i + 1;
}

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

// {
//   "SipRule": {
//     "CreatedTimestamp": number,
//     "Disabled": boolean,
//     "Name": "string",
//     "SipRuleId": "string",
//     "TargetApplications": [
//       {
//         "AwsRegion": "string",
//         "Priority": number,
//         "SipMediaApplicationId": "string"
//       }
//     ],
//     "TriggerType": "string",
//     "TriggerValue": "string",
//     "UpdatedTimestamp": number
//   }
// }

?>