Chilkat Online Tools

CreateSipRule 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

    CkJsonObject::ckUpdateInt(json,"Disabled",123)
    CkJsonObject::ckUpdateString(json,"Name","string")
    CkJsonObject::ckUpdateString(json,"TargetApplications[0].AwsRegion","string")
    CkJsonObject::ckUpdateInt(json,"TargetApplications[0].Priority",123)
    CkJsonObject::ckUpdateString(json,"TargetApplications[0].SipMediaApplicationId","string")
    CkJsonObject::ckUpdateString(json,"TriggerType","string")
    CkJsonObject::ckUpdateString(json,"TriggerValue","string")

    ; The JSON request body created by the above code:

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

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

    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","/sip-rules",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

    AwsRegion.s
    Priority.i
    SipMediaApplicationId.s

    CreatedTimestamp.i = CkJsonObject::ckIntOf(jResp,"SipRule.CreatedTimestamp")
    Disabled.i = CkJsonObject::ckIntOf(jResp,"SipRule.Disabled")
    Name.s = CkJsonObject::ckStringOf(jResp,"SipRule.Name")
    SipRuleId.s = CkJsonObject::ckStringOf(jResp,"SipRule.SipRuleId")
    TriggerType.s = CkJsonObject::ckStringOf(jResp,"SipRule.TriggerType")
    TriggerValue.s = CkJsonObject::ckStringOf(jResp,"SipRule.TriggerValue")
    UpdatedTimestamp.i = CkJsonObject::ckIntOf(jResp,"SipRule.UpdatedTimestamp")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"SipRule.TargetApplications")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        AwsRegion = CkJsonObject::ckStringOf(jResp,"SipRule.TargetApplications[i].AwsRegion")
        Priority = CkJsonObject::ckIntOf(jResp,"SipRule.TargetApplications[i].Priority")
        SipMediaApplicationId = CkJsonObject::ckStringOf(jResp,"SipRule.TargetApplications[i].SipMediaApplicationId")
        i = i + 1
    Wend

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


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


    ProcedureReturn
EndProcedure