Chilkat Online Tools

Mono / Plivo REST API / Add a Number

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

http.BasicAuth = true;
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.

// {
//   "service": "sms"
// }

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("service","sms");

Chilkat.HttpResponse resp = http.PostJson3("https://api.plivo.com/v1/Account/<auth_id>/NumberPool/{number_pool_uuid}/Number/{number}/","application/json",json);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Debug.WriteLine(Convert.ToString(resp.StatusCode));
Debug.WriteLine(resp.BodyStr);

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "service":"sms"
}'
https://api.plivo.com/v1/Account/<auth_id>/NumberPool/{number_pool_uuid}/Number/{number}/

Postman Collection Item JSON

{
  "name": "Add a Number",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"service\":\"sms\"\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": "This API enables you to add SMS/MMS enabled numbers to a numberpool resource via Plivo’s SMS service. More information can be found [here](https://www.plivo.com/docs/sms/api/numberpool#add-a-number)\n\n| Arguments   | Description | Required/Conditional/Optional |\n| :---:        |    :----:   |          :---: |\n| service     | Set this parameter either assms for SMS-enabled numbers or as mms for MMS-enabled numbers. Defaults to sms.| Optional  |"
  },
  "response": [
    {
      "name": "Add a Number",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"service\":\"sms\"\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    \"account_phone_number_resource\": \"/v1/Account/<auth_id>/Number/<your_number>/\",\n    \"added_on\": \"2019-10-09T11:24:35.085797Z\",\n    \"api_id\": \"612982e8-0a87-11ea-b072-0242ac110007\",\n    \"country_iso2\": \"CA\",\n    \"number\": \"<your_number>\",\n    \"number_pool_uuid\": \"<number_pool_uuid>\",\n    \"service\": \"mms\",\n    \"type\": \"fixed\"\n}"
    }
  ]
}