RIringcentral
Presence

Update User Presence Status

Updates user-defined extension presence status, status message and DnD status by extension ID. Supported for regular User extensions only. The extension types listed do not support presence status: Department, Announcement Only, Take Messages Only (Voicemail), Fax User, Paging Only Group, Shared Lines Group, IVR Menu, Application Extension.

put/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence

Request

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

extensionIdstring required

Internal identifier of the RingCentral extension/user (can be set to "~" to indicate that the extension associated with current authorization session should be used)

Request body

userStatus'Offline' | 'Busy' | 'Available'
dndStatus'TakeAllCalls' | 'DoNotAcceptDepartmentCalls' | 'TakeDepartmentCallsOnly' | 'DoNotAcceptAnyCalls' | 'Unknown'
messagestring
allowSeeMyPresenceboolean
ringOnMonitoredCallboolean
pickUpCallsOnHoldboolean
callerIdVisibility'All' | 'None' | 'PermittedUsers'

Configures the user presence visibility. When the allowSeeMyPresence parameter is set to true, the following visibility options are supported via this parameter - All, None, PermittedUsers

Response

OK

uristring uri

Link to the presence resource

userStatus'Offline' | 'Busy' | 'Available'
dndStatus'TakeAllCalls' | 'DoNotAcceptDepartmentCalls' | 'TakeDepartmentCallsOnly' | 'DoNotAcceptAnyCalls' | 'Unknown'
messagestring
allowSeeMyPresenceboolean
callerIdVisibility'All' | 'None' | 'PermittedUsers'

Configures the user presence visibility. When the allowSeeMyPresence parameter is set to true, the following visibility options are supported via this parameter - All, None, PermittedUsers

ringOnMonitoredCallboolean
pickUpCallsOnHoldboolean
meetingStatus'Connected' | 'Disconnected'

Meetings presence status

telephonyStatus'NoCall' | 'CallConnected' | 'Ringing' | 'OnHold' | 'ParkedCall'

Telephony presence status. Returned if telephony status is changed

presenceStatus'Offline' | 'Busy' | 'Available'

Aggregated presence status, calculated from a number of sources

Changes

No recorded changes to this operation across all 1 revision of this API.