Chilkat Online Tools

UpdatePhoneNumber TCL Example

Amazon Chime

load ./chilkat.dll

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

set rest [new_CkRest]

set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "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.)
CkAuthAws_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "chime"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws

# URL: https://chime.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "chime.us-west-2.amazonaws.com" 443 1 1]
if {$success != 1} then {
    puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    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

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "CallingName" "string"
CkJsonObject_UpdateString $json "ProductType" "string"

# The JSON request body created by the above code:

# {
#   "CallingName": "string",
#   "ProductType": "string"
# }

CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "UpdatePhoneNumber"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestSb $rest "POST" "/phone-numbers/{phoneNumberId}" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $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

set CallingName [CkJsonObject_stringOf $jResp "PhoneNumber.CallingName"]
set CallingNameStatus [CkJsonObject_stringOf $jResp "PhoneNumber.CallingNameStatus"]
set InboundCall [CkJsonObject_IntOf $jResp "PhoneNumber.Capabilities.InboundCall"]
set InboundMMS [CkJsonObject_IntOf $jResp "PhoneNumber.Capabilities.InboundMMS"]
set InboundSMS [CkJsonObject_IntOf $jResp "PhoneNumber.Capabilities.InboundSMS"]
set OutboundCall [CkJsonObject_IntOf $jResp "PhoneNumber.Capabilities.OutboundCall"]
set OutboundMMS [CkJsonObject_IntOf $jResp "PhoneNumber.Capabilities.OutboundMMS"]
set OutboundSMS [CkJsonObject_IntOf $jResp "PhoneNumber.Capabilities.OutboundSMS"]
set Country [CkJsonObject_stringOf $jResp "PhoneNumber.Country"]
set CreatedTimestamp [CkJsonObject_IntOf $jResp "PhoneNumber.CreatedTimestamp"]
set DeletionTimestamp [CkJsonObject_IntOf $jResp "PhoneNumber.DeletionTimestamp"]
set E164PhoneNumber [CkJsonObject_stringOf $jResp "PhoneNumber.E164PhoneNumber"]
set PhoneNumberId [CkJsonObject_stringOf $jResp "PhoneNumber.PhoneNumberId"]
set ProductType [CkJsonObject_stringOf $jResp "PhoneNumber.ProductType"]
set Status [CkJsonObject_stringOf $jResp "PhoneNumber.Status"]
set v_Type [CkJsonObject_stringOf $jResp "PhoneNumber.Type"]
set UpdatedTimestamp [CkJsonObject_IntOf $jResp "PhoneNumber.UpdatedTimestamp"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "PhoneNumber.Associations"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set AssociatedTimestamp [CkJsonObject_IntOf $jResp "PhoneNumber.Associations[i].AssociatedTimestamp"]
    set Name [CkJsonObject_stringOf $jResp "PhoneNumber.Associations[i].Name"]
    set Value [CkJsonObject_stringOf $jResp "PhoneNumber.Associations[i].Value"]
    set i [expr $i + 1]
}

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

# {
#   "PhoneNumber": {
#     "Associations": [
#       {
#         "AssociatedTimestamp": number,
#         "Name": "string",
#         "Value": "string"
#       }
#     ],
#     "CallingName": "string",
#     "CallingNameStatus": "string",
#     "Capabilities": {
#       "InboundCall": boolean,
#       "InboundMMS": boolean,
#       "InboundSMS": boolean,
#       "OutboundCall": boolean,
#       "OutboundMMS": boolean,
#       "OutboundSMS": boolean
#     },
#     "Country": "string",
#     "CreatedTimestamp": number,
#     "DeletionTimestamp": number,
#     "E164PhoneNumber": "string",
#     "PhoneNumberId": "string",
#     "ProductType": "string",
#     "Status": "string",
#     "Type": "string",
#     "UpdatedTimestamp": number
#   }
# }

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp