API Docs for version 1.2.5200

UserSettings

Module: Circuit

Summary

Data object defining the UserSettings.

Properties

hideProfileExternal

Syntax

hideProfileExternal

Boolean

Summary

Hide Profile with externals.

presenceOptOut

Syntax

presenceOptOut

Boolean

Summary

Presence opt out

shareLocation

Syntax

shareLocation

Boolean

Summary

Share location (only applicable if not opted out of presence)

voicemailCustomGreetingEnabled

Syntax

voicemailCustomGreetingEnabled

Boolean

Summary

Enable custom voicemail greeting. Custom greeting can be uploaded or downloaded via TODO. Disabled by default. Can only be set if recording has been uploaded.

voicemailCustomGreetingUri

Syntax

voicemailCustomGreetingUri

String

Summary

Custom voicemail greeting uri.

voicemailEnabled

Syntax

voicemailEnabled

Boolean

Summary

Turn voicemail on/off. Applicable to Circuit internal audio and video calls.

voicemailTimeout

Syntax

voicemailTimeout

Number

Summary

Ringing duration of Circuit (and phone) calls before moving to voicemail. Valid values are: 5, 10, 15, 20, 25, 30 [seconds]