Chilkat Online Tools

delphiDll / Plivo REST API / Remove a TollFree number

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;

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

http := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'{{auth_id}}');
CkHttp_putPassword(http,'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 := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'unrent','False');

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);

resp := CkHttp_PTextSb(http,'DELETE','https://api.plivo.com/v1/Account/<auth_id>/NumberPool/{number_pool_uuid}/Tollfree/{tollfree_number}/',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);

Curl Command

curl -X DELETE
	-u '{{auth_id}}:password'
	-d '{
    "unrent":"False"
}'
https://api.plivo.com/v1/Account/<auth_id>/NumberPool/{number_pool_uuid}/Tollfree/{tollfree_number}/

Postman Collection Item JSON

{
  "name": "Remove a TollFree 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}/Tollfree/{tollfree_number}/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "NumberPool",
        "{number_pool_uuid}",
        "Tollfree",
        "{tollfree_number}",
        ""
      ]
    },
    "description": "Removes the tollfree number from the numberpool resource. More information can be found [here](https://www.plivo.com/docs/sms/api/numberpool#list-all-tollfree)\n\n| Arguments   | Description | Required/Conditional/Optional |\n| :---:        |    :----:   |          :---: |\n| unrent     | Default is False if not specified.| Optional  |"
  },
  "response": [
    {
      "name": "Remove a TollFree 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}/Tollfree/{tollfree_number}/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "NumberPool",
            "{number_pool_uuid}",
            "Tollfree",
            "{tollfree_number}",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"57936fb0-7ed5-11ea-aa79-0242ac110003\",\n    \"response\": \"success\"\n}"
    }
  ]
}