Chilkat Online Tools

RestorePhoneNumber Ruby Example

Amazon Chime

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("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().to_s() + "\n";
    print rest.lastErrorText() + "\n";
    exit
end

# 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 = Chilkat::CkJsonObject.new()

# The JSON request body created by the above code:

# {}

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

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/phone-numbers/{phoneNumberId}?operation=restore",sbRequestBody,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

CallingName = jResp.stringOf("PhoneNumber.CallingName")
CallingNameStatus = jResp.stringOf("PhoneNumber.CallingNameStatus")
InboundCall = jResp.IntOf("PhoneNumber.Capabilities.InboundCall")
InboundMMS = jResp.IntOf("PhoneNumber.Capabilities.InboundMMS")
InboundSMS = jResp.IntOf("PhoneNumber.Capabilities.InboundSMS")
OutboundCall = jResp.IntOf("PhoneNumber.Capabilities.OutboundCall")
OutboundMMS = jResp.IntOf("PhoneNumber.Capabilities.OutboundMMS")
OutboundSMS = jResp.IntOf("PhoneNumber.Capabilities.OutboundSMS")
Country = jResp.stringOf("PhoneNumber.Country")
CreatedTimestamp = jResp.IntOf("PhoneNumber.CreatedTimestamp")
DeletionTimestamp = jResp.IntOf("PhoneNumber.DeletionTimestamp")
E164PhoneNumber = jResp.stringOf("PhoneNumber.E164PhoneNumber")
PhoneNumberId = jResp.stringOf("PhoneNumber.PhoneNumberId")
ProductType = jResp.stringOf("PhoneNumber.ProductType")
Status = jResp.stringOf("PhoneNumber.Status")
v_Type = jResp.stringOf("PhoneNumber.Type")
UpdatedTimestamp = jResp.IntOf("PhoneNumber.UpdatedTimestamp")
i = 0
count_i = jResp.SizeOfArray("PhoneNumber.Associations")
while i < count_i
    jResp.put_I(i)
    AssociatedTimestamp = jResp.IntOf("PhoneNumber.Associations[i].AssociatedTimestamp")
    Name = jResp.stringOf("PhoneNumber.Associations[i].Name")
    Value = jResp.stringOf("PhoneNumber.Associations[i].Value")
    i = i + 1
end

# 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
#   }
# }