Chilkat Online Tools

Swift3 / Plivo REST API / List Media

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    http.basicAuth = true
    http.login = "{{auth_id}}"
    http.password = "password"

    let queryParams = CkoJsonObject()!
    queryParams.updateInt("limit", value: 20)
    queryParams.updateInt("offset", value: 0)

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api.plivo.com/v1/Account/<auth_id>/Media/", json: queryParams)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("\(resp!.statusCode.intValue)")
    print("\(resp!.bodyStr!)")
    resp = nil

}

Curl Command

curl -G -d "limit=20"
	-d "offset=0"
	-u '{{auth_id}}:password'
https://api.plivo.com/v1/Account/<auth_id>/Media/

Postman Collection Item JSON

{
  "name": "List Media",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Media/?limit=20&offset=0",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Media",
        ""
      ],
      "query": [
        {
          "key": "limit",
          "value": "20",
          "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": "0",
          "description": "Denotes the number of value items by which the results should be offset. Defaults to 0."
        }
      ]
    },
    "description": "This API can be used to fetch a list of medias associated with a given auth. More information can be found [here](https://www.plivo.com/docs/sms/api/media#list-media)\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 Media",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Media/?limit=20&offset=0",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Media",
            ""
          ],
          "query": [
            {
              "key": "limit",
              "value": "20",
              "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": "0",
              "description": "Denotes the number of value items by which the results should be offset. Defaults to 0."
            }
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"<api_id>\",\n    \"meta\": {\n        \"limit\": 20,\n        \"next\": \"/v1/Account/<auth_id>/Media?offset=20&limit=20\",\n        \"offset\": 0,\n        \"previous\": \"/v1/Account/<auth_id>/Media?offset=0&limit=20\"\n        \"total_count\": 44\n    },\n    \"objects\": [\n        {\n            \"content_type\": \"image/jpeg\",\n            \"file_name\": \"sample2.jpg\",\n            \"media_id\": \"<media_id>\",\n            \"size\": 113730,\n            \"upload_time\": \"2020-02-17T05:46:54.481186Z\",\n            \"media_url\": \"https://media.plivo.com/Account/<auth_id>/Media/<media_id>\"\n        },\n        .\n        .\n        .\n        .\n       {\n            \"content_type\": \"application/pdf\",\n            \"file_name\": \"pdf_sample.pdf\",\n            \"media_id\": \"<media_id>\",\n            \"size\": 309500,\n            \"upload_time\": \"2020-02-17T08:32:41.924866Z\",\n            \"media_url\": \"https://media.plivo.com/Account/<auth_id>/Media/<media_id>\"\n        }\n    ]\n}"
    }
  ]
}