Page Comparison

The GET /presence-definitions gets a list of all the presence definitions

Panel

borderColor	#eeeeee
bgColor	white
titleColor	white
borderWidth	1
titleBGColor	#D6219C
borderStyle	solid
title	In this page

Table of Contents

Insert excerpt

	_ExcerptAPICloudNextGen
	_ExcerptAPICloudNextGen
nopanel	true

Headers

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

Authorization scopes supported:

Scope	Access granted
`users:read`	Entire endpoint
`users:write`	Entire endpoint

Parameters

No parameters other than authorization parameters required.

Requests

Request a list of presence definitions

Code Block

language	powershell
theme	Midnight

curl -L -X GET "https://***.api.newvoicemedia.com/agents/presence-definitions" 
-H "Authorization: Bearer <ACCESS_TOKEN>" 
-H "Accept: application/vnd.newvoicemedia.v1+json"

Responses

Responses to the endpoint returns a list of presence definitions.

Successful response

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

Example response

Presence definitions returned

Code Block

language	js
theme	Midnight

{
  "presenceDefinitions": [
    {
      "presenceId": "4060362d-1ab1-11ec-a0c4-066a9ef411a8",
      "selectable": false,
      "category": {
        "categoryType": "ExtendedAway",
        "description": "Extended Away",
		"subCategory": "ExtendedAway"
      },
      "description": "Extended away"
    },
    {
      "presenceId": "734966bb-e646-46c3-a122-617765e92f89",
      "selectable": true,
      "category": {
        "categoryType": "Ready",
        "description": "Ready",
		"subCategory": "Ready"
      },
      "description": "Ready"
    },
    {
      "presenceId": "501ba176-4f62-4cbd-aa4d-dbaa4ed5411e",
      "selectable": true,
      "category": {
        "categoryType": "Away",
        "description": "Away",
		"subCategory": "Away"
      },
      "description": "Away"
    },
    {
      "presenceId": "6bbbebbd-f160-4d8d-96db-411b755a18a4",
      "selectable": true,
      "category": {
        "categoryType": "Away",
        "description": "Away",
		"subCategory": "Away"
      },
      "description": "Break"
    },
    {
      "presenceId": "399ae1f1-4bb7-4792-9d00-f2aa5889de6a",
      "selectable": true,
      "category": {
        "categoryType": "Away",
        "description": "Away",
		"subCategory": "Away"
      },
      "description": "Comfort Break"
    },
    {
      "presenceId": "10be450a-4a19-4500-a474-67d6967f6c7f",
      "selectable": true,
      "category": {
        "categoryType": "ExtendedAway",
        "description": "Extended Away",
		"subCategory": "ExtendedAway"
      },
      "description": "Paperwork"
    },
    {
      "presenceId": "ee1de097-d0e3-4dce-9976-5958d807c1d6",
      "selectable": true,
      "category": {
        "categoryType": "ExtendedAway",
        "description": "Extended Away",
		"subCategory": "ExtendedAway"
      },
      "description": "Lunch"
    },
    {
      "presenceId": "ef8575b7-accd-4e70-9a9c-7c51fb4d59b6",
      "selectable": true,
      "category": {
        "categoryType": "ExtendedAway",
        "description": "Extended Away",
		"subCategory": "ExtendedAway"
      },
      "description": "Training"
    },
    {
      "presenceId": "a641ac39-a871-496a-9d2e-a86f4d71e25e",
      "selectable": true,
      "category": {
        "categoryType": "ExtendedAway",
        "description": "Extended Away",
		"subCategory": "ExtendedAway"
      },
      "description": "Team Meeting"
    },
    {
      "presenceId": "7af7f36f-bab6-498b-871e-468a4ee8a19a",
      "selectable": true,
      "category": {
        "categoryType": "Ready",
        "description": "Ready",
		"subCategory": "ReadyForOutbound"
      },
      "description": "Ready (Outbound)"
    },
    {
      "presenceId": "1253ee5f-799a-40f4-98d1-3dae65523a1f",
      "selectable": true,
      "category": {
        "categoryType": "LoggedOut",
        "description": "Logged Out",
		"subCategory": "LoggedOut"
      },
      "description": "Logged Out"
    }
  ]
}

where:

presenceDefinitions. Presence definition list.
- 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.
  - subCategory. Extended type of presence definition category. Possible values: LoggedOut, Away, ExtendedAway, Ready, ReadyForOutbound
- description. Description of the presence definition. Used for display purposes only.