participant: startHoldMusic

Namespace: microsoft.graph

Put a participant on hold and play music in the background.

Note: Only one participant can be placed on hold at any given time.


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Not Supported.
Delegated (personal Microsoft account) Not Supported.
Application Calls.JoinGroupCallsasGuest.All or Calls.JoinGroupCalls.All

HTTP request

POST /communications/calls/{id}/participants/{id}/startHoldMusic

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-type application/json. Required.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter Type Description
customPrompt microsoft.graph.mediaPrompt Optional. Audio prompt the participant will hear when placed on hold.
clientContext String Optional. Unique client context string. Can have a maximum of 256 characters.


If successful, this method returns a 202 Accepted response code and a startHoldMusicOperation object in the response body.


The following example shows how to call this API.


The following is an example of a request.

Content-type: application/json

  "customPrompt": {
    "@odata.type": "#microsoft.graph.mediaPrompt",
    "mediaInfo": {
      "@odata.type": "#microsoft.graph.mediaInfo",
      "uri": "",
  "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c",


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

HTTP/1.1 202 Accepted

  "@odata.type": "#microsoft.graph.startHoldMusicOperation",
  "id": "0fe0623f-d628-42ed-b4bd-8ac290072cc5",
  "status": "running",
  "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c"

Notification sent to the application after the startHoldMusicOperation finishes

Content-Type: application/json
  "@odata.type": "#microsoft.graph.commsNotifications",
  "value": [
      "@odata.type": "#microsoft.graph.commsNotification",
      "changeType": "deleted",
      "resourceUrl": "communications/calls/e141b67c-90fd-455d-858b-b48a40b9cc8d/operations/0fe0623f-d628-42ed-b4bd-8ac290072cc5",
      "resourceData": {
        "@odata.type": "#microsoft.graph.startHoldMusicOperation",
        "": "communications/calls/e141b67c-90fd-455d-858b-b48a40b9cc8d/operations/0fe0623f-d628-42ed-b4bd-8ac290072cc5",
        "@odata.etag": "W/\"54451\"",
        "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c",
        "status": "completed"