Get agent's presence

The GET /{userId}/presence endpoint gets the presence of the user matching the user ID provided.

Headers

Header parameters in Requests (Agents API) apply to this endpoint.

Authorization scopes supported:

Parameters

The endpoint accepts the following path parameter:

userId

A user identifier. The user ID is unique within the account.

Requests

Request the presence of user Id a1ad7163-7526-4eb5-bd16-8516ebd10913

curl -L -X GET "https://***.api.newvoicemedia.com/agents/daab05ec-ba50-45af-a6fd-3b01cdc6f39b/presence" 
-H "Authorization: Bearer <ACCESS_TOKEN>" 
-H "Accept: application/vnd.newvoicemedia.v1+json"

Responses

Responses to the endpoint returns the presence of the specified user.

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"
  }
}

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. Possible 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.