Chilkat Online Tools

Node.js / Plivo REST API / Create an endpoint

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var 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.

    // {
    //   "username": "testusername",
    //   "password": "testpassword",
    //   "alias": "Test Account",
    //   "app_id": "77494029089751836"
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("username","testusername");
    json.UpdateString("password","testpassword");
    json.UpdateString("alias","Test Account");
    json.UpdateString("app_id","77494029089751836");

    // resp: HttpResponse
    var resp = http.PostJson3("https://api.plivo.com/v1/Account/<auth_id>/Endpoint/","application/json",json);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "username": "testusername",
    "password": "testpassword",
    "alias": "Test Account",
    "app_id": "77494029089751836"
}'
https://api.plivo.com/v1/Account/<auth_id>/Endpoint/

Postman Collection Item JSON

{
  "name": "Create an endpoint",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"username\": \"testusername\",\n    \"password\": \"testpassword\",\n    \"alias\": \"Test Account\",\n    \"app_id\": \"77494029089751836\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Endpoint/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Endpoint",
        ""
      ]
    },
    "description": "Creates a new endpoint.\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/voice/api/endpoint#create-an-endpoint)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| username      | Username for the endpoint to be created. Only alphanumeric characters are accepted. This username will be used to configure your SIP Phone. The username must start with an alphabet.| Required  |\n| password   | Password for your endpoint username. It should be at least 5 characters long.| Required      |\n| alias   | Alias for the endpoint. | Required |\n| app_id   | app_id of the application that will be attached to this endpoint. | Optional |"
  },
  "response": [
    {
      "name": "Create an endpoint",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"username\": \"testusername\",\n    \"password\": \"testpassword\",\n    \"alias\": \"Test Account\",\n    \"app_id\": \"77494029089751836\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Endpoint/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Endpoint",
            ""
          ]
        }
      },
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"username\": \"zumba131031145958\",\n    \"alias\": \"zumba\",\n    \"message\": \"created\",\n    \"endpoint_id\": \"37371860103666\",\n    \"api_id\": \"1c13de4c-423d-11e3-9899-22000abfa5d5\"\n}"
    }
  ]
}