PHP Extension

SMSAPI - Edit a Subuser Account

See more SMSAPI Examples

Modify a sub-user account. PHP Extension

<?php

include("chilkat.php");

$success = false;

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

$http = new CkHttp();

// Implements the following CURL command:

// curl -X PUT -H "Content-Type: application/json" \
// -H "Authorization: Bearer token_api_oauth" -d\
// '{"credentials":{"password":"Customer_portal_password","api_password":"API_password"}, 
// "active":"1","description":"Test description","points":{"from_account":"2","per_month":"2"}}'
// 'https://api.smsapi.com/subusers/{subuser_id}'

// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code

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

// The following JSON is sent in the request body.

// {
//   "credentials": {
//     "password": "Customer_portal_password",
//     "api_password": "API_password"
//   },
//   "active": "1",
//   "description": "Test description",
//   "points": {
//     "from_account": "2",
//     "per_month": "2"
//   }
// }

$json = new CkJsonObject();
$json->UpdateString('credentials.password','new_Password_1234');
$json->UpdateString('credentials.api_password','new_API_password_1234');
$json->UpdateString('active','1');
$json->UpdateString('description','Test description');
$json->UpdateString('points.from_account','3');
$json->UpdateString('points.per_month','3');

// Adds the "Authorization: Bearer token_api_oauth" header.
$http->put_AuthToken('token_api_oauth');
$http->SetRequestHeader('Content-Type','application/json');

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);

// In this example, the subuser_id is 5F8BB03E6436384B0AB36F1B
$resp = new CkHttpResponse();
$success = $http->HttpSb('PUT','https://api.smsapi.com/subusers/5F8BB03E6436384B0AB36F1B',$sbRequestBody,'utf-8','application/json',$resp);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";
    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "id": "5F8BB03E6436384B0AB36F1B",
//   "username": "TestUser",
//   "active": true,
//   "description": "Test description",
//   "points": {
//     "from_account": 3.0,
//     "per_month": 3.0
//   }
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

$id = $jResp->stringOf('id');
$username = $jResp->stringOf('username');
$active = $jResp->BoolOf('active');
$description = $jResp->stringOf('description');
$pointsFrom_account = $jResp->stringOf('points.from_account');
$pointsPer_month = $jResp->stringOf('points.per_month');

?>