Chilkat Online Tools

Ruby / Plivo REST API / Retrieve pricing for a country

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("{{auth_id}}")
http.put_Password("password")

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("country_iso","US")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.plivo.com/v1/Account/<auth_id>/Pricing/",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -G -d "country_iso=US"
	-u '{{auth_id}}:password'
https://api.plivo.com/v1/Account/<auth_id>/Pricing/

Postman Collection Item JSON

{
  "name": "Retrieve pricing for a country",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Pricing/?country_iso=US",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Pricing",
        ""
      ],
      "query": [
        {
          "key": "country_iso",
          "value": "US",
          "description": "The 2 digit country ISO code. For example, US for United States."
        }
      ]
    },
    "description": "Retrieves pricing for a specified country.\n\nBelow is the list of arguments that can be passed in this API request, more information can be found [here](https://www.plivo.com/docs/account/api/pricing#the-pricing-object)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| country_iso      | The 2 digit country ISO code. For example, US for United States.| Required |"
  },
  "response": [
    {
      "name": "Retrieve pricing for a country",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Pricing/?country_iso=US",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Pricing",
            ""
          ],
          "query": [
            {
              "key": "country_iso",
              "value": "US",
              "description": "The 2 digit country ISO code. For example, US for United States."
            }
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"7ff5505c-93ca-11e7-9bde-024427e23b8a\",\n    \"country\": \"United States\",\n    \"country_code\": 1,\n    \"country_iso\": \"US\",\n    \"message\": {\n        \"inbound\": {\n            \"rate\": \"0.00000\"\n        },\n        \"outbound\": {\n            \"rate\": \"0.00350\"\n        },\n        \"outbound_networks_list\": [\n            {\n                \"group_name\": \"US\",\n                \"rate\": \"0.00350\"\n            },\n            {\n                \"group_name\": \"United States - AT&T Mobility\",\n                \"rate\": \"0.00350\"\n            }\n        ]\n    },\n    \"phone_numbers\": {\n        \"local\": {\n            \"rate\": \"0.80000\"\n        },\n        \"tollfree\": {\n            \"rate\": \"1.00000\"\n        }\n    },\n    \"voice\": {\n        \"inbound\": {\n            \"ip\": {\n                \"rate\": \"0.00300\"\n            },\n            \"local\": {\n                \"rate\": \"0.00850\"\n            },\n            \"tollfree\": {\n                \"rate\": \"0.02100\"\n            }\n        },\n        \"outbound\": {\n            \"ip\": {\n                \"rate\": \"0.00300\"\n            },\n            \"local\": {\n                \"rate\": \"0.00750\"\n            },\n            \"rates\": [\n                {\n                    \"prefix\": [\n                        \"1\"\n                    ],\n                    \"rate\": \"0.00750\"\n                }\n            ],\n            \"tollfree\": {\n                \"rate\": null\n            }\n        }\n    }\n}"
    }
  ]
}