Skip to content

callsettings-list-delegates.md

Latest commit

 

History

History
236 lines (183 loc) · 7.79 KB

callsettings-list-delegates.md

File metadata and controls

236 lines (183 loc) · 7.79 KB
title List delegates
description Get a list of all delegates for a user.
author garchiro7
ms.date 02/01/2025
ms.localizationpriority medium
ms.subservice cloud-communications
doc_type apiPageType

List delegates

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get a list of all delegates for a user.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

To list all delegates for the signed-in user (/me) or a specific user (/users/{userId}/):

GET /me/communications/callSettings/delegates
GET /users/{userId}/communications/callSettings/delegates

Optional query parameters

This method supports the filter and count OData query parameters to help customize the response. For general information, see OData query parameters.

Scenario Parameter Example
Get the delegates who granted the signed-in user permission to receive calls. $filter GET /me/communications/callSettings/delegates?$filter=allowedActions/receiveCalls eq true
Get the number of delegates configured for the signed-in user. $count GET /me/communications/callSettings/delegates?$count=true

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of delegationSettings objects in the response body.

Examples

Example 1: Get all delegates

The following example shows how to get all delegates for the signed-in user (me).

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/me/communications/callSettings/delegates

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.delegationSettings",
      "id": "62de48e1-a72c-40db-9193-a3bd8cf167c9",
      "createdDateTime": "2025-01-01T00:00:00Z",
      "isActive": true,
      "allowedActions": {
        "@odata.type": "microsoft.graph.delegateAllowedActions",
        "makeCalls": true,
        "receiveCalls": true,
        "manageCallAndDelegateSettings": true,
        "pickUpHeldCalls": true,
        "joinActiveCalls": false
      }
    },
    {
      "@odata.type": "#microsoft.graph.delegationSettings",
      "id": "739cfec7-7956-409a-a1c8-a76daab23c2a",
      "createdDateTime": "2025-02-01T00:00:00Z",
      "isActive": true,
      "allowedActions": {
        "@odata.type": "microsoft.graph.delegateAllowedActions",
        "makeCalls": false,
        "receiveCalls": true,
        "manageCallAndDelegateSettings": true,
        "pickUpHeldCalls": true,
        "joinActiveCalls": false
      }
    }
  ]
}

Example 2: Get all delegates who are able to receive calls

The following example shows how to get all delegates who are able to receive calls.

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/me/communications/callSettings/delegates?filter=allowedActions/receiveCalls eq true

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.delegationSettings",
      "id": "62de48e1-a72c-40db-9193-a3bd8cf167c9",
      "createdDateTime": "2025-01-01T00:00:00Z",
      "isActive": true,
      "allowedActions": {
        "@odata.type": "microsoft.graph.delegateAllowedActions",
        "makeCalls": true,
        "receiveCalls": true,
        "manageCallAndDelegateSettings": true,
        "pickUpHeldCalls": true,
        "joinActiveCalls": false
      }
    }
  ]
}