Speed Dial 100 Services

Dial a pre-defined number by dialing a Speed Dial 100 prefix and two digits.

Speed Dial 100 allows you to set up to 100 speed dial phone numbers or SIP-URI addresses that can be called with the push of a few buttons. Enter the number as you would normally dial it and then just hit the speed code prefix and number on your touch pad to call it. You can also program your speed dial using your phone and the star code for Speed Dial 100.

Display user’s assigned speed dial 100 list

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/speed_dial_100/

Retrieve the settings of the Speed Dial 100 service of the user.

Example request:

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

Example response:

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

{
   "speedCodes": [
      {"speedCode": "03", "phoneNumber": "+32504987165", "description": "Test description"},
      {"speedCode": "50", "phoneNumber": "+32101654987"}
   ],
   "prefix": "#"
}
Response JSON Object:

  • speedCodes (array) – a list of speedCodes as defined in Speed Code attributes.

  • prefix (string) – the prefix to be used in front of the speed code.

Status Codes:

Retrieve a user’s assigned speed dial 100 details

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/speed_dial_100/(string: speed_code_value)/

Retrieve the settings of the Speed Dial 100 service of the user.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/speed_dial_100/03/ HTTP/1.1
Host: example.com

Example response:

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

{
   "phoneNumber": "+32504987165",
   "description": "Test description"
}
Response JSON Object:

  • description (string) – the description.

  • phoneNumber (string) – the phone number.

Status Codes:

Assign a user’s speed dial 100 list

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/speed_dial_100/

Update the settings of the Speed Dial 100 service of the user by adding new entries.

Example request:

POST /api/v1/tenants/foo/groups/foogroup/users/foouser/services/speed_dial_100/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "speedCodes": [
      {"speedCode": "03", "phoneNumber": "+32504987165", "description": "Test description"},
      {"speedCode": "50", "phoneNumber": "+32101654987"}
   ]
}
Request JSON Object:

Example response:

HTTP/1.1 200 OK
Status Codes:

Update a user’s assigned speed dial 100 list

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/speed_dial_100/

Update the settings of the Speed Dial 100 service of the user by modifying existing entries.

Example request:

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

{
   "speedCodes": [
      {"speedCode": "03", "phoneNumber": "+32504987165", "description": ""},
      {"speedCode": "50", "phoneNumber": "+32101654987", "description": "Test description"}
   ]
}
Request JSON Object:

Example response:

HTTP/1.1 200 OK
Status Codes:

Remove a user’s speed dial 100 list

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/speed_dial_100/

Delete Speed Codes from the Speed Dial 100 service of the user.

Example request:

DELETE /api/v1/tenants/foo/groups/foogroup/users/foouser/services/speed_dial_100/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "speedCodes": [{"speedCode": "03"}, {"speedCode": "50"]
}
Request JSON Object:

  • speedCodes (array) – list of speedCodes to be deleted as defined in Speed Code attributes. The items of the list MUST be unique.

Example response:

Response:

Similar to GET list method response.

Status Codes: