Chilkat Online Tools

Ruby / Plivo REST API / Remove a Number

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")

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "unrent": "False"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("unrent","False")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("DELETE","https://api.plivo.com/v1/Account/<auth_id>/NumberPool/{number_pool_uuid}/Number/{number}/",sbRequestBody,"utf-8","application/json",false,false)
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 -X DELETE
	-u '{{auth_id}}:password'
	-d '{
    "unrent":"False"
}'
https://api.plivo.com/v1/Account/<auth_id>/NumberPool/{number_pool_uuid}/Number/{number}/

Postman Collection Item JSON

{
  "name": "Remove a Number",
  "request": {
    "method": "DELETE",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"unrent\":\"False\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/NumberPool/{number_pool_uuid}/Number/{number}/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "NumberPool",
        "{number_pool_uuid}",
        "Number",
        "{number}",
        ""
      ]
    },
    "description": "Removes the number from the number pool resource. More information can be found [here](https://www.plivo.com/docs/sms/api/numberpool#remove-a-number)\n\n| Arguments   | Description | Required/Conditional/Optional |\n| :---:       |    :----:   |          :---: |\n| unrent | Default is False if not specified.| Optional  |"
  },
  "response": [
    {
      "name": "Remove a Number",
      "originalRequest": {
        "method": "DELETE",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"unrent\":\"False\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/NumberPool/{number_pool_uuid}/Number/{number}/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "NumberPool",
            "{number_pool_uuid}",
            "Number",
            "{number}",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"c378d44c-0a89-11ea-b072-0242ac110007\",\n    \"response\": \"success\"\n}"
    }
  ]
}