Chilkat Online Tools

RestorePhoneNumber PureBasic Example

Amazon Chime

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"

Procedure ChilkatExample()

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

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    authAws.i = CkAuthAws::ckCreate()
    If authAws.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
    CkAuthAws::setCkSecretKey(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::setCkRegion(authAws, "us-west-2")
    CkAuthAws::setCkServiceName(authAws, "chime")
    ; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    CkRest::ckSetAuthAws(rest,authAws)

    ; URL: https://chime.us-west-2.amazonaws.com/
    ; Use the same region as specified above.
    success = CkRest::ckConnect(rest,"chime.us-west-2.amazonaws.com",443,1,1)
    If success <> 1
        Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        ProcedureReturn
    EndIf

    ; 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.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; The JSON request body created by the above code:

    ; {}

    CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
    CkRest::ckAddHeader(rest,"X-Amz-Target","RestorePhoneNumber")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)
    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestSb(rest,"POST","/phone-numbers/{phoneNumberId}?operation=restore",sbRequestBody,sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    respStatusCode.i = CkRest::ckResponseStatusCode(rest)
    Debug "response status code = " + Str(respStatusCode)
    If respStatusCode <> 200
        Debug "Response Header:"
        Debug CkRest::ckResponseHeader(rest)
        Debug "Response Body:"
        Debug CkStringBuilder::ckGetAsString(sbResponseBody)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(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

    AssociatedTimestamp.i
    Name.s
    Value.s

    CallingName.s = CkJsonObject::ckStringOf(jResp,"PhoneNumber.CallingName")
    CallingNameStatus.s = CkJsonObject::ckStringOf(jResp,"PhoneNumber.CallingNameStatus")
    InboundCall.i = CkJsonObject::ckIntOf(jResp,"PhoneNumber.Capabilities.InboundCall")
    InboundMMS.i = CkJsonObject::ckIntOf(jResp,"PhoneNumber.Capabilities.InboundMMS")
    InboundSMS.i = CkJsonObject::ckIntOf(jResp,"PhoneNumber.Capabilities.InboundSMS")
    OutboundCall.i = CkJsonObject::ckIntOf(jResp,"PhoneNumber.Capabilities.OutboundCall")
    OutboundMMS.i = CkJsonObject::ckIntOf(jResp,"PhoneNumber.Capabilities.OutboundMMS")
    OutboundSMS.i = CkJsonObject::ckIntOf(jResp,"PhoneNumber.Capabilities.OutboundSMS")
    Country.s = CkJsonObject::ckStringOf(jResp,"PhoneNumber.Country")
    CreatedTimestamp.i = CkJsonObject::ckIntOf(jResp,"PhoneNumber.CreatedTimestamp")
    DeletionTimestamp.i = CkJsonObject::ckIntOf(jResp,"PhoneNumber.DeletionTimestamp")
    E164PhoneNumber.s = CkJsonObject::ckStringOf(jResp,"PhoneNumber.E164PhoneNumber")
    PhoneNumberId.s = CkJsonObject::ckStringOf(jResp,"PhoneNumber.PhoneNumberId")
    ProductType.s = CkJsonObject::ckStringOf(jResp,"PhoneNumber.ProductType")
    Status.s = CkJsonObject::ckStringOf(jResp,"PhoneNumber.Status")
    v_Type.s = CkJsonObject::ckStringOf(jResp,"PhoneNumber.Type")
    UpdatedTimestamp.i = CkJsonObject::ckIntOf(jResp,"PhoneNumber.UpdatedTimestamp")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"PhoneNumber.Associations")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        AssociatedTimestamp = CkJsonObject::ckIntOf(jResp,"PhoneNumber.Associations[i].AssociatedTimestamp")
        Name = CkJsonObject::ckStringOf(jResp,"PhoneNumber.Associations[i].Name")
        Value = CkJsonObject::ckStringOf(jResp,"PhoneNumber.Associations[i].Value")
        i = i + 1
    Wend

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


    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure