Chilkat Online Tools

DescribeQueue PureBasic Example

Amazon Connect

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, "connect")
    ; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    CkRest::ckSetAuthAws(rest,authAws)

    ; URL: https://connect.us-west-2.amazonaws.com/
    ; Use the same region as specified above.
    success = CkRest::ckConnect(rest,"connect.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

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

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

    success = CkRest::ckFullRequestNoBodySb(rest,"GET","/queues/{InstanceId}/{QueueId}",sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        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)
        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

    Description.s = CkJsonObject::ckStringOf(jResp,"Queue.Description")
    HoursOfOperationId.s = CkJsonObject::ckStringOf(jResp,"Queue.HoursOfOperationId")
    MaxContacts.i = CkJsonObject::ckIntOf(jResp,"Queue.MaxContacts")
    Name.s = CkJsonObject::ckStringOf(jResp,"Queue.Name")
    OutboundCallerIdName.s = CkJsonObject::ckStringOf(jResp,"Queue.OutboundCallerConfig.OutboundCallerIdName")
    OutboundCallerIdNumberId.s = CkJsonObject::ckStringOf(jResp,"Queue.OutboundCallerConfig.OutboundCallerIdNumberId")
    OutboundFlowId.s = CkJsonObject::ckStringOf(jResp,"Queue.OutboundCallerConfig.OutboundFlowId")
    QueueArn.s = CkJsonObject::ckStringOf(jResp,"Queue.QueueArn")
    QueueId.s = CkJsonObject::ckStringOf(jResp,"Queue.QueueId")
    Status.s = CkJsonObject::ckStringOf(jResp,"Queue.Status")
    v_String.s = CkJsonObject::ckStringOf(jResp,"Queue.Tags.string")

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

    ; {
    ;   "Queue": {
    ;     "Description": "string",
    ;     "HoursOfOperationId": "string",
    ;     "MaxContacts": number,
    ;     "Name": "string",
    ;     "OutboundCallerConfig": {
    ;       "OutboundCallerIdName": "string",
    ;       "OutboundCallerIdNumberId": "string",
    ;       "OutboundFlowId": "string"
    ;     },
    ;     "QueueArn": "string",
    ;     "QueueId": "string",
    ;     "Status": "string",
    ;     "Tags": {
    ;       "string": "string"
    ;     }
    ;   }
    ; }


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


    ProcedureReturn
EndProcedure