Chilkat Online Tools

phpAx / Plivo REST API / Update an endpoint

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.

// {
//   "password": "testpassword",
//   "alias": "testalaias",
//   "app_id": "14659095951490"
// }

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

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://api.plivo.com/v1/Account/<auth_id>/Endpoint/{endpoint_id}/','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 '{
    "password": "testpassword",
    "alias": "testalaias",
    "app_id": "14659095951490"
}'
https://api.plivo.com/v1/Account/<auth_id>/Endpoint/{endpoint_id}/

Postman Collection Item JSON

{
  "name": "Update an endpoint",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"password\": \"testpassword\",\n    \"alias\": \"testalaias\",\n    \"app_id\": \"14659095951490\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Endpoint/{endpoint_id}/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Endpoint",
        "{endpoint_id}",
        ""
      ]
    },
    "description": "Updates an endpoint’s password, alias or the application attached to it.\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#update-an-endpoint)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| password      | Password for your endpoint username. It should be at least 5 characters long.| Optional  |\n| alias   | Alias for the endpoint.        | Optional      |\n| app_id   | app_id of the application that will be attached to this endpoint. | Optional |"
  },
  "response": [
    {
      "name": "Update an endpoint",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"password\": \"testpassword\",\n    \"alias\": \"testalaias\",\n    \"app_id\": \"14659095951490\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Endpoint/{endpoint_id}/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Endpoint",
            "{endpoint_id}",
            ""
          ]
        }
      },
      "code": 202,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"message\": \"changed\",\n    \"api_id\": \"d8f9ea6c-58cc-11e1-86da-adf28403fe48\"\n}"
    }
  ]
}