Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel3
indentLIST OF METHODS

The speed dial module enables VUP users to set up and call contacts as speed dial entries. A speed dial entry is a shortcut using a number from the phone dial pad assigned to a particular telephone number.

Authorization 

The method requires authorization using basic authentication. Please use the sip login and password.

If notepad++ is used to generate basic authentication token for tests, please use option “Base64 Encode with padding”.

Example:

user:password in base 64 format --> dXNlcjpwYXNzd29yZA==

/GetList

  • Description: Gets the list of

  • Url: /VUP/api/SpeedDials/GetList

  • HTTP method: GET

Expand
titleREQUEST
Code Block
curl --location 'https://xxxxxxxx/vup/api/SpeedDials/GetList' \
--header 'Accept: application/json, text/plain, */*' \
--header 'Authorization: Basic dXNlcjpwYXNzd29yZA==' 
Expand
titleRESPONSE
Code Block
{
    "recordsTotal": 0,
    "recordsFiltered": 0,
    "data": []
}

/Save

  • Description: Save/ADD the speed dial rule

  • Url: /VUP/api/SpeedDials/GetList

  • HTTP method: POST

Expand
titleREQUEST
Code Block
curl --location 'https://xxxxxxxxxx/vup/api/SpeedDials/save' \
--header 'Accept: application/json, text/plain, */*' \
--header 'Authorization: Basic dXNlcjpwYXNzd29yZA==' \
--header 'Content-Type: application/json' \
--data '{
    "telephoneNumber": "48666666667",
    "speedDial": "3",
    "nickname": "Peterr"
}'
Expand
titleRESPONSE
Code Block
{}

/Remove

  • Description: Remove/Delete particular speed dial rule

  • Url: /VUP/api/SpeedDials/Remove

  • HTTP method: POST

Expand
titleREQUEST
Code Block
curl --location 'https://xxxxxxxxxxxxxx/vup/api/SpeedDials/Remove' \
--header 'Accept: application/json, text/plain, */*' \
--header 'Authorization: Basic dXNlcjpwYXNzd29yZA==' \
--header 'Content-Type: application/json' \
--data '{
            "id": 14
        }'
Expand
titleRESPONSE
Code Block
{}