| title | description | author | ms.localizationpriority | ms.subservice | doc_type | ms.date |
|---|---|---|---|---|---|---|
call: playPrompt | Play a prompt in the call. | rahulva-msft | medium | cloud-communications | apiPageType | 04/04/2024 |
Namespace: microsoft.graph
Play a prompt in the call.
For more information about how to handle operations, see commsOperation
Note
The playPrompt action is supported only for calls that are initiated with serviceHostedMediaConfig.
[!INCLUDE national-cloud-support]
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]
Note: Permissions are checked when the call is created; no additional permission check is made when calling this API. Calls.AccessMedia.All is only necessary for calls that use app-hosted media.
POST /communications/calls/{id}/playPrompt| Name | Description |
|---|---|
| Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
In the request body, provide a JSON object with the following parameters.
| Parameter | Type | Description |
|---|---|---|
| prompts | MediaPrompt collection | The prompts to be played. The maximum supported MediaPrompt collection size is 20. |
| clientContext | String | Unique client context string. Can have a maximum of 256 characters. |
If successful, this method returns a 200 OK response code and a playPromptOperation object in the response body.
The following example shows how to call this API.
The following example shows the request.
POST https://graph.microsoft.com/v1.0/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/playPromptContent-Type: application/jsonContent-Length: 166 { "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c", "prompts": [ { "@odata.type": "#microsoft.graph.mediaPrompt", "mediaInfo": { "@odata.type": "#microsoft.graph.mediaInfo", "uri": "https://cdn.contoso.com/beep.wav", "resourceId": "1D6DE2D4-CD51-4309-8DAA-70768651088E" } } ] }[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OKLocation: https://graph.microsoft.com/v1.0/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/operations/0fe0623f-d628-42ed-b4bd-8ac290072cc5Content-Type: application/json { "@odata.type": "#microsoft.graph.playPromptOperation", "id": "0fe0623f-d628-42ed-b4bd-8ac290072cc5", "status": "running", "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c" } POST https://bot.contoso.com/api/callsContent-Type: application/json{ "@odata.type": "#microsoft.graph.commsNotifications", "value": [ { "@odata.type": "#microsoft.graph.commsNotification", "changeType": "deleted", "resourceUrl": "/communications/calls/57DAB8B1894C409AB240BD8BEAE78896/operations/0FE0623FD62842EDB4BD8AC290072CC5", "resourceData": { "@odata.type": "#microsoft.graph.playPromptOperation", "@odata.id": "/communications/calls/57DAB8B1894C409AB240BD8BEAE78896/operations/0FE0623FD62842EDB4BD8AC290072CC5", "@odata.etag": "W/\"54451\"", "resultInfo": { "@odata.type": "#microsoft.graph.resultInfo", "code": 200, "subcode": 0, "message": "Action completed successfully." }, "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c", "status": "completed" } } ] }