Chilkat Online Tools

phpAx / Plivo REST API / Buy a Phone Number

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

$http->BasicAuth = 1;
$http->Login = '{{auth_id}}';
$http->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.

// {
//   "app_id": "77543232947799695"
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('app_id','77543232947799695');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://api.plivo.com/v1/Account/<auth_id>/PhoneNumber/15418341850/','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "app_id": "77543232947799695"
}'
https://api.plivo.com/v1/Account/<auth_id>/PhoneNumber/15418341850/

Postman Collection Item JSON

{
  "name": "Buy a Phone Number",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"app_id\": \"77543232947799695\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/PhoneNumber/15418341850/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "PhoneNumber",
        "15418341850",
        ""
      ]
    },
    "description": "Buys the phone number and adds it to your account. Certain countries have address and identity verification requirements. Phone numbers bought from these countries are activated after the provision of the required verification documents.\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/numbers/api/phone-number#buy-a-phone-number)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| app_id      | The application to be assigned to the phone number. If not specified, the application selected as the default_number_app of the Account is assigned. For more information, refer default_number_app argument in [application](https://www.plivo.com/docs/account/api/application#create-an-application) and app_id attribute in [application object](https://www.plivo.com/docs/account/api/application#the-application-object).| Optional  |"
  },
  "response": [
    {
      "name": "Buy a Phone Number",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"app_id\": \"77494029089751836\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/PhoneNumber/{number}/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "PhoneNumber",
            "{number}",
            ""
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"48110f34-c849-11eb-b5c3-0242ac110004\",\n    \"message\": \"created\",\n    \"numbers\": [\n        {\n            \"number\": \"12609605734\",\n            \"status\": \"Success\"\n        }\n    ],\n    \"status\": \"fulfilled\"\n}"
    }
  ]
}