Chilkat Online Tools

PureBasic / Plivo REST API / List all Powerpacks

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

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

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "{{auth_id}}")
    CkHttp::setCkPassword(http, "password")

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

    CkJsonObject::ckUpdateString(queryParams,"limit","<integer>")
    CkJsonObject::ckUpdateString(queryParams,"offset","<integer>")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.plivo.com/v1/Account/<auth_id>/Powerpack/",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)


    ProcedureReturn
EndProcedure

Curl Command

curl -G -d "limit=%3Cinteger%3E"
	-d "offset=%3Cinteger%3E"
	-u '{{auth_id}}:password'
https://api.plivo.com/v1/Account/<auth_id>/Powerpack/

Postman Collection Item JSON

{
  "name": "List all Powerpacks",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Powerpack/?limit=<integer>&offset=<integer>",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Powerpack",
        ""
      ],
      "query": [
        {
          "key": "limit",
          "value": "<integer>",
          "description": "Used to display the number of results per page. The maximum number of results that can be fetched is 20. Defaults to 20."
        },
        {
          "key": "offset",
          "value": "<integer>",
          "description": "Denotes the number of value items by which the results should be offset"
        }
      ]
    },
    "description": "This API can be used to fetch a list of Powerpacks, below is the list of arguments that can be passed in this API request, more information can be found [here](https://www.plivo.com/docs/sms/api/powerpack#list-all-powerpacks)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| limit   | Used to display the number of results per page. The maximum number of results that can be fetched is 20. Defaults to 20.        | Optional      |\n| offset   |Denotes the number of value items by which the results should be offset. Defaults to 0     | Optional      |"
  },
  "response": [
    {
      "name": "List all Powerpacks",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Powerpack/?limit=<integer>&offset=<integer>",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Powerpack",
            ""
          ],
          "query": [
            {
              "key": "limit",
              "value": "<integer>",
              "description": "Used to display the number of results per page. The maximum number of results that can be fetched is 20. Defaults to 20."
            },
            {
              "key": "offset",
              "value": "<integer>",
              "description": "Denotes the number of value items by which the results should be offset"
            }
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"e44c159e-0a02-11ea-b072-0242ac110007\",\n    \"meta\": {\n        \"limit\": 20,\n        \"next\": \"/api/v1/account/xxxxxxx/Powerpack?offset=20&limit=20\",\n        \"offset\": 0,\n        \"total_count\": 53\n    },\n    \"objects\": [\n        {\n            \"application_id\": \"\",\n            \"application_type\": \"\",\n            \"created_on\": \"2019-10-09T11:10:59.666461Z\",\n            \"local_connect\": true,\n            \"name\": \"test\",\n            \"number_pool\": \"/v1/Account/xxxxxxxxx/NumberPool/<number_pool_uuid>/\",\n            \"sticky_sender\": true,\n            \"uuid\": \"<powerpack_uuid>\"\n        },\n        {\n            \"application_id\": \"\",\n            \"application_type\": \"\",\n            \"created_on\": \"2019-10-09T17:03:31.837944Z\",\n            \"local_connect\": false,\n            \"name\": \"p23\",\n            \"number_pool\": \"/v1/Account/xxxxxxxx/NumberPool/<number_pool_uuid>/\",\n            \"sticky_sender\": false,\n            \"uuid\": \"<powerpack_uuid>\"\n        },\n        {\n            \"application_id\": \"\",\n            \"application_type\": \"\",\n            \"created_on\": \"2019-10-09T16:54:34.0117Z\",\n            \"local_connect\": false,\n            \"name\": \"p22\",\n            \"number_pool\": \"/v1/Account/xxxxxxxx/NumberPool/<number_pool_uuid>/\",\n            \"sticky_sender\": false,\n            \"uuid\": \"<powerpack_uuid>\"\n        }\n}"
    }
  ]
}