~~NOTOC~~
====== Kandy ======
Used to send PMS data to the Kandy PBX. User accounts should be configured to use the mailbox number associated on the DuVoice. The interface will attempt to match the //User ID// to a mailbox on a cache refresh. If it cannot find a mailbox number which matches it will attempt to use the //Number// associated with the user.

For Message Waiting see [[note:config:sipnotify|Direct To Phone]] configuration.

|< 80% 15% 20% 20% >|
^Link Type^Protocol Used^Log File Prefix^Features Supported^
|//TCP Client//|//HTTPS//|Kandy|Name Change, Call permissions |

===== Configuration =====
{{:images:vs7:manual:pbxlink-kandy.png?nolink|}}

The settings are grouped into two categories:  //Network// and //Scheduling//.  Configure the settings as needed and then click **OK** to save your changes and close the dialog.  Or click **Cancel** to discard any changes and close the dialog.

==== Network Settings ====

|< 85% 20% 15% >|
^Setting^Default^Description^
|//API base URL//|Blank|Enter the URL to post information to.|
|//X-User-ID//|Blank|Portal user ID for which API requests will be processed.|
|//Password//|Blank|User password.|
|//X-User-Token//|Blank|This is the unique token generated by the portal for each user to send API requests to. The user token will be regenerated on each password change.|
|//X-Group-ID//|Blank|Portal customer the user belongs to.|
|//X-HMAC//|Blank|Used for Hmac authentication.|
|//Use NONCE//|Disabled|Use NONCE authentication. This is not a setting a customer can control and is only available to some Ribbon customers. Contact Ribbon if your account requires it.|

==== Scheduling ====

|< 85% 20% 15% >|
^Setting^Default^Description^
|//Retries//|3|Number of times to resend a post that is rejected or otherwise fails. \\ \\ //Default is 3 retries (for a total of four attempts).//|
|//Interval (seconds)//|60|Enter the number of seconds to wait between retries.|
|//Refresh cache//|60|Number of minutes between refreshing cache of extensions. Always performed on startup.|

==== Other ====
|< 80% 20% >|
^Field^Description^
| //Enable debug// | All communication packets will be logged. **WARNING:** This will make very large log files and should only be used during testing. The system doesn't need to be shutdown for this to take effect. |