All URIs are relative to https://platform.devtest.ringcentral.com
| Method | HTTP request | Description |
|---|---|---|
| AccountPresence | Get /restapi/v1.0/account/{accountId}/presence | Get all user statuses |
| GetMonitoringExtensions | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/permission | Get User Presence Permissions |
| GetPresenceLine | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line/{lineId} | Get Monitored Extensions by Id |
| GetPresenceStatus | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence | Get User Status |
| ListMonitoredExtensions | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line | Get Monitored Extensions |
| PutMonitoringExtensions | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/permission | Update User Presence Permissions |
| UpdatePresenceLines | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line | Update Monitored Extensions |
| UpdatePresenceStatus | Put /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence | Update User Status |
AccountPresenceInfo AccountPresence(ctx, accountId) Get all user statuses
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MonitoringExtensionsResource GetMonitoringExtensions(ctx, extensionId, accountId) Get User Presence Permissions
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| extensionId | string | Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~] |
| accountId | string |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PresenceLineResource GetPresenceLine(ctx, lineId, extensionId, accountId) Get Monitored Extensions by Id
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| lineId | string | ||
| extensionId | string | Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~] |
| accountId | string | Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetPresenceInfo GetPresenceStatus(ctx, accountId, extensionId) Get User Status
Since 1.0.2
Returns presence status of an extension or several extensions by their ID(s). Batch request is supported, see Batch Requests for details.The presenceStatus is returned as Offline (the parameters telephonyStatus, message, userStatus and dndStatus are not returned at all) for the following extension types: Department/Announcement Only/Take Messages Only (Voicemail)/Fax User/Paging Only Group/Shared Lines Group/IVR Menu/Application Extension/Park Location.If the user requests his/her own presence status, the response contains actual presence status even if the status publication is turned off.Batch request is supported. For batch requests the number of extensions in one request is limited to 30. If more extensions are included in the request, the error code 400 Bad Request is returned with the logical error code InvalidMultipartRequest and the corresponding message 'Extension Presence Info multipart request is limited to 30 extensions'.
| Permission | Description |
|---|---|
| ReadPresence | Getting user presence information |
Light
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] |
| extensionId | string | Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetMonitoredExtensionsResponse ListMonitoredExtensions(ctx, accountId, extensionId) Get Monitored Extensions
Since 1.0.13 (Release 6.5)
Returns list of lines - extensions which presence status can be indicated and monitored on BLF-enabled (Busy Lamp Field) devices.
| Permission | Description |
|---|---|
| ReadPresence | Getting user presence information |
Light
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] |
| extensionId | string | Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~] |
GetMonitoredExtensionsResponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MonitoringExtensionsResource PutMonitoringExtensions(ctx, extensionId, accountId, userPresencePermissionsUpdateRequest) Update User Presence Permissions
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| extensionId | string | Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~] |
| accountId | string | ||
| userPresencePermissionsUpdateRequest | UserPresencePermissionsUpdateRequest |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdatePresenceLinesResponse UpdatePresenceLines(ctx, accountId, extensionId, updatePresenceLinesRequest) Update Monitored Extensions
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] |
| extensionId | string | Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~] |
| updatePresenceLinesRequest | UpdatePresenceLinesRequest |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PresenceInfoResource UpdatePresenceStatus(ctx, accountId, extensionId, presenceInfoResource) Update User Status
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] |
| extensionId | string | Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~] |
| presenceInfoResource | PresenceInfoResource |
- Content-Type: multipart/mixed, application/json
- Accept: multipart/mixed, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]