POST /pm-extension-ms/pm-phone-setup/keys/v1/{extensionNumber}

Perform the authentication and login to the API. For more information, see POST /auth/login.

Use POST /user-ms/user/v1 to send an HTTP POST request to the authentication service.

Click Try it Out option.

Set the parameters as listed in the following table.

Parameter Name	Sample Value	Supported Value	Description
extensionNumber	extensionNumber	string	Indicates the extension number. Note: This parameter is mandatory.

Under Request body select application/json from drop-down list.

Enter the request body parameter values as follows:

{
  "extensionId": "string",
  "phonePanelType": "string",
  "addedKeys": [
    {
      "keyPosition": 0,
      "logicalKeyId": 0,
      "keyType": "EMPTY",
      "isEditable": true,
      "displayText": "string",
      "keyFunction": "string",
      "keyFunctionValue": "string"
    }
  ],
  "updatedKeys": [
    {
      "keyPosition": 0,
      "logicalKeyId": 0,
      "keyType": "EMPTY",
      "isEditable": true,
      "displayText": "string",
      "keyFunction": "string",
      "keyFunctionValue": "string"
    }
  ],
  "removedKeys": [
    {
      "keyPosition": 0,
      "logicalKeyId": 0,
      "keyType": "EMPTY",
      "isEditable": true,
      "displayText": "string",
      "keyFunction": "string",
      "keyFunctionValue": "string"
    }
  ]
}

The following table describes the request body parameters.

Parameter Name	Sample Value	Description
>extensionId	String	-
>phonePanelType	String	-
>addedKeys
>>keyPosition	Integer (int32)	-
>>logicalKeyId	Integer (int32)	-
>>keyType	String	-
>>isEditable	Boolean	-
>>displayText	String	-
>>keyFunction	String	-
>>keyFunctionValue	String	-
>updatedKeys
>>keyPosition	Integer (int32)	-
>>logicalKeyId	Integer (int32)	-
>>keyType	String	-
>>isEditable	Boolean	-
>>displayText	String	-
>>keyFunction	String	-
>>keyFunctionValue	String	-
>removedKeys
>>keyPosition	Integer (int32)	-
>>logicalKeyId	Integer (int32)	-
>>keyType	String	-
>>isEditable	Boolean	-
>>displayText	String	-
>>keyFunction	String	-
>>keyFunctionValue	String	-

Click on Execute to generate the request URL.

Request URL:

https://<IP_Address>:<PORT>/pm-extension-ms/pm-extension/v1/virtual?subsystemName=1

The following table lists the expected responses.

Response Type	Value	Schema
Valid Response	200 OK	{ "extensionId": "string", "phonePanelType": "string", "addedKeys": [ { "keyPosition": 0, "logicalKeyId": 0, "keyType": "EMPTY", "isEditable": true, "displayText": "string", "keyFunction": "string", "keyFunctionValue": "string" } ], "updatedKeys": [ { "keyPosition": 0, "logicalKeyId": 0, "keyType": "EMPTY", "isEditable": true, "displayText": "string", "keyFunction": "string", "keyFunctionValue": "string" } ], "removedKeys": [ { "keyPosition": 0, "logicalKeyId": 0, "keyType": "EMPTY", "isEditable": true, "displayText": "string", "keyFunction": "string", "keyFunctionValue": "string" } ] }
Error Response	400 Bad Request	Not applicable
	401 Authentication Failure	Not applicable
	403 Forbidden	Not applicable
	404 Not found	Not applicable