User Phone Buttons

The User Phone Buttons API manages the configuration of the buttons of the phone associated to the user.

This data supported by this API are driven by the “fastkeys” section of the phone type properties as defined in Phone Types.

Display the Buttons of the Phone of a User

GET /api/v1/telenet/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/access_device/phone_buttons/

Display the current configuration of the Phone Buttons configured on the Access Device linked to the User.

Note: the API returns also the full properties of the phone for future use but it is not described as currently not used

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/access_device/phone_buttons/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
      "deviceType": "Telenet-Panasonic-KX-HDV230",
      "deviceName": "DP_giulio@sip.netaxis.be",
      "keys": [
          {"id": 4, "type": "CALLLOG", "label": "history", "parameter": ""},
          {"id": 5, "type": "ONETOUCH", "label": "call boss", "parameter": "065432368"}
      ]
}

Response JSON Object:

• deviceType (string) – The Type of of the phone.

• deviceName (string) – The name of ther phone.

• keys (list) – a list of keyConfiguration objects as defined as Key Configuration.

Status Codes:

• 200 OK – no error

• 404 Not Found – the user has no phone linked to him.

Update the Buttons of the Phone of a User

PUT /api/v1/telenet/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/access_device/phone_buttons/

Modify the configuration of the Phone Buttons configured on the Access Device linked to the User.

Example request:

PUT /api/v1/telenet/tenants/foo/groups/foogroup/users/foouser/access_device/phone_buttons/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
     "keys": [
        {"id": 4, "type": "CALLLOG", "label": "c. history", "parameter": ""},
        {"id": 5, "type": "ONETOUCH", "label": "call chief", "parameter": "065432368"}
     ]
}

Request JSON Object:

• keys (list) – a list of keyConfiguration objects as defined as Key Configuration.

Example response:

same as GET.

Status Codes:

• 200 OK – no error

• 404 Not Found – no phone linked to the user

• 400 Bad Request – error during the update

Key Configuration

Name	Type	Method		Description
		GET	PUT
id	Int	A	R	The key id (1 to 24)
type	String	A	R	The associated action. Value from: “DIRECT_CALL”: “BLF”: monitor a specific user “BLF_LIST”: monitor any user of the BLF list “LINE”: “CALLLOG”: “PHONEBOOK”: “TRANSFER” “”BLINDTRANSFER” “CALLPICKUP” “REDIAL” “CF_ACTIVATION_WITH_NUMBER”: Activate CFA to a number “CF_DEACTIVATION”: Deactivate CFA “DND_TOGGLE”: Switch between DND on and DND off “DND_ACTIVATION”: Activate DND “DND_DEACTIVATION”: Deactivate DND “GROUP_LISTENING”: “GROUP_PICKUP”: Take a call for your pickup group
label	String	A	R	The label that will be displayed on the phone
parameter	String	A	C	The conditional parameter (extension, phone number or line id) The fact it is needed or not is defined in the phone type

Notes

Additional values for the “type” can be defined project based. The ones listed here are the one supported by default in the APIO but some can be not supported by some phone types.

It must also be noted that the real list of supported values for a specific phone type, always come from the phone type definition (see Phone Types), not all phones supports all types.