Get agent's presence (bulk)

The GET /presences/users endpoint returns the presences of all the users.

Parameters

The endpoint accepts the following query parameter:

userId

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.

Requests

Request current presence for two users

curl -L -X GET "https://***.api.newvoicemedia.com/agents/presences/users?userId=daab05ec-ba50-45af-a6fd-3b01cdc6f39b,c07da2cc-7a64-476e-aa95-be7042332a95" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Accept: application/vnd.newvoicemedia.v1+json"

Responses

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

Successful response

For information about successful responses, see Success response code and parameters in Responses (Agents API).

Example response

Presence returned.

[
  {
    "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"
      },
      "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"
      },
      "description": "Ready"
    }
  }
]

where:

• 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.
  • selectable. Indicates 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.
  • description. Description of the presence definition. Used for display purposes only.