...
| Panel |
|---|
| borderColor | #eeeeee |
|---|
| bgColor | white |
|---|
| titleColor | white |
|---|
| borderWidth | 1 |
|---|
| titleBGColor | #F79CA6#D6219C |
|---|
| borderStyle | solid |
|---|
| title | In this page |
|---|
|
|
| Insert excerpt |
|---|
| _ExcerptAPICloudNextGen |
|---|
| _ExcerptAPICloudNextGen |
|---|
| nopanel | true |
|---|
|
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
The endpoint accepts the following path parameter:
...
A user identifier. The user ID is unique within the account.
| Tip |
|---|
A user's ID can be obtained via the Users API endpoints. |
Requests
Request the presence of user Id a1ad7163-7526-4eb5-bd16-8516ebd10913
| Code Block |
|---|
| language | powershell |
|---|
| theme | Midnight |
|---|
|
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.
...
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, Readydescription. Description of the presence category. Used for display purposes only.
description. Description of the presence definition. Used for display purposes only.
| Insert excerpt |
|---|
| _ExcerptRunInPostman |
|---|
| _ExcerptRunInPostman |
|---|
| nopanel | true |
|---|
|