Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The GET /presences/users endpoint returns the presences of all the usersrequested users. Up to 50 users' presences can be requested in one request.

Panel
borderColor#eeeeee
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#F79CA6#D6219C
borderStylesolid
titleIn this page

Table of Contents

...

Type

Required

Example

Array of StringsTruedaab05ec-ba50-45af-a6fd-3b01cdc6f39b

Comma-separated list of user IDs. The maximum number of user IDs is 50 in one query. Individual user IDs are unique within the account.

Tip

A user's ID can be obtained via using the Users API endpoints.

Requests

...

Responses to the endpoint returns the presences of all the requested users.

Successful response

...

Code Block
languagejs
themeMidnight
[
  {
    "userId": "daab05ec-ba50-45af-a6fd-3b01cdc6f39b",
    "updated": "2021-10-22T13:16:26.730Z",
    "presence": {
      "presenceId": "eaed6862-14fa-4114-be62-b8709b5d4a49",
      "selectable": true,
      "category": {
        "categoryType": "LoggedOut",
        "description": "Logged Out",
		"subCategory": "LoggedOut"
      },
      "description": "Logged Out"
    }
  },
  {
    "userId": "c07da2cc-7a64-476e-aa95-be7042332a95",
    "updated": "2021-10-22T13:24:14.245Z",
    "presence": {
      "presenceId": "36054f94-d55f-4382-8132-ecac185c8e4d",
      "selectable": true,
      "category": {
        "categoryType": "Ready",
        "description": "Ready",
		"subCategory": "Ready"
      },
      "description": "Ready"
    }
  }
]

...

  • userId. A user identifier. The user ID is unique within the account.
  • updated. Date and time (UTC) of the last change of user's presence.
  • presence. The presence definition.
    • presenceId.  A presence definition identifier. The presence definition ID is unique within the account.
    • selectableIndicates if this presence has been configured to appear for Agents to select.
    • category. Category of the presence definition.
      • categoryType. Type of presence definition category. Allowed values: LoggedOut, Away, ExtendedAway, Ready
      • description. Description of the presence category. Used for display purposes only.
      • subCategory. Extended type of presence definition category. Possible values:  LoggedOutAwayExtendedAwayReadyReadyForOutbound
    • description. Description of the presence definition. Used for display purposes only.

...