PUT /pm-extension-ms/pm-personal-number/v1/{extensionNumber}

Update personal number details related to the specific extension number.

To update the personal number details related to the specific extension number:

Perform the authentication and login to the API. For more information, see POST /auth/login.
Use PUT /pm-extension-ms/pm-personal-number/v1/{extensionNumber} to send an HTTP PUT request.
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",
  "personalNumberVO": {
    "pelp": {
      "lists": [
        {
          "listno": 0,
          "delayListNumber": "string",
          "chos": [
            {
              "orgsel": {
                "intPri": true,
                "opi": true,
                "pub": true
              },
              "anspos": "string",
              "bsycho": 0,
              "cfipt": true,
              "chono": 0,
              "divimmediate": true,
              "divonBusy": true,
              "divonNoReply": true,
              "dndposition": 0,
              "efme": true,
              "fme": true,
              "imsupport": true,
              "onecal": true,
              "smssupport": true,
              "stime": 0,
              "delayList": {
                "listNumber": 0,
                "listName": "string"
              }
            }
          ],
          "listName": "string"
        }
      ],
      "dir": "string",
      "cust": "string"
    },
    "susi": {
      "activeDiversions": {
        "activeDiversion": [
          "string"
        ]
      },
      "listno": "string",
      "rou": {
        "rouname": "string",
        "rounumber": "string"
      },
      "tru": "string",
      "lineStatus": "string",
      "trafficStatus": {
        "trafficState": "string",
        "odnstatus": "string"
      },
      "additionalInfo": {
        "directoryState": "string",
        "fre": "string",
        "publicNumber": "string",
        "ecf": "string",
        "authlock": "string",
        "mmw": "string",
        "rdc": "string",
        "list": "string",
        "fme": "string"
      },
      "dir": "string",
      "hardware": {
        "description": "string",
        "position": "string"
      }
    },
    "pelc": {
      "frt": "string",
      "dispconp": "string",
      "dispidle": "string",
      "dir": "string",
      "fme": "string"
    },
    "dir": "string"
  }
}

The following table describes the request body parameters.

Parameter Name	Sample Value	Description
>extensionId	String	The Extension Number.The extension number is the directory number for the extension. Format: Non-editable Note: This parameter is mandatory.
>personalNumberVO
>>pelp
>>>lists Complete personal number list.
>>>>delayListNumber	String	Delay Seizure List for Personal Number. A delay seizure list defines the time delays from a call is received until signals are given on phones associated with an extension. The time delay is used for extensions using the functions parallel ringing or personal number, and the delay time is set per extension type (IP, digital, etc.). An extension can be associated with one delay seizure list per function, where the list defined for the personal number function has the highest priority. If an extension's personal number list is associated with a delay seizure list, the delay seizure settings for parallel ringing are overridden for the extensions in the personal list. Example: An extension is, besides using the parallel ringing function, associated to an active personal number list. The personal number list, in turn, associated with a delay seizure list. In this delay seizure list, the delay time is set to 0 seconds for IP phones and to 5 seconds for digital phones. This means that for this extension, and any other extension in the personal number list that uses parallel ringing where one of the phones is an IP phone and another is a digital phone, the IP phone will give signal when receiving call, while the digital phone will give signal after 5 seconds. Options: None (no delay seizure list is used). Available delay seizure lists, as defined in the Delay Seizure List task in Service Node Manager (Telephony>Extensions). Default is None.
>>>>listno	Integer (int32)	The number of the list. A Personal Number can have up to 10 different lists available, but only one of them can be active. Format: Non-editable Note: This parameter is mandatory.
>>>>chos Information about an answering position.
>>>>>bsycho	Integer (int32)	Select how a call will be deflected if the answering position is busy. Options: Reroute: The call is deflected according to the reroute settings for Number Busy tone: The deflection of the call is stopped and the calling party receives a busy tone Next sequence: The call is deflected to Number in Call Sequence 2 3: The call is deflected to Number in Call Sequence 3 4: The call is deflected to Number in Call Sequence 4 5: The call is deflected to Number in Call Sequence 5 6: The call is deflected to Number in Call Sequence 6 7: The call is deflected to Number in Call Sequence 7 8: The call is deflected to Number in Call Sequence 8 9: The call is deflected to Number in Call Sequence 10: The call is deflected to Number in Call Sequence 10 Default is `Reroute`
>>>>>cfipt	Boolean	By initiating call filtering for a personal number list, the personal number function is disabled (IRD bypass) if the receiving party's personal number list contains the calling party's phone number. This means that when filtering is initiated, incoming calls where the calling party is included in the receiver's personal number list will be routed to the called extension only. If not answered on this answering position, no diversion of the call will take place. Call filtering for personal number lists only applies for IP phones. Format: Checkbox. Options: Selected: Disable the personal number function if the receiving party's personal number list contains the calling party's phone number. Cleared: Execute the personal number function even if the receiving party's personal number list contains the calling party's phone number. Default is Selected.
>>>>>chono	Integer (int32)	Call Sequence number. A delay seizure list defines the time delays from a call is received until signals are given on phones associated with an extension. The time delay is used for extensions using the functions parallel ringing or personal number, and the delay time is set per extension type (IP, digital, etc.). An extension can be associated with one delay seizure list per function, where the list defined for the personal number function has the highest priority. If an extension's personal number list is associated with a delay seizure list, the delay seizure settings for parallel ringing are overridden for the extensions in the personal list. Example: An extension is, besides using the parallel ringing function, associated to an active personal number list. The personal number list, in turn, associated with a delay seizure list. In this delay seizure list, the delay time is set to 0 seconds for IP phones and to 5 seconds for digital phones. This means that for this extension, and any other extension in the personal number list that uses parallel ringing where one of the phones is an IP phone and another is a digital phone, the IP phone will give signal when receiving call, while the digital phone will give signal after 5 seconds. Options: None (no delay seizure list is used). Available delay seizure lists, as defined in the Delay Seizure List task in Service Node Manager (Telephony>Extensions). Default is None. Note: This parameter is mandatory.
>>>>>delayList
>>>>>>listNumber	Integer (int32)	The number of the list. A Personal Number can have up to 10 different lists available, but only one of them can be active. Format: Non-editable Note: This parameter is mandatory.
>>>>>>listName	String	Enter a descriptive name for the list. Format: Up to 10 alphanumerical characters. The characters " and % are not allowed. The $ character is not accepted as the first letter but can be accepted later in the name. Example: Home Office
>>>>>divimmediate	Boolean	Immediate Diversion is allowed to be executed on the destination. Format: Checkbox. Selected: Allow Immediate Diversion. Cleared: Restrict Immediate Diversion. Default is Cleared. Note: IRD service/list and diversion must be located in the same system otherwise the call is distributed to the following position in the IRD list.
>>>>>divonBusy	Boolean	Diversion on Busy is allowed to be executed on the destination. Format: Checkbox. Options: Selected: Allow Diversion on Busy. Cleared: Restrict Diversion on Busy. Default is Cleared. Note: IRD service/list and diversion must be located in the same system otherwise the call is distributed to the following position in the IRD list.
>>>>>divonNoReply	Boolean	Diversion on no reply is allowed to be executed on the destination. Format: Checkbox. Options: Selected: Allow Diversion on no reply. Cleared: Restrict Diversion on no reply. Default is Cleared. Note: IRD service/list and diversion must be located in the same system otherwise the call is distributed to the following position in the IRD list.
>>>>>dndposition	Integer (int32)	Select how a call will be distributed if the answering position has DND active. Options: No Progress: No DND position is set Bypass: the dnd position is bypassed Next sequence: the call is distributed to the next Number in Call Sequence 3: the call is distributed to Number in Call Sequence 3 4: the call is distributed to Number in Call Sequence 4 5: the call is distributed to Number in Call Sequence 5 6: the call is distributed to Number in Call Sequence 6 7: the call is distributed to Number in Call Sequence 7 8: the call is distributed to Number in Call Sequence 8 9: the call is distributed to Number in Call Sequence 9 10: the call is distributed to Number in Call Sequence 10 Default is Reroute.
>>>>>efme	Boolean	External follow-me is allowed to be executed on the destination. Format: Checkbox. Options: Selected: Allow External follow-me. Cleared: Restrict External follow-me. Default is Cleared. Note: IRD service/list and diversion must be located in the same system otherwise the call is distributed to the following position in the IRD list.
>>>>>fme	Boolean	Follow-me is allowed to be executed on the destination. Format: Checkbox. Options: Selected: Allow follow-me. Cleared: Restrict follow-me. Default is Cleared. Note: IRD service/list and diversion must be located in the same system otherwise the call is distributed to the following position in the IRD list.
>>>>>imsupport	Boolean	States whether instant messaging between end-points is supported for the call sequence position and the Number. Format: Checkbox. Options: Selected: The number specified in the call sequence is allowed to support instant messaging. Cleared: The number specified in the call sequence is not allowed to support instant messaging. Default is Selected. Note: Combination of "Support Instant Messaging" and "Use Once" are not allowed to be selected at the same time.
>>>>>onecal	Boolean	Select if it should only be possible to call the answering position once while the call is being distributed. Options: Selected: when the answering position has received a call, it will not be called again by another incoming call to the service while the deflection to that answering position is ongoing. New incoming calls deflected to that answering position will be directly distributed to the next answering position. Cleared: the answering position can be called as many times as the Personal Number is called. Default is Cleared. Note: Combination of "Support Instant Messaging" and "Use Once" are not allowed to be selected at the same time.
>>>>>smssupport	Boolean	By initiating SMS Support for a personal number list, personal number function is disabled until answering position in the call sequence is assigned with a number. This means that when sms support is initiated, the number specified in the call sequence is allowed to receive SMS messages. Format: Checkbox. Options: Selected: The number specified in the call sequence is allowed to receive SMS messages. Cleared: The number specified in the call sequence is not allowed to receive SMS messages. Default is Selected.
>>>>>stime	Integer (int32)	Enter the number of seconds for the Ring Duration, that is, the time before the call is deflected to the next position or terminated if it is the last position. Format: Up to 2 digits. Options: 2-60. Default is 20. Example: 15 Note: This parameter is mandatory.
>>>>>orgsel Select which type of calls, depending on their origin, that may be deflected to the answering position.
>>>>>>intPri	Boolean	Indicates whether to deflect the internal calls to the answering position. Options: Selected: Internal or private calls are deflected to the answering position. Cleared: Internal calls are not deflected to the answering position Default is Selected.
>>>>>>opi	Boolean	Indicates whether to deflect the PBX operator calls to the answering position. Options: Selected: Calls from the PBX operator are deflected to the answering position. Cleared: Calls from the PBX operator are not deflected to the answering position Default is Selected.
>>>>>>pub	Boolean	Indicates whether to deflect the external calls to the answering position. Options: Selected: Public or unknown calls are deflected to the answering position. Cleared: Public or unknown calls are not deflected to the answering position Default is Selected.
>>>>>anspos	Boolean	Enter the directory number of the answering position to which the call will be deflected when the list is active. The answering positions can be: An extension number 'ODN' for 'Own Directory Number' A number in the private network A number in the public network An internal group hunting group Individual PBX operators or PBX operator group A voice mail system Virtual generic extensions Format: Up to 20 digits. Options: 0-99999999999999999999, ODN, ODN K, ODN - K (K is any Integer constant) Example: 024823535, ODN, ODN+1000, ODN-500
>>>>listName	String	Enter a descriptive name for the list. Format: Up to 10 alphanumerical characters. The characters " and % are not allowed. The $ character is not accepted as the first letter but can be accepted later in the name. Example: Home Office
>>>dir	String	-
>>>cust	String	-
>>susi
>>>activeDiversions
>>>>activeDiversion	String	-
>>>listno	String	The number of the list. A Personal Number can have up to 10 different lists available, but only one of them can be active. Format: Non-editable Note: This parameter is mandatory.
>>>rou
>>>>rouname	String	-
>>>>rounumber	String	-
>>>tru	String	-
>>>lineStatus	String	-
>>>trafficStatus
>>>>trafficState	String	-
>>>>odnstatus	String	-
>>>additionalInfo
>>>>directoryState	String	-
>>>>fre	String	-
>>>>publicNumber	String	-
>>>>ecf	String	-
>>>>authlock	String	-
>>>>mmw	String	-
>>>>rdc	String	-
>>>>fme	String	-
>>>>list	String	-
>>>dir	String	-
>>>hardware
>>>>position	String	-
>>>>description	String	-
>>pelc
>>>frt	String	-
>>>dispconp	String	-
>>>dispidle	String	-
>>>dir	String	-
>>>fme	String	-
>>>dir	String	-
>>dir	String	-

Click on Execute to generate the request URL.

Request URL:

https://<IP_Address>:<PORT>/pm-extension-ms/pm-personal-number/v1/1

The following table lists the expected responses.

Response Type	Value	Schema
Valid Response	200 OK	See 200 OK: PUT /pm-extension-ms/pm-personal-number/v1/{extensionNumber}
Error Response	400 Bad Request	Not applicable
	401 Authentication Failure	Not applicable
	403 Forbidden	Not applicable
	404 Not found	Not applicable

↑