diff --git a/cSpell.json b/cSpell.json
index 3c13ce136de4..5930b5275bdd 100644
--- a/cSpell.json
+++ b/cSpell.json
@@ -291,38 +291,38 @@
"freemium"
]
},
- {
+ {
"filename": "**/specification/sql/resource-manager/Microsoft.Sql/preview/2023-02-01-preview/ManagedInstances.json",
"words": [
"freemium"
]
},
- {
+ {
"filename": "**/specification/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/ManagedInstances.json",
"words": [
"freemium"
]
},
- {
+ {
"filename": "**/specification/sql/resource-manager/Microsoft.Sql/preview/2023-08-01-preview/ManagedInstances.json",
"words": [
"freemium"
]
},
- {
+ {
"filename": "**/specification/sql/resource-manager/Microsoft.Sql/preview/2023-08-01-preview/ServerTrustCertificates.json",
"words": [
"freemium"
]
},
- {
+ {
"filename": "**/specification/sql/resource-manager/Microsoft.Sql/preview/2023-08-01-preview/ManagedInstanceDtcs.json",
"words": [
"msdtcdns",
"msdtc's"
]
},
- {
+ {
"filename": "**/specification/sql/resource-manager/Microsoft.Sql/preview/2023-08-01-preview/TimeZones.json",
"words": [
"freemium"
@@ -505,7 +505,7 @@
"Idms",
"Cluter",
"Mfamily",
- "Datacentre"
+ "Datacentre"
]
},
{
@@ -1183,7 +1183,7 @@
{
"filename": "**/specification/containerservice/resource-manager/Microsoft.ContainerService/**/*.json",
"words": [
- "containerd"
+ "containerd"
]
},
@@ -1225,8 +1225,8 @@
]
},
{
- "filename": "**/specification/confidentialledger/data-plane/Microsoft.CodeTransparency/preview/**/*.json",
- "words": [
+ "filename": "**/specification/confidentialledger/data-plane/Microsoft.CodeTransparency/preview/**/*.json",
+ "words": [
"cbor",
"txids",
"operationid",
@@ -1254,8 +1254,8 @@
{
"filename": "**/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/**/*.json",
"words": [
- "WUMU",
- "WSUS"
+ "WUMU",
+ "WSUS"
]
},
{
@@ -1289,6 +1289,14 @@
"words": [
"rerank"
]
+ },
+ {
+ "filename": "**/specification/communication/data-plane/CallAutomation/**/*.json",
+ "words": [
+ "unhold",
+ "Unhold",
+ "transferor's"
+ ]
}
],
"enableFiletypes": [
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json
new file mode 100644
index 000000000000..d57df1a6a778
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json
@@ -0,0 +1,4272 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2024-06-15-preview",
+ "title": "Azure Communication Service Call Automation APIs",
+ "description": "Azure Communication Service Call Automation APIs"
+ },
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/calling/callConnections": {
+ "post": {
+ "tags": [
+ "PreConnections"
+ ],
+ "summary": "Create an outbound call.",
+ "description": "Create an outbound call.",
+ "operationId": "CreateCall",
+ "parameters": [
+ {
+ "name": "createCallRequest",
+ "in": "body",
+ "description": "The create call request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CreateCallRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "Repeatability-Request-ID",
+ "in": "header",
+ "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.",
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "Repeatability-First-Sent",
+ "in": "header",
+ "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.",
+ "type": "string",
+ "format": "date-time-rfc1123"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "201": {
+ "description": "Returns details of the call properties once the CreateCall request is received by service. You will receive CallConnected event at your specified callback URI, once the call is connected.",
+ "schema": {
+ "$ref": "#/definitions/CallConnectionProperties"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CreateCall": {
+ "$ref": "./examples/CreateCall.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections:answer": {
+ "post": {
+ "tags": [
+ "PreConnections"
+ ],
+ "summary": "Answer a Call.",
+ "description": "Answer a call using the IncomingCallContext from Event Grid.",
+ "operationId": "AnswerCall",
+ "parameters": [
+ {
+ "name": "answerCallRequest",
+ "in": "body",
+ "description": "The answer call request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AnswerCallRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "Repeatability-Request-ID",
+ "in": "header",
+ "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.",
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "Repeatability-First-Sent",
+ "in": "header",
+ "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.",
+ "type": "string",
+ "format": "date-time-rfc1123"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "200": {
+ "description": "Returns details of the call properties once the AnswerCall request is received by service. You will receive CallConnected event at your specified callback URI, once the call is connected.",
+ "schema": {
+ "$ref": "#/definitions/CallConnectionProperties"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "AnswerCall": {
+ "$ref": "./examples/AnswerCall.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections:redirect": {
+ "post": {
+ "tags": [
+ "PreConnections"
+ ],
+ "summary": "Redirect a call.",
+ "description": "Redirect a call.",
+ "operationId": "RedirectCall",
+ "parameters": [
+ {
+ "name": "redirectCallRequest",
+ "in": "body",
+ "description": "The redirect call request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RedirectCallRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "Repeatability-Request-ID",
+ "in": "header",
+ "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.",
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "Repeatability-First-Sent",
+ "in": "header",
+ "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.",
+ "type": "string",
+ "format": "date-time-rfc1123"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "204": {
+ "description": "The service has redirected the call to specified endpoint."
+ }
+ },
+ "x-ms-examples": {
+ "RedirectCall": {
+ "$ref": "./examples/RedirectCall.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections:reject": {
+ "post": {
+ "tags": [
+ "PreConnections"
+ ],
+ "summary": "Reject the call.",
+ "description": "Reject the call.",
+ "operationId": "RejectCall",
+ "parameters": [
+ {
+ "name": "rejectCallRequest",
+ "in": "body",
+ "description": "The reject call request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RejectCallRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "Repeatability-Request-ID",
+ "in": "header",
+ "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.",
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "Repeatability-First-Sent",
+ "in": "header",
+ "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.",
+ "type": "string",
+ "format": "date-time-rfc1123"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "204": {
+ "description": "The service has rejected the call."
+ }
+ },
+ "x-ms-examples": {
+ "RejectCall": {
+ "$ref": "./examples/RejectCall.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections:connect": {
+ "post": {
+ "tags": [
+ "PreConnections"
+ ],
+ "summary": "Create a Connection to a CallLocator.",
+ "description": "Create a connection to a CallLocator.",
+ "operationId": "Connect",
+ "parameters": [
+ {
+ "name": "connectRequest",
+ "in": "body",
+ "description": "The create connection request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ConnectRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "Repeatability-Request-ID",
+ "in": "header",
+ "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.",
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "Repeatability-First-Sent",
+ "in": "header",
+ "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.",
+ "type": "string",
+ "format": "date-time-rfc1123"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "200": {
+ "description": "Returns connection to a callLocator",
+ "schema": {
+ "$ref": "#/definitions/CallConnectionProperties"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Connect": {
+ "$ref": "./examples/Connect.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}": {
+ "get": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Get the detail properties of an ongoing call.",
+ "operationId": "CallConnection_GetCall",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "200": {
+ "description": "Returns details of the call properties.",
+ "schema": {
+ "$ref": "#/definitions/CallConnectionProperties"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CallConnection_GetCall": {
+ "$ref": "./examples/CallConnection_GetCall.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Hang up call automation service from the call. This will make call automation service leave the call, but does not terminate if there are more than 1 caller in the call.",
+ "description": "Hang up call automation service from the call. This will make call automation service leave the call, but does not terminate if there are more than 1 caller in the call.",
+ "operationId": "CallConnection_HangupCall",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "204": {
+ "description": "Call automation service has left the call."
+ }
+ },
+ "x-ms-examples": {
+ "CallConnection_HangupCall": {
+ "$ref": "./examples/CallConnection_HangupCall.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}:terminate": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Terminate a call using CallConnectionId.",
+ "description": "Terminate a call using CallConnectionId.",
+ "operationId": "CallConnection_TerminateCall",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The terminate call request.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "Repeatability-Request-ID",
+ "in": "header",
+ "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.",
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "Repeatability-First-Sent",
+ "in": "header",
+ "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.",
+ "type": "string",
+ "format": "date-time-rfc1123"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "204": {
+ "description": "The call is terminated."
+ }
+ },
+ "x-ms-examples": {
+ "CallConnection_TerminateCall": {
+ "$ref": "./examples/CallConnection_TerminateCall.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}:transferToParticipant": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Transfer the call to a participant.",
+ "description": "Transfer the call to a participant.",
+ "operationId": "CallConnection_TransferToParticipant",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "transferToParticipantRequest",
+ "in": "body",
+ "description": "The transfer to participant request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TransferToParticipantRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "Repeatability-Request-ID",
+ "in": "header",
+ "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.",
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "Repeatability-First-Sent",
+ "in": "header",
+ "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.",
+ "type": "string",
+ "format": "date-time-rfc1123"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "202": {
+ "description": "The service has accepted the transfer request and will begin processing it. You will receive either CallTransferAccepted or CallTransferFailed event at your specified callback URI to update you on the status of the request.",
+ "schema": {
+ "$ref": "#/definitions/TransferCallResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CallConnection_TransferToParticipant": {
+ "$ref": "./examples/CallConnection_TransferToParticipant.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}:play": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Plays audio to participants in the call.",
+ "description": "Plays audio to participants in the call.",
+ "operationId": "CallMedia_Play",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "playRequest",
+ "in": "body",
+ "description": "play request payload.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PlayRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "202": {
+ "description": "The service has accepted the play request and will begin processing it. You will receive either PlayCompleted or PlayFailed event at your specified callback URI to update you on the status of the request."
+ }
+ },
+ "x-ms-examples": {
+ "CallMedia_Play": {
+ "$ref": "./examples/CallMedia_Play.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}:startTranscription": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Starts transcription in the call",
+ "description": "Starts transcription in the call",
+ "operationId": "CallMedia_StartTranscription",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "startTranscriptionRequest",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StartTranscriptionRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "202": {
+ "description": "The service has accepted the start transcription request and will begin processing it. You will receive either TranscriptionStarted or TranscriptionFailed event at your specified callback URI to update you on the status of the request."
+ }
+ },
+ "x-ms-examples": {
+ "CallMedia_StartTranscription": {
+ "$ref": "./examples/CallMedia_StartTranscription.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}:stopTranscription": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Stops transcription in the call.",
+ "description": "Stops transcription in the call.",
+ "operationId": "CallMedia_StopTranscription",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "stopTranscriptionRequest",
+ "in": "body",
+ "description": "stop transcription request payload.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StopTranscriptionRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "202": {
+ "description": "The service has accepted the stop transcription request and will begin processing it. You will receive either TranscriptionStopped event at your specified callback URI to update you on the status of the request."
+ }
+ },
+ "x-ms-examples": {
+ "CallMedia_StopTranscription": {
+ "$ref": "./examples/CallMedia_StopTranscription.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}:updateTranscription": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "UpdateTranscription Api.",
+ "description": "API to change transcription language.",
+ "operationId": "CallMedia_UpdateTranscription",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "updateTranscriptionRequest",
+ "in": "body",
+ "description": "The UpdateTranscription request",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/UpdateTranscriptionRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "202": {
+ "description": "Returns the update transcription response"
+ }
+ },
+ "x-ms-examples": {
+ "CallMedia_UpdateTranscription": {
+ "$ref": "./examples/CallMedia_UpdateTranscription.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}:cancelAllMediaOperations": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Cancel all media operations in a call.",
+ "description": "Cancel all media operations in a call.",
+ "operationId": "CallMedia_CancelAllMediaOperations",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "202": {
+ "description": "The service has accepted the cancel request and will begin processing it. You will receive the RecognizeCanceled and/or PlayCanceled event at your specified callback URI to update you on the status of the request, based on which media operation has been canceled by it."
+ }
+ },
+ "x-ms-examples": {
+ "CallMedia_CancelAllMediaOperations": {
+ "$ref": "./examples/CallMedia_CancelAllMediaOperations.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}:recognize": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Recognize media from call.",
+ "description": "Recognize media from call.",
+ "operationId": "CallMedia_Recognize",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "recognizeRequest",
+ "in": "body",
+ "description": "The media recognize request",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RecognizeRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "202": {
+ "description": "The service has accepted the recognize request and will begin processing it. You will receive either RecognizeCompleted or RecognizeFailed event at your specified callback URI to update you on the status of the request."
+ }
+ },
+ "x-ms-examples": {
+ "CallMedia_Recognize": {
+ "$ref": "./examples/CallMedia_Recognize.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}:startContinuousDtmfRecognition": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Start continuous Dtmf recognition by subscribing to tones.",
+ "operationId": "CallMedia_StartContinuousDtmfRecognition",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "continuousDtmfRecognitionRequest",
+ "in": "body",
+ "description": "The continuous recognize request",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ContinuousDtmfRecognitionRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "200": {
+ "description": "The service has started continuous dtmf recognition. You will receive either the ContinuousDtmfRecognitionToneReceived, ContinuousDtmfRecognitionToneFailed or ContinuousDtmfRecognitionStopped event at your specified callback URI. Continuous dtmf recognition can run in parallel with other media operations. For example if the Recognize operation is also active and a dtmf is detected, both ContinuousDtmfRecognitionToneReceived and RecognizeCompleted events will be received."
+ }
+ },
+ "x-ms-examples": {
+ "CallMedia_StartContinuousDtmfRecognition": {
+ "$ref": "./examples/CallMedia_StartContinuousDtmfRecognition.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}:stopContinuousDtmfRecognition": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Stop continuous Dtmf recognition by unsubscribing to tones.",
+ "operationId": "CallMedia_StopContinuousDtmfRecognition",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "continuousDtmfRecognitionRequest",
+ "in": "body",
+ "description": "The continuous recognize request",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ContinuousDtmfRecognitionRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "200": {
+ "description": "The service has stopped continuous dtmf recognition. If continuous dtmf recognition was previously started, you will receive the ContinuousDtmfRecognitionStopped event at your specified callback URI."
+ }
+ },
+ "x-ms-examples": {
+ "CallMedia_StopContinuousDtmfRecognition": {
+ "$ref": "./examples/CallMedia_StopContinuousDtmfRecognition.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}:sendDtmfTones": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Send dtmf tones.",
+ "description": "Send dtmf tones.",
+ "operationId": "CallMedia_SendDtmfTones",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "sendDtmfTonesRequest",
+ "in": "body",
+ "description": "The send dtmf tones request",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SendDtmfTonesRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "Repeatability-Request-ID",
+ "in": "header",
+ "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.",
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "Repeatability-First-Sent",
+ "in": "header",
+ "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.",
+ "type": "string",
+ "format": "date-time-rfc1123"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "202": {
+ "description": "The service has accepted the send dtmf tones request and will begin processing it. You will receive either the SendDtmfTonesCompleted or the SendDtmfTonesFailed event at your specified callback URI to update you on the status of the request.",
+ "schema": {
+ "$ref": "#/definitions/SendDtmfTonesResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CallMedia_SendDtmfTones": {
+ "$ref": "./examples/CallMedia_SendDtmfTones.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}:hold": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Hold participant from the call using identifier.",
+ "description": "Hold participant from the call using identifier.",
+ "operationId": "CallMedia_Hold",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "holdRequest",
+ "in": "body",
+ "description": "The participants to be hold from the call.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/HoldRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "200": {
+ "description": "Returns the hold participant response"
+ }
+ },
+ "x-ms-examples": {
+ "CallMedia_Hold": {
+ "$ref": "./examples/CallMedia_Hold.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}:unhold": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Unhold participants from the call using identifier.",
+ "description": "Unhold participants from the call using identifier.",
+ "operationId": "CallMedia_Unhold",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "unholdRequest",
+ "in": "body",
+ "description": "The participants to be hold from the call.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/UnholdRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "200": {
+ "description": "Returns the unhold participant response"
+ }
+ },
+ "x-ms-examples": {
+ "CallMedia_Unhold": {
+ "$ref": "./examples/CallMedia_Unhold.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}:startMediaStreaming": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Starts media streaming in the call",
+ "description": "Starts media streaming in the call.",
+ "operationId": "CallMedia_StartMediaStreaming",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "startMediaStreamingRequest",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StartMediaStreamingRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "202": {
+ "description": "The service has accepted the start media streaming request and will begin processing it. You will receive either MediaStreamingStarted or MediaStreamingFailed event at your specified callback URI to update you on the status of the request."
+ }
+ },
+ "x-ms-examples": {
+ "CallMedia_StartMediaStreaming": {
+ "$ref": "./examples/CallMedia_StartMediaStreaming.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}:stopMediaStreaming": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Stops media streaming in the call",
+ "description": "Stops media streaming in the call.",
+ "operationId": "CallMedia_StopMediaStreaming",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "stopMediaStreamingRequest",
+ "in": "body",
+ "description": "stop media streaming request payload.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StopMediaStreamingRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "202": {
+ "description": "The service has accepted the stop media streaming request and will begin processing it. You will receive either MediaStreamingStopped or MediaStreamingFailed event at your specified callback URI to update you on the status of the request."
+ }
+ },
+ "x-ms-examples": {
+ "CallMedia_StopMediaStreaming": {
+ "$ref": "./examples/CallMedia_StopMediaStreaming.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}/participants": {
+ "get": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Get participants from a call. Recording and transcription bots are omitted from this list.",
+ "description": "Get participants from a call. Recording and transcription bots are omitted from this list.",
+ "operationId": "CallConnection_GetParticipants",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection Id",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "200": {
+ "description": "Returns the get participants response.",
+ "schema": {
+ "$ref": "#/definitions/GetParticipantsResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CallConnection_GetParticipants": {
+ "$ref": "./examples/CallConnection_GetParticipants.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink",
+ "itemName": "value"
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}/participants:add": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Add a participant to the call.",
+ "description": "Add a participant to the call.",
+ "operationId": "CallConnection_AddParticipant",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection Id",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "addParticipantRequest",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AddParticipantRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "Repeatability-Request-ID",
+ "in": "header",
+ "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.",
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "Repeatability-First-Sent",
+ "in": "header",
+ "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.",
+ "type": "string",
+ "format": "date-time-rfc1123"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "202": {
+ "description": "The service has accepted the add participant request and will begin processing it. You will receive either AddParticipantSucceeded or AddParticipantFailed event at your specified callback URI to update you on the status of the request.",
+ "schema": {
+ "$ref": "#/definitions/AddParticipantResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CallConnection_AddParticipant": {
+ "$ref": "./examples/CallConnection_AddParticipant.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}/participants:remove": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Remove a participant from the call using identifier.",
+ "description": "Remove a participant from the call using identifier.",
+ "operationId": "CallConnection_RemoveParticipant",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "removeParticipantRequest",
+ "in": "body",
+ "description": "The participant to be removed from the call.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RemoveParticipantRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "Repeatability-Request-ID",
+ "in": "header",
+ "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.",
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "Repeatability-First-Sent",
+ "in": "header",
+ "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.",
+ "type": "string",
+ "format": "date-time-rfc1123"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "202": {
+ "description": "The service has accepted the remove participant request and will begin processing it. You will receive either RemoveParticipantSucceeded or RemoveParticipantFailed event at your specified callback URI to update you on the status of the request.",
+ "schema": {
+ "$ref": "#/definitions/RemoveParticipantResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CallConnection_RemoveParticipant": {
+ "$ref": "./examples/CallConnection_RemoveParticipant.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}/participants:mute": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Mute participants from the call using identifier.",
+ "description": "Mute participants from the call using identifier.",
+ "operationId": "CallConnection_Mute",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection id.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "muteParticipantsRequest",
+ "in": "body",
+ "description": "The participants to be muted from the call.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/MuteParticipantsRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "Repeatability-Request-ID",
+ "in": "header",
+ "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.",
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "Repeatability-First-Sent",
+ "in": "header",
+ "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.",
+ "type": "string",
+ "format": "date-time-rfc1123"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "200": {
+ "description": "Returns the mute participants response",
+ "schema": {
+ "$ref": "#/definitions/MuteParticipantsResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CallConnection_Mute": {
+ "$ref": "./examples/CallConnection_Mute.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}/participants:cancelAddParticipant": {
+ "post": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Cancel add participant operation.",
+ "description": "Cancel add participant operation.",
+ "operationId": "CallConnection_CancelAddParticipant",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection Id",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "cancelAddParticipantRequest",
+ "in": "body",
+ "description": "Cancellation request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CancelAddParticipantRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "Repeatability-Request-ID",
+ "in": "header",
+ "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.",
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "Repeatability-First-Sent",
+ "in": "header",
+ "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.",
+ "type": "string",
+ "format": "date-time-rfc1123"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "202": {
+ "description": "Returns the cancelAddParticipant response",
+ "schema": {
+ "$ref": "#/definitions/CancelAddParticipantResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CallConnection_CancelAddParticipant": {
+ "$ref": "./examples/CallConnection_CancelAddParticipant.json"
+ }
+ }
+ }
+ },
+ "/calling/callConnections/{callConnectionId}/participants/{participantRawId}": {
+ "get": {
+ "tags": [
+ "MidConnections"
+ ],
+ "summary": "Get participant from a call.",
+ "description": "Get participant from a call.",
+ "operationId": "CallConnection_GetParticipant",
+ "parameters": [
+ {
+ "name": "callConnectionId",
+ "in": "path",
+ "description": "The call connection Id",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "participantRawId",
+ "in": "path",
+ "description": "Raw id of the participant to retrieve.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "200": {
+ "description": "Returns the detail of the requested participant.",
+ "schema": {
+ "$ref": "#/definitions/CallParticipant"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CallConnection_GetParticipant": {
+ "$ref": "./examples/CallConnection_GetParticipant.json"
+ }
+ }
+ }
+ },
+ "/calling/recordings": {
+ "post": {
+ "tags": [
+ "Recording"
+ ],
+ "summary": "Start recording the call.",
+ "operationId": "CallRecording_StartRecording",
+ "parameters": [
+ {
+ "name": "startCallRecording",
+ "in": "body",
+ "description": "The request body of start call recording request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StartCallRecordingRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "Repeatability-Request-ID",
+ "in": "header",
+ "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.",
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "name": "Repeatability-First-Sent",
+ "in": "header",
+ "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.",
+ "type": "string",
+ "format": "date-time-rfc1123"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "200": {
+ "description": "Returns the start call recording response.",
+ "schema": {
+ "$ref": "#/definitions/RecordingStateResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CallRecording_StartRecording": {
+ "$ref": "./examples/CallRecording_StartRecording.json"
+ }
+ }
+ }
+ },
+ "/calling/recordings/{recordingId}": {
+ "get": {
+ "tags": [
+ "Recording"
+ ],
+ "summary": "Get call recording properties.",
+ "operationId": "CallRecording_GetRecordingProperties",
+ "parameters": [
+ {
+ "name": "recordingId",
+ "in": "path",
+ "description": "The recording id.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "200": {
+ "description": "Returns the recording properties.",
+ "schema": {
+ "$ref": "#/definitions/RecordingStateResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CallRecording_GetRecordingProperties": {
+ "$ref": "./examples/CallRecording_GetRecordingProperties.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Recording"
+ ],
+ "summary": "Stop recording the call.",
+ "operationId": "CallRecording_StopRecording",
+ "parameters": [
+ {
+ "name": "recordingId",
+ "in": "path",
+ "description": "The recording id.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "204": {
+ "description": "Returns the stop call recording response."
+ }
+ },
+ "x-ms-examples": {
+ "CallRecording_StopRecording": {
+ "$ref": "./examples/CallRecording_StopRecording.json"
+ }
+ }
+ }
+ },
+ "/calling/recordings/{recordingId}:pause": {
+ "post": {
+ "tags": [
+ "Recording"
+ ],
+ "summary": "Pause recording the call.",
+ "operationId": "CallRecording_PauseRecording",
+ "parameters": [
+ {
+ "name": "recordingId",
+ "in": "path",
+ "description": "The recording id.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "202": {
+ "description": "The service has accepted the pause request and will begin processing it."
+ }
+ },
+ "x-ms-examples": {
+ "CallRecording_PauseRecording": {
+ "$ref": "./examples/CallRecording_PauseRecording.json"
+ }
+ }
+ }
+ },
+ "/calling/recordings/{recordingId}:resume": {
+ "post": {
+ "tags": [
+ "Recording"
+ ],
+ "summary": "Resume recording the call.",
+ "operationId": "CallRecording_ResumeRecording",
+ "parameters": [
+ {
+ "name": "recordingId",
+ "in": "path",
+ "description": "The recording id.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "#/definitions/CommunicationErrorResponse"
+ }
+ },
+ "202": {
+ "description": "The service has accepted the resume request and will begin processing it."
+ }
+ },
+ "x-ms-examples": {
+ "CallRecording_ResumeRecording": {
+ "$ref": "./examples/CallRecording_ResumeRecording.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "CreateCallRequest": {
+ "description": "The request payload for creating the call.",
+ "required": [
+ "targets",
+ "callbackUri"
+ ],
+ "type": "object",
+ "properties": {
+ "targets": {
+ "description": "The targets of the call.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CommunicationIdentifierModel"
+ }
+ },
+ "sourceCallerIdNumber": {
+ "$ref": "#/definitions/PhoneNumberIdentifierModel",
+ "description": "The source caller Id, a phone number, that's shown to the PSTN participant being invited.\r\nRequired only when calling a PSTN callee."
+ },
+ "sourceDisplayName": {
+ "description": "Display name of the call if dialing out to a pstn number",
+ "type": "string"
+ },
+ "source": {
+ "$ref": "#/definitions/CommunicationUserIdentifierModel",
+ "description": "The identifier of the source of the call"
+ },
+ "operationContext": {
+ "description": "A customer set value used to track the answering of a call.",
+ "type": "string"
+ },
+ "callbackUri": {
+ "description": "The callback URI.",
+ "type": "string"
+ },
+ "callIntelligenceOptions": {
+ "$ref": "#/definitions/CallIntelligenceOptions",
+ "description": "AI options for the call."
+ },
+ "mediaStreamingOptions": {
+ "$ref": "#/definitions/MediaStreamingOptions",
+ "description": "Media Streaming Options."
+ },
+ "transcriptionOptions": {
+ "$ref": "#/definitions/TranscriptionOptions",
+ "description": "Transcription Options."
+ }
+ }
+ },
+ "CommunicationIdentifierModel": {
+ "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel"
+ },
+ "PhoneNumberIdentifierModel": {
+ "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/PhoneNumberIdentifierModel"
+ },
+ "CommunicationUserIdentifierModel": {
+ "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationUserIdentifierModel"
+ },
+ "CallIntelligenceOptions": {
+ "description": "AI options for the call.",
+ "type": "object",
+ "properties": {
+ "cognitiveServicesEndpoint": {
+ "description": "The identifier of the Cognitive Service resource assigned to this call.",
+ "type": "string"
+ }
+ }
+ },
+ "MediaStreamingTransportType": {
+ "description": "The type of transport to be used for media streaming, eg. Websocket",
+ "enum": [
+ "websocket"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MediaStreamingTransportType",
+ "modelAsString": true
+ }
+ },
+ "MediaStreamingContentType": {
+ "description": "Content type to stream, eg. audio",
+ "enum": [
+ "audio"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MediaStreamingContentType",
+ "modelAsString": true
+ }
+ },
+ "MediaStreamingAudioChannelType": {
+ "description": "Audio channel type to stream, eg. unmixed audio, mixed audio",
+ "enum": [
+ "mixed",
+ "unmixed"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MediaStreamingAudioChannelType",
+ "modelAsString": true
+ }
+ },
+ "MediaStreamingOptions": {
+ "description": "Configuration of Media streaming.",
+ "required": [
+ "transportUrl",
+ "transportType",
+ "contentType",
+ "audioChannelType"
+ ],
+ "type": "object",
+ "properties": {
+ "transportUrl": {
+ "description": "Transport URL for media streaming",
+ "type": "string"
+ },
+ "transportType": {
+ "$ref": "#/definitions/MediaStreamingTransportType"
+ },
+ "contentType": {
+ "$ref": "#/definitions/MediaStreamingContentType"
+ },
+ "audioChannelType": {
+ "$ref": "#/definitions/MediaStreamingAudioChannelType"
+ },
+ "startMediaStreaming": {
+ "description": "Determines if the media streaming should be started immediately after call is answered or not.",
+ "type": "boolean"
+ }
+ }
+ },
+ "TranscriptionTransportType": {
+ "description": "The type of transport to be used for live transcription, eg. Websocket",
+ "enum": [
+ "websocket"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TranscriptionTransportType",
+ "modelAsString": true
+ }
+ },
+ "TranscriptionOptions": {
+ "description": "Configuration of live transcription.",
+ "required": [
+ "transportUrl",
+ "transportType",
+ "locale",
+ "startTranscription"
+ ],
+ "type": "object",
+ "properties": {
+ "transportUrl": {
+ "description": "Transport URL for live transcription",
+ "type": "string"
+ },
+ "transportType": {
+ "$ref": "#/definitions/TranscriptionTransportType"
+ },
+ "locale": {
+ "description": "Defines the locale for the data e.g en-CA, en-AU",
+ "type": "string"
+ },
+ "speechRecognitionModelEndpointId": {
+ "description": "Endpoint where the custom model was deployed.",
+ "type": "string"
+ },
+ "startTranscription": {
+ "description": "Determines if the transcription should be started immediately after call is answered or not.",
+ "type": "boolean"
+ },
+ "enableIntermediateResults": {
+ "description": "Enables intermediate results for the transcribed speech.",
+ "type": "boolean"
+ }
+ }
+ },
+ "MicrosoftTeamsUserIdentifierModel": {
+ "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/MicrosoftTeamsUserIdentifierModel"
+ },
+ "MicrosoftTeamsAppIdentifierModel": {
+ "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/MicrosoftTeamsAppIdentifierModel"
+ },
+ "CommunicationErrorResponse": {
+ "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationErrorResponse"
+ },
+ "CallConnectionStateModel": {
+ "description": "The state of the call connection.",
+ "enum": [
+ "unknown",
+ "connecting",
+ "connected",
+ "transferring",
+ "transferAccepted",
+ "disconnecting",
+ "disconnected"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CallConnectionStateModel",
+ "modelAsString": true
+ }
+ },
+ "CallConnectionProperties": {
+ "description": "Properties of a call connection",
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "The call connection id.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "The server call id.",
+ "type": "string"
+ },
+ "targets": {
+ "description": "The targets of the call.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CommunicationIdentifierModel"
+ }
+ },
+ "callConnectionState": {
+ "$ref": "#/definitions/CallConnectionStateModel"
+ },
+ "callbackUri": {
+ "description": "The callback URI.",
+ "type": "string"
+ },
+ "sourceCallerIdNumber": {
+ "$ref": "#/definitions/PhoneNumberIdentifierModel",
+ "description": "The source caller Id, a phone number, that's shown to the PSTN participant being invited.\r\nRequired only when calling a PSTN callee."
+ },
+ "sourceDisplayName": {
+ "description": "Display name of the call if dialing out to a pstn number.",
+ "type": "string"
+ },
+ "source": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "Source identity."
+ },
+ "correlationId": {
+ "description": "The correlation ID.",
+ "type": "string"
+ },
+ "answeredBy": {
+ "$ref": "#/definitions/CommunicationUserIdentifierModel",
+ "description": "Identity of the answering entity. Only populated when identity is provided in the request."
+ },
+ "mediaStreamingSubscription": {
+ "$ref": "#/definitions/MediaStreamingSubscription",
+ "description": "The state of media streaming subscription for the call"
+ },
+ "transcriptionSubscription": {
+ "$ref": "#/definitions/TranscriptionSubscription",
+ "description": "Transcription Subscription."
+ },
+ "answeredFor": {
+ "$ref": "#/definitions/PhoneNumberIdentifierModel",
+ "description": "Identity of the original Pstn target of an incoming Call. Only populated when the original target is a Pstn number."
+ }
+ }
+ },
+ "MediaStreamingSubscriptionState": {
+ "description": "Media streaming subscription state.",
+ "enum": [
+ "disabled",
+ "inactive",
+ "active"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MediaStreamingSubscriptionState",
+ "modelAsString": true
+ }
+ },
+ "MediaStreamingSubscription": {
+ "description": "Media streaming Subscription Object.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Subscription Id.",
+ "type": "string"
+ },
+ "state": {
+ "$ref": "#/definitions/MediaStreamingSubscriptionState"
+ },
+ "subscribedContentTypes": {
+ "description": "Subscribed media streaming content types.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MediaStreamingContentType"
+ }
+ }
+ }
+ },
+ "TranscriptionSubscriptionState": {
+ "description": "Transcription subscription state.",
+ "enum": [
+ "disabled",
+ "inactive",
+ "active"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TranscriptionSubscriptionState",
+ "modelAsString": true
+ }
+ },
+ "TranscriptionResultType": {
+ "enum": [
+ "final",
+ "intermediate"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TranscriptionResultType",
+ "modelAsString": true
+ }
+ },
+ "TranscriptionSubscription": {
+ "description": "Transcription Subscription Object.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Subscription Id.",
+ "type": "string"
+ },
+ "state": {
+ "$ref": "#/definitions/TranscriptionSubscriptionState"
+ },
+ "subscribedResultTypes": {
+ "description": "Subscribed transcription result types.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TranscriptionResultType"
+ }
+ }
+ }
+ },
+ "AnswerCallRequest": {
+ "description": "The request payload for answering the call.",
+ "required": [
+ "incomingCallContext",
+ "callbackUri"
+ ],
+ "type": "object",
+ "properties": {
+ "incomingCallContext": {
+ "description": "The context associated with the call.",
+ "type": "string"
+ },
+ "callbackUri": {
+ "description": "The callback uri.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "A customer set value used to track the answering of a call.",
+ "type": "string"
+ },
+ "callIntelligenceOptions": {
+ "$ref": "#/definitions/CallIntelligenceOptions",
+ "description": "AI options for the call."
+ },
+ "answeredBy": {
+ "$ref": "#/definitions/CommunicationUserIdentifierModel",
+ "description": "The identifier of the call automation entity which answers the call"
+ },
+ "mediaStreamingOptions": {
+ "$ref": "#/definitions/MediaStreamingOptions",
+ "description": "Media Streaming Options."
+ },
+ "transcriptionOptions": {
+ "$ref": "#/definitions/TranscriptionOptions",
+ "description": "Transcription Options."
+ }
+ }
+ },
+ "RedirectCallRequest": {
+ "description": "The request payload for redirecting the call.",
+ "required": [
+ "incomingCallContext",
+ "target"
+ ],
+ "type": "object",
+ "properties": {
+ "incomingCallContext": {
+ "description": "The context associated with the call.",
+ "type": "string"
+ },
+ "target": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "The target identity to redirect the call to."
+ }
+ }
+ },
+ "CallRejectReason": {
+ "description": "The rejection reason.",
+ "enum": [
+ "none",
+ "busy",
+ "forbidden"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CallRejectReason",
+ "modelAsString": true
+ }
+ },
+ "RejectCallRequest": {
+ "description": "The request payload for rejecting the call.",
+ "required": [
+ "incomingCallContext"
+ ],
+ "type": "object",
+ "properties": {
+ "incomingCallContext": {
+ "description": "The context associated with the call.",
+ "type": "string"
+ },
+ "callRejectReason": {
+ "$ref": "#/definitions/CallRejectReason"
+ }
+ }
+ },
+ "ConnectRequest": {
+ "description": "The request payload for creating a connection to a CallLocator.",
+ "required": [
+ "callLocator",
+ "callbackUri"
+ ],
+ "type": "object",
+ "properties": {
+ "callLocator": {
+ "$ref": "#/definitions/CallLocator",
+ "description": "The call locator."
+ },
+ "callbackUri": {
+ "description": "The callback URI.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers to correlate the request to the response event.",
+ "type": "string"
+ },
+ "callIntelligenceOptions": {
+ "$ref": "#/definitions/CallIntelligenceOptions",
+ "description": "AI options for the call."
+ }
+ }
+ },
+ "CallLocatorKind": {
+ "description": "The call locator kind.",
+ "enum": [
+ "groupCallLocator",
+ "serverCallLocator",
+ "roomCallLocator"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CallLocatorKind",
+ "modelAsString": true
+ }
+ },
+ "CallLocator": {
+ "type": "object",
+ "description": "The locator used for joining or taking action on a call",
+ "properties": {
+ "groupCallId": {
+ "description": "The group call id",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "The server call id.",
+ "type": "string"
+ },
+ "roomId": {
+ "description": "The Acs room id",
+ "type": "string"
+ },
+ "kind": {
+ "$ref": "#/definitions/CallLocatorKind"
+ }
+ }
+ },
+ "TransferToParticipantRequest": {
+ "description": "The request payload for transferring call to a participant.",
+ "required": [
+ "targetParticipant"
+ ],
+ "type": "object",
+ "properties": {
+ "targetParticipant": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "The identity of the target where call should be transferred to."
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "transferee": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "Transferee is the participant who is transferred away."
+ },
+ "operationCallbackUri": {
+ "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.",
+ "type": "string"
+ },
+ "customCallingContext": {
+ "$ref": "#/definitions/CustomCallingContext",
+ "description": "Used by customer to send custom calling context to targets"
+ },
+ "sourceCallerIdNumber": {
+ "$ref": "#/definitions/PhoneNumberIdentifierModel",
+ "description": "The source caller Id, a phone number, that will be used as the transferor's caller Id when transferring a call to a Pstn target."
+ }
+ }
+ },
+ "CustomCallingContext": {
+ "description": "The custom calling context which will be sent to the target",
+ "type": "object",
+ "properties": {
+ "voipHeaders": {
+ "description": "Custom calling context VoiP headers",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "sipHeaders": {
+ "description": "Custom calling context SIP headers",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "TransferCallResponse": {
+ "description": "The response payload for transferring the call.",
+ "type": "object",
+ "properties": {
+ "operationContext": {
+ "description": "The operation context provided by client.",
+ "type": "string"
+ }
+ }
+ },
+ "PlayRequest": {
+ "required": [
+ "playSources"
+ ],
+ "type": "object",
+ "properties": {
+ "playSources": {
+ "description": "The source of the audio to be played.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PlaySource"
+ }
+ },
+ "playTo": {
+ "description": "The list of call participants play provided audio to.\r\nPlays to everyone in the call when not provided.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CommunicationIdentifierModel"
+ }
+ },
+ "interruptCallMediaOperation": {
+ "description": "If set play can barge into other existing queued-up/currently-processing requests.",
+ "type": "boolean"
+ },
+ "playOptions": {
+ "$ref": "#/definitions/PlayOptions",
+ "description": "Defines options for playing the audio."
+ },
+ "operationContext": {
+ "description": "The value to identify context of the operation.",
+ "type": "string"
+ },
+ "operationCallbackUri": {
+ "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.",
+ "type": "string"
+ }
+ }
+ },
+ "PlaySourceType": {
+ "description": "Defines the type of the play source",
+ "enum": [
+ "file",
+ "text",
+ "ssml"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PlaySourceType",
+ "modelAsString": true
+ }
+ },
+ "PlaySource": {
+ "required": [
+ "kind"
+ ],
+ "type": "object",
+ "properties": {
+ "kind": {
+ "$ref": "#/definitions/PlaySourceType"
+ },
+ "playSourceCacheId": {
+ "description": "Defines the identifier to be used for caching related media",
+ "type": "string"
+ },
+ "file": {
+ "$ref": "#/definitions/FileSource",
+ "description": "Defines the file source info to be used for play"
+ },
+ "text": {
+ "$ref": "#/definitions/TextSource",
+ "description": "Defines the text source info to be used for play"
+ },
+ "ssml": {
+ "$ref": "#/definitions/SsmlSource",
+ "description": "Defines the ssml(Speech Synthesis Markup Language) source info to be used for play"
+ }
+ }
+ },
+ "PlayOptions": {
+ "required": [
+ "loop"
+ ],
+ "type": "object",
+ "properties": {
+ "loop": {
+ "description": "The option to play the provided audio source in loop when set to true",
+ "type": "boolean"
+ }
+ }
+ },
+ "FileSource": {
+ "required": [
+ "uri"
+ ],
+ "type": "object",
+ "properties": {
+ "uri": {
+ "description": "Uri for the audio file to be played",
+ "type": "string"
+ }
+ }
+ },
+ "VoiceKind": {
+ "description": "Voice kind type",
+ "enum": [
+ "male",
+ "female"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "VoiceKind",
+ "modelAsString": true
+ }
+ },
+ "TextSource": {
+ "required": [
+ "text"
+ ],
+ "type": "object",
+ "properties": {
+ "text": {
+ "description": "Text for the cognitive service to be played",
+ "type": "string"
+ },
+ "sourceLocale": {
+ "description": "Source language locale to be played\r\nRefer to available locales here: ",
+ "type": "string"
+ },
+ "voiceKind": {
+ "$ref": "#/definitions/VoiceKind"
+ },
+ "voiceName": {
+ "description": "Voice name to be played\r\nRefer to available Text-to-speech voices here: ",
+ "type": "string"
+ },
+ "customVoiceEndpointId": {
+ "description": "Endpoint where the custom voice was deployed.",
+ "type": "string"
+ }
+ }
+ },
+ "SsmlSource": {
+ "required": [
+ "ssmlText"
+ ],
+ "type": "object",
+ "properties": {
+ "ssmlText": {
+ "description": "Ssml string for the cognitive service to be played",
+ "type": "string"
+ },
+ "customVoiceEndpointId": {
+ "description": "Endpoint where the custom voice was deployed.",
+ "type": "string"
+ }
+ }
+ },
+ "StartTranscriptionRequest": {
+ "type": "object",
+ "properties": {
+ "locale": {
+ "description": "Defines Locale for the transcription e,g en-US",
+ "type": "string"
+ },
+ "speechRecognitionModelEndpointId": {
+ "description": "Endpoint where the custom model was deployed.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "The value to identify context of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "StopTranscriptionRequest": {
+ "type": "object",
+ "properties": {
+ "operationContext": {
+ "description": "The value to identify context of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "UpdateTranscriptionRequest": {
+ "required": [
+ "locale"
+ ],
+ "type": "object",
+ "properties": {
+ "locale": {
+ "description": "Sets new locale for transcription.",
+ "type": "string"
+ },
+ "speechRecognitionModelEndpointId": {
+ "description": "Sets Endpoint id where the custom model was deployed.",
+ "type": "string"
+ }
+ }
+ },
+ "RecognizeInputType": {
+ "description": "Determines the type of the recognition.",
+ "enum": [
+ "dtmf",
+ "speech",
+ "speechOrDtmf",
+ "choices"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RecognizeInputType",
+ "modelAsString": true
+ }
+ },
+ "RecognizeRequest": {
+ "required": [
+ "recognizeInputType",
+ "recognizeOptions"
+ ],
+ "type": "object",
+ "properties": {
+ "recognizeInputType": {
+ "$ref": "#/definitions/RecognizeInputType"
+ },
+ "playPrompt": {
+ "$ref": "#/definitions/PlaySource",
+ "description": "The source of the audio to be played for recognition."
+ },
+ "playPrompts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PlaySource"
+ }
+ },
+ "interruptCallMediaOperation": {
+ "description": "If set recognize can barge into other existing queued-up/currently-processing requests.",
+ "type": "boolean"
+ },
+ "recognizeOptions": {
+ "$ref": "#/definitions/RecognizeOptions",
+ "description": "Defines options for recognition."
+ },
+ "operationContext": {
+ "description": "The value to identify context of the operation.",
+ "type": "string"
+ },
+ "operationCallbackUri": {
+ "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.",
+ "type": "string"
+ }
+ }
+ },
+ "RecognizeOptions": {
+ "required": [
+ "targetParticipant"
+ ],
+ "type": "object",
+ "properties": {
+ "interruptPrompt": {
+ "description": "Determines if we interrupt the prompt and start recognizing.",
+ "type": "boolean"
+ },
+ "initialSilenceTimeoutInSeconds": {
+ "format": "int32",
+ "description": "Time to wait for first input after prompt (if any).",
+ "maximum": 300,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "targetParticipant": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "Target participant of DTMF tone recognition."
+ },
+ "speechLanguage": {
+ "description": "Speech language to be recognized, If not set default is en-US",
+ "type": "string"
+ },
+ "speechRecognitionModelEndpointId": {
+ "description": "Endpoint where the custom model was deployed.",
+ "type": "string"
+ },
+ "dtmfOptions": {
+ "$ref": "#/definitions/DtmfOptions",
+ "description": "Defines configurations for DTMF."
+ },
+ "choices": {
+ "description": "Defines Ivr choices for recognize.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Choice"
+ }
+ },
+ "speechOptions": {
+ "$ref": "#/definitions/SpeechOptions",
+ "description": "Defines continuous speech recognition option."
+ }
+ }
+ },
+ "Tone": {
+ "enum": [
+ "zero",
+ "one",
+ "two",
+ "three",
+ "four",
+ "five",
+ "six",
+ "seven",
+ "eight",
+ "nine",
+ "a",
+ "b",
+ "c",
+ "d",
+ "pound",
+ "asterisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "Tone",
+ "modelAsString": true
+ }
+ },
+ "DtmfOptions": {
+ "description": "Options for DTMF recognition",
+ "type": "object",
+ "properties": {
+ "interToneTimeoutInSeconds": {
+ "format": "int32",
+ "description": "Time to wait between DTMF inputs to stop recognizing.",
+ "maximum": 60,
+ "minimum": 1,
+ "type": "integer"
+ },
+ "maxTonesToCollect": {
+ "format": "int32",
+ "description": "Maximum number of DTMF tones to be collected.",
+ "type": "integer"
+ },
+ "stopTones": {
+ "description": "List of tones that will stop recognizing.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Tone"
+ }
+ }
+ }
+ },
+ "Choice": {
+ "required": [
+ "label",
+ "phrases"
+ ],
+ "type": "object",
+ "properties": {
+ "label": {
+ "description": "Identifier for a given choice",
+ "type": "string"
+ },
+ "phrases": {
+ "description": "List of phrases to recognize",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "tone": {
+ "$ref": "#/definitions/Tone"
+ }
+ }
+ },
+ "SpeechOptions": {
+ "description": "Options for continuous speech recognition",
+ "type": "object",
+ "properties": {
+ "endSilenceTimeoutInMs": {
+ "format": "int64",
+ "description": "The length of end silence when user stops speaking and cogservice send response.",
+ "type": "integer"
+ }
+ }
+ },
+ "ContinuousDtmfRecognitionRequest": {
+ "required": [
+ "targetParticipant"
+ ],
+ "type": "object",
+ "properties": {
+ "targetParticipant": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "Defines options for recognition."
+ },
+ "operationContext": {
+ "description": "The value to identify context of the operation.",
+ "type": "string"
+ },
+ "operationCallbackUri": {
+ "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.",
+ "type": "string"
+ }
+ }
+ },
+ "SendDtmfTonesRequest": {
+ "required": [
+ "tones",
+ "targetParticipant"
+ ],
+ "type": "object",
+ "properties": {
+ "tones": {
+ "description": "List of tones to be sent to target participant.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Tone"
+ }
+ },
+ "targetParticipant": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "Target participant of send Dtmf tones."
+ },
+ "operationContext": {
+ "description": "The value to identify context of the operation.",
+ "type": "string"
+ },
+ "operationCallbackUri": {
+ "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.",
+ "type": "string"
+ }
+ }
+ },
+ "SendDtmfTonesResult": {
+ "type": "object",
+ "properties": {
+ "operationContext": {
+ "description": "The operation context provided by client.",
+ "type": "string"
+ }
+ }
+ },
+ "HoldRequest": {
+ "description": "The request payload for holding participant from the call.",
+ "required": [
+ "targetParticipant"
+ ],
+ "type": "object",
+ "properties": {
+ "targetParticipant": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "Participant to be held from the call."
+ },
+ "playSourceInfo": {
+ "$ref": "#/definitions/PlaySource",
+ "description": "Prompt to play while in hold."
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "operationCallbackUri": {
+ "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.",
+ "type": "string"
+ }
+ }
+ },
+ "UnholdRequest": {
+ "description": "The request payload for holding participant from the call.",
+ "required": [
+ "targetParticipant"
+ ],
+ "type": "object",
+ "properties": {
+ "targetParticipant": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "Participants to be hold from the call.\r\nOnly ACS Users are supported."
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ }
+ }
+ },
+ "StartMediaStreamingRequest": {
+ "type": "object",
+ "properties": {
+ "operationCallbackUri": {
+ "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "The value to identify context of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "StopMediaStreamingRequest": {
+ "type": "object",
+ "properties": {
+ "operationCallbackUri": {
+ "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.",
+ "type": "string"
+ }
+ }
+ },
+ "GetParticipantsResponse": {
+ "description": "The response payload for getting participants of the call.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of the current participants in the call.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CallParticipant"
+ }
+ },
+ "nextLink": {
+ "description": "Continue of the list of participants",
+ "type": "string"
+ }
+ }
+ },
+ "CallParticipant": {
+ "description": "A call participant.",
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "Communication identifier of the participant"
+ },
+ "isMuted": {
+ "description": "Is participant muted",
+ "type": "boolean"
+ },
+ "isOnHold": {
+ "description": "Is participant on hold.",
+ "type": "boolean"
+ }
+ }
+ },
+ "AddParticipantRequest": {
+ "description": "The request payload for adding participant to the call.",
+ "required": [
+ "participantToAdd"
+ ],
+ "type": "object",
+ "properties": {
+ "sourceCallerIdNumber": {
+ "$ref": "#/definitions/PhoneNumberIdentifierModel",
+ "description": "The source caller Id, a phone number, that's shown to the PSTN participant being invited.\r\nRequired only when inviting a PSTN participant."
+ },
+ "sourceDisplayName": {
+ "description": "(Optional) The display name of the source that is associated with this invite operation when\r\nadding a PSTN participant or teams user. Note: Will not update the display name in the roster.",
+ "type": "string"
+ },
+ "participantToAdd": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "The participant to invite."
+ },
+ "invitationTimeoutInSeconds": {
+ "format": "int32",
+ "description": "Gets or sets the timeout to wait for the invited participant to pickup.\r\nThe maximum value of this is 180 seconds",
+ "maximum": 180,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "operationCallbackUri": {
+ "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.",
+ "type": "string"
+ },
+ "customCallingContext": {
+ "$ref": "#/definitions/CustomCallingContext",
+ "description": "Used by customer to send custom calling context to targets"
+ }
+ }
+ },
+ "AddParticipantResponse": {
+ "description": "The response payload for adding participants to the call.",
+ "type": "object",
+ "properties": {
+ "participant": {
+ "$ref": "#/definitions/CallParticipant",
+ "description": "List of current participants in the call."
+ },
+ "operationContext": {
+ "description": "The operation context provided by client.",
+ "type": "string"
+ },
+ "invitationId": {
+ "description": "Invitation ID used to add a participant.",
+ "type": "string"
+ }
+ }
+ },
+ "RemoveParticipantRequest": {
+ "description": "The remove participant by identifier request.",
+ "required": [
+ "participantToRemove"
+ ],
+ "type": "object",
+ "properties": {
+ "participantToRemove": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "The participants to be removed from the call."
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "operationCallbackUri": {
+ "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.",
+ "type": "string"
+ }
+ }
+ },
+ "RemoveParticipantResponse": {
+ "description": "The response payload for removing participants of the call.",
+ "type": "object",
+ "properties": {
+ "operationContext": {
+ "description": "The operation context provided by client.",
+ "type": "string"
+ }
+ }
+ },
+ "MuteParticipantsRequest": {
+ "description": "The request payload for muting participants from the call.",
+ "required": [
+ "targetParticipants"
+ ],
+ "type": "object",
+ "properties": {
+ "targetParticipants": {
+ "description": "Participants to be muted from the call.\r\nOnly ACS Users are supported.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CommunicationIdentifierModel"
+ }
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ }
+ }
+ },
+ "MuteParticipantsResult": {
+ "description": "The result payload for muting participants from the call.",
+ "type": "object",
+ "properties": {
+ "operationContext": {
+ "description": "The operation context provided by client.",
+ "type": "string"
+ }
+ }
+ },
+ "CancelAddParticipantRequest": {
+ "description": "Request payload for cancelling add participant request.",
+ "required": [
+ "invitationId"
+ ],
+ "type": "object",
+ "properties": {
+ "invitationId": {
+ "description": "Invitation ID used to add a participant.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "operationCallbackUri": {
+ "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.",
+ "type": "string"
+ }
+ }
+ },
+ "CancelAddParticipantResponse": {
+ "description": "Response payload for cancel add participant request.",
+ "type": "object",
+ "properties": {
+ "invitationId": {
+ "description": "Invitation ID used to cancel the add participant action.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "The operation context provided by client.",
+ "type": "string"
+ }
+ }
+ },
+ "RecordingContentType": {
+ "description": "The content type of call recording.",
+ "enum": [
+ "audio",
+ "audioVideo"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RecordingContentType",
+ "modelAsString": true
+ }
+ },
+ "RecordingChannelType": {
+ "description": "The channel type of call recording.",
+ "enum": [
+ "mixed",
+ "unmixed"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RecordingChannelType",
+ "modelAsString": true
+ }
+ },
+ "RecordingFormatType": {
+ "description": "The format type of call recording.",
+ "enum": [
+ "wav",
+ "mp3",
+ "mp4"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RecordingFormatType",
+ "modelAsString": true
+ }
+ },
+ "StartCallRecordingRequest": {
+ "description": "The request payload start for call recording operation with call locator.",
+ "required": [
+ "callLocator"
+ ],
+ "type": "object",
+ "properties": {
+ "callLocator": {
+ "$ref": "#/definitions/CallLocator",
+ "description": "The call locator."
+ },
+ "recordingStateCallbackUri": {
+ "description": "The uri to send notifications to.",
+ "type": "string"
+ },
+ "recordingContentType": {
+ "$ref": "#/definitions/RecordingContentType"
+ },
+ "recordingChannelType": {
+ "$ref": "#/definitions/RecordingChannelType"
+ },
+ "recordingFormatType": {
+ "$ref": "#/definitions/RecordingFormatType"
+ },
+ "audioChannelParticipantOrdering": {
+ "description": "The sequential order in which audio channels are assigned to participants in the unmixed recording.\r\nWhen 'recordingChannelType' is set to 'unmixed' and `audioChannelParticipantOrdering is not specified,\r\nthe audio channel to participant mapping will be automatically assigned based on the order in which participant\r\nfirst audio was detected. Channel to participant mapping details can be found in the metadata of the recording.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CommunicationIdentifierModel"
+ }
+ },
+ "channelAffinity": {
+ "description": "The channel affinity of call recording\r\nWhen 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified, 'channel' will be automatically assigned.\r\nChannel-Participant mapping details can be found in the metadata of the recording.\r\n///",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ChannelAffinity"
+ }
+ },
+ "pauseOnStart": {
+ "description": "When set to true will start recording in Pause mode, which can be resumed.",
+ "type": "boolean"
+ },
+ "externalStorage": {
+ "$ref": "#/definitions/ExternalStorage"
+ }
+ }
+ },
+ "ChannelAffinity": {
+ "description": "Channel affinity for a participant",
+ "required": [
+ "participant"
+ ],
+ "type": "object",
+ "properties": {
+ "channel": {
+ "format": "int32",
+ "description": "Channel number to which bitstream from a particular participant will be written.",
+ "maximum": 4,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "participant": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "The identifier for the participant whose bitstream will be written to the channel \r\nrepresented by the channel number."
+ }
+ }
+ },
+ "RecordingStorageKind": {
+ "description": "Defines the kind of external storage",
+ "enum": [
+ "azureCommunicationServices",
+ "azureBlobStorage"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RecordingStorageKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "AzureCommunicationServices",
+ "description": "Storage managed by Azure Communication Services",
+ "value": "AzureCommunicationServices"
+ },
+ {
+ "name": "AzureBlobStorage",
+ "description": "Storage managed by provided Azure blob",
+ "value": "AzureBlobStorage"
+ }
+ ]
+ }
+ },
+ "ExternalStorage": {
+ "required": [
+ "recordingStorageKind"
+ ],
+ "type": "object",
+ "properties": {
+ "recordingStorageKind": {
+ "$ref": "#/definitions/RecordingStorageKind"
+ },
+ "recordingDestinationContainerUrl": {
+ "format": "uri",
+ "description": "Uri of a container or a location within a container",
+ "type": "string"
+ }
+ }
+ },
+ "RecordingState": {
+ "enum": [
+ "active",
+ "inactive"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RecordingState",
+ "modelAsString": true
+ }
+ },
+ "RecordingKind": {
+ "enum": [
+ "azureCommunicationServices",
+ "teams",
+ "teamsCompliance"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RecordingKind",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "AzureCommunicationServices",
+ "description": "Recording initiated by Azure Communication Services",
+ "value": "AzureCommunicationServices"
+ },
+ {
+ "name": "Teams",
+ "description": "Recording initiated by Teams user",
+ "value": "Teams"
+ },
+ {
+ "name": "TeamsCompliance",
+ "description": "Recording initiated by Teams compliance policy",
+ "value": "TeamsCompliance"
+ }
+ ]
+ }
+ },
+ "RecordingStateResponse": {
+ "type": "object",
+ "properties": {
+ "recordingId": {
+ "type": "string"
+ },
+ "recordingState": {
+ "$ref": "#/definitions/RecordingState"
+ },
+ "recordingKind": {
+ "$ref": "#/definitions/RecordingKind"
+ }
+ }
+ },
+ "AddParticipantFailed": {
+ "description": "The failed to add participants event.",
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ },
+ "participant": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "Participant"
+ }
+ }
+ },
+ "ResultInformation": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "format": "int32",
+ "description": "Code of the current result. This can be helpful to Call Automation team to troubleshoot the issue if this result was unexpected.",
+ "type": "integer"
+ },
+ "subCode": {
+ "format": "int32",
+ "description": "Subcode of the current result. This can be helpful to Call Automation team to troubleshoot the issue if this result was unexpected.",
+ "type": "integer"
+ },
+ "message": {
+ "description": "Detail message that describes the current result.",
+ "type": "string"
+ }
+ }
+ },
+ "AddParticipantSucceeded": {
+ "description": "The participants successfully added event.",
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ },
+ "participant": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "Participant"
+ }
+ }
+ },
+ "CallConnected": {
+ "description": "The call connected event.",
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers to set the context for creating a new call. This property will be null for answering a call.",
+ "type": "string"
+ }
+ }
+ },
+ "CallDisconnected": {
+ "description": "The call disconnected event.",
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers to set the context for creating a new call. This property will be null for answering a call.",
+ "type": "string"
+ }
+ }
+ },
+ "CallTransferAccepted": {
+ "description": "The call transfer accepted event.",
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ },
+ "transferTarget": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "Target who the call is transferred to."
+ },
+ "transferee": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "the participant who is being transferred away."
+ }
+ }
+ },
+ "CallTransferFailed": {
+ "description": "The call transfer failed event.",
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ }
+ }
+ },
+ "ParticipantsUpdated": {
+ "description": "The participants updated in a call event.",
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string"
+ },
+ "sequenceNumber": {
+ "format": "int32",
+ "description": "The Sequence Number of the event",
+ "type": "integer"
+ },
+ "participants": {
+ "description": "The list of participants in the call.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CallParticipant"
+ }
+ }
+ }
+ },
+ "RemoveParticipantSucceeded": {
+ "description": "The participant removed event.",
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ },
+ "participant": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "Participant"
+ }
+ }
+ },
+ "RemoveParticipantFailed": {
+ "description": "The failed to remove participant event.",
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ },
+ "participant": {
+ "$ref": "#/definitions/CommunicationIdentifierModel",
+ "description": "Participant"
+ }
+ }
+ },
+ "CancelAddParticipantSucceeded": {
+ "description": "Successful cancel add participant event.",
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "invitationId": {
+ "description": "Invitation ID used to cancel the request.",
+ "type": "string"
+ }
+ }
+ },
+ "CancelAddParticipantFailed": {
+ "description": "Failed cancel add participant event.",
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code/sub-code and message from NGC services."
+ },
+ "invitationId": {
+ "description": "Invitation ID used to cancel the request.",
+ "type": "string"
+ }
+ }
+ },
+ "RecordingStateChanged": {
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation.",
+ "type": "string"
+ },
+ "recordingId": {
+ "description": "The call recording id",
+ "type": "string",
+ "readOnly": true
+ },
+ "state": {
+ "$ref": "#/definitions/RecordingState"
+ },
+ "startDateTime": {
+ "format": "date-time",
+ "description": "The time of the recording started",
+ "type": "string",
+ "readOnly": true
+ },
+ "recordingKind": {
+ "$ref": "#/definitions/RecordingKind"
+ }
+ }
+ },
+ "PlayStarted": {
+ "description": "Play started event.",
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Gets or sets call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Gets or sets server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Gets or sets correlation ID for event to call correlation.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Gets or sets used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Gets or sets contains the resulting SIP code, sub-code and message."
+ }
+ }
+ },
+ "PlayCompleted": {
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ }
+ }
+ },
+ "PlayFailed": {
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ },
+ "failedPlaySourceIndex": {
+ "format": "int32",
+ "description": "Contains the index of the failed play source.",
+ "type": "integer"
+ }
+ }
+ },
+ "PlayCanceled": {
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ }
+ }
+ },
+ "RecognitionType": {
+ "description": "Determines the sub-type of the recognize operation.\r\nIn case of cancel operation the this field is not set and is returned empty",
+ "enum": [
+ "dtmf",
+ "speech",
+ "choices"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RecognitionType",
+ "modelAsString": true
+ }
+ },
+ "RecognizeCompleted": {
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ },
+ "recognitionType": {
+ "$ref": "#/definitions/RecognitionType"
+ },
+ "dtmfResult": {
+ "$ref": "#/definitions/DtmfResult",
+ "description": "Defines the result for RecognitionType = Dtmf"
+ },
+ "choiceResult": {
+ "$ref": "#/definitions/ChoiceResult",
+ "description": "Defines the result for RecognitionType = Choices"
+ },
+ "speechResult": {
+ "$ref": "#/definitions/SpeechResult",
+ "description": "Defines the result for RecognitionType = Speech and SpeechOrDtmf",
+ "readOnly": true
+ }
+ }
+ },
+ "DtmfResult": {
+ "type": "object",
+ "properties": {
+ "tones": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Tone"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "ChoiceResult": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "description": "Label is the primary identifier for the choice detected",
+ "type": "string"
+ },
+ "recognizedPhrase": {
+ "description": "Phrases are set to the value if choice is selected via phrase detection.\r\nIf Dtmf input is recognized, then Label will be the identifier for the choice detected and phrases will be set to null",
+ "type": "string"
+ }
+ }
+ },
+ "SpeechResult": {
+ "description": "The speech status as a result.",
+ "type": "object",
+ "properties": {
+ "speech": {
+ "description": "The recognized speech in string.",
+ "type": "string"
+ }
+ }
+ },
+ "RecognizeFailed": {
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ },
+ "failedPlaySourceIndex": {
+ "format": "int32",
+ "description": "Contains the index of the failed play source.",
+ "type": "integer"
+ }
+ }
+ },
+ "RecognizeCanceled": {
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ }
+ }
+ },
+ "ContinuousDtmfRecognitionToneFailed": {
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ }
+ }
+ },
+ "ContinuousDtmfRecognitionToneReceived": {
+ "type": "object",
+ "properties": {
+ "sequenceId": {
+ "format": "int32",
+ "description": "The sequence id which can be used to determine if the same tone was played multiple times or if any tones were missed.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "tone": {
+ "$ref": "#/definitions/Tone"
+ },
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId or skype chain ID.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ }
+ }
+ },
+ "ContinuousDtmfRecognitionStopped": {
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ }
+ }
+ },
+ "SendDtmfTonesCompleted": {
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ }
+ }
+ },
+ "SendDtmfTonesFailed": {
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ }
+ }
+ },
+ "MediaStreamingFailed": {
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling answerCall action to correlate the request to the response event.",
+ "type": "string",
+ "readOnly": true
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code/sub-code and message from NGC services.",
+ "readOnly": true
+ },
+ "mediaStreamingUpdate": {
+ "$ref": "#/definitions/MediaStreamingUpdate",
+ "description": "Defines the result for MediaStreamingUpdate with the current status and the details about the status",
+ "readOnly": true
+ }
+ }
+ },
+ "MediaStreamingStatus": {
+ "enum": [
+ "mediaStreamingStarted",
+ "mediaStreamingFailed",
+ "mediaStreamingStopped",
+ "unspecifiedError"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MediaStreamingStatus",
+ "modelAsString": true
+ }
+ },
+ "MediaStreamingStatusDetails": {
+ "enum": [
+ "subscriptionStarted",
+ "streamConnectionReestablished",
+ "streamConnectionUnsuccessful",
+ "streamUrlMissing",
+ "serviceShutdown",
+ "streamConnectionInterrupted",
+ "speechServicesConnectionError",
+ "subscriptionStopped",
+ "unspecifiedError",
+ "authenticationFailure",
+ "badRequest",
+ "tooManyRequests",
+ "forbidden",
+ "serviceTimeout",
+ "initialWebSocketConnectionFailed"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MediaStreamingStatusDetails",
+ "modelAsString": true
+ }
+ },
+ "MediaStreamingUpdate": {
+ "type": "object",
+ "properties": {
+ "contentType": {
+ "type": "string"
+ },
+ "mediaStreamingStatus": {
+ "$ref": "#/definitions/MediaStreamingStatus"
+ },
+ "mediaStreamingStatusDetails": {
+ "$ref": "#/definitions/MediaStreamingStatusDetails"
+ }
+ }
+ },
+ "MediaStreamingStarted": {
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling answerCall action to correlate the request to the response event.",
+ "type": "string",
+ "readOnly": true
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code/sub-code and message from NGC services.",
+ "readOnly": true
+ },
+ "mediaStreamingUpdate": {
+ "$ref": "#/definitions/MediaStreamingUpdate",
+ "description": "Defines the result for MediaStreamingUpdate with the current status and the details about the status",
+ "readOnly": true
+ }
+ }
+ },
+ "MediaStreamingStopped": {
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling answerCall action to correlate the request to the response event.",
+ "type": "string",
+ "readOnly": true
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code/sub-code and message from NGC services.",
+ "readOnly": true
+ },
+ "mediaStreamingUpdate": {
+ "$ref": "#/definitions/MediaStreamingUpdate",
+ "description": "Defines the result for MediaStreamingUpdate with the current status and the details about the status",
+ "readOnly": true
+ }
+ }
+ },
+ "HoldFailed": {
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ }
+ }
+ },
+ "TranscriptionFailed": {
+ "type": "object",
+ "properties": {
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string",
+ "readOnly": true
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message.",
+ "readOnly": true
+ },
+ "transcriptionUpdate": {
+ "$ref": "#/definitions/TranscriptionUpdate",
+ "description": "Defines the result for TranscriptionUpdate with the current status and the details about the status",
+ "readOnly": true
+ },
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "TranscriptionStatus": {
+ "enum": [
+ "transcriptionStarted",
+ "transcriptionFailed",
+ "transcriptionResumed",
+ "transcriptionUpdated",
+ "transcriptionStopped",
+ "unspecifiedError"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TranscriptionStatus",
+ "modelAsString": true
+ }
+ },
+ "TranscriptionStatusDetails": {
+ "enum": [
+ "subscriptionStarted",
+ "streamConnectionReestablished",
+ "streamConnectionUnsuccessful",
+ "streamUrlMissing",
+ "serviceShutdown",
+ "streamConnectionInterrupted",
+ "speechServicesConnectionError",
+ "subscriptionStopped",
+ "unspecifiedError",
+ "authenticationFailure",
+ "badRequest",
+ "tooManyRequests",
+ "forbidden",
+ "serviceTimeout",
+ "transcriptionLocaleUpdated"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TranscriptionStatusDetails",
+ "modelAsString": true
+ }
+ },
+ "TranscriptionUpdate": {
+ "type": "object",
+ "properties": {
+ "transcriptionStatus": {
+ "$ref": "#/definitions/TranscriptionStatus"
+ },
+ "transcriptionStatusDetails": {
+ "$ref": "#/definitions/TranscriptionStatusDetails"
+ }
+ }
+ },
+ "TranscriptionStarted": {
+ "type": "object",
+ "properties": {
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string",
+ "readOnly": true
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message.",
+ "readOnly": true
+ },
+ "transcriptionUpdate": {
+ "$ref": "#/definitions/TranscriptionUpdate",
+ "description": "Defines the result for TranscriptionUpdate with the current status and the details about the status",
+ "readOnly": true
+ },
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "TranscriptionStopped": {
+ "type": "object",
+ "properties": {
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string",
+ "readOnly": true
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message.",
+ "readOnly": true
+ },
+ "transcriptionUpdate": {
+ "$ref": "#/definitions/TranscriptionUpdate",
+ "description": "Defines the result for TranscriptionUpdate with the current status and the details about the status",
+ "readOnly": true
+ },
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "TranscriptionUpdated": {
+ "type": "object",
+ "properties": {
+ "operationContext": {
+ "description": "Used by customers when calling mid-call actions to correlate the request to the response event.",
+ "type": "string",
+ "readOnly": true
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message.",
+ "readOnly": true
+ },
+ "transcriptionUpdate": {
+ "$ref": "#/definitions/TranscriptionUpdate",
+ "description": "Defines the result for TranscriptionUpdate with the current status and the details about the status",
+ "readOnly": true
+ },
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ConnectFailed": {
+ "description": "The ConnectFailed event.",
+ "type": "object",
+ "properties": {
+ "callConnectionId": {
+ "description": "Call connection ID.",
+ "type": "string"
+ },
+ "serverCallId": {
+ "description": "Server call ID.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.",
+ "type": "string"
+ },
+ "operationContext": {
+ "description": "Used by customers to set the context for connecting to a call.",
+ "type": "string"
+ },
+ "resultInformation": {
+ "$ref": "#/definitions/ResultInformation",
+ "description": "Contains the resulting SIP code, sub-code and message."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "Version of API to invoke.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "Endpoint": {
+ "name": "endpoint",
+ "in": "path",
+ "description": "The endpoint of the Azure Communication resource.",
+ "required": true,
+ "type": "string",
+ "format": "url",
+ "x-ms-skip-url-encoding": true,
+ "x-ms-parameter-location": "client"
+ }
+ },
+ "securityDefinitions": {
+ "Authorization": {
+ "type": "apiKey",
+ "description": "An Azure Communication Services user access token.",
+ "name": "Authorization",
+ "in": "header"
+ }
+ },
+ "security": [
+ {
+ "Authorization": []
+ }
+ ],
+ "x-ms-parameterized-host": {
+ "hostTemplate": "{endpoint}",
+ "useSchemePrefix": false,
+ "parameters": [
+ {
+ "$ref": "#/parameters/Endpoint"
+ }
+ ]
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/AnswerCall.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/AnswerCall.json
new file mode 100644
index 000000000000..ab97c0406569
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/AnswerCall.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "answerCallRequest": {
+ "incomingCallContext": "H4sIAAAAAAAEAMVVS2/bOBD+LzrspaElPiSSBoJFNnvYoNi0aHaBtpcFRQ5t1rIokLRTJ8h/X1J2soHRQ4A9lAdZ4ry+mflm/FhpNQy3PjnrtErOj9XysbLBb8uvM9WyEkul49J2ioEiGhlKADHVKiR7oVDXUGo5tkpa8k8zH9yglhuKuLQNkqLpEMZUNSZLNFfVRWVcnAZ1uFVbyP53EQLOtzCaybsx3ZSgnZFKKk4QgLGIybZFfU8oolIZzFrWGk6yzaDG1U6tYLaBMd9MKiSn3aROjjSRoAUHhG1PEDMdIGFlg4yRUmhChWQsm62dMdl+adUQ4aIKEP0u6KPft6RePV1Uyf/PmmmT5VijnlmMpD7VDLg4r9m4G4azgjWng37weD5nBTt6OS8YlcRyBhpJwD1iggFSbccQJVRJANW1gp4XLCc/uHETS/4qJaXX2dE6pSku61pNbgETMrBfxM1hgsUIqVzWe1Lrqda6iBBpmsXx9ZWW1vUe19aHDZja9pqBMRyBpQyxriVIgNBIGa11D9wy2tWE1Q7np6iPOH51lyXtLRinrsZ4D6FwQmdY28LEKfhV7nX8+XCfkZwAB/gGOv18WEccJ1A7M/0V1BgnHwq0/JmBYSoWEi84XTC+pIyLuszCXPBrPyYY0zPTsv57OBSOxJxoXjXzV3WzJs1D/+X22gy/36m762/vhk8PV5eXOWAm5gZKqDZ5/PCdc2L/vvmjbynGh3fhPus8lVIZFzLI7PBj8BNkOsPMRBc/nURXw+DvIbM7hR3MJnmWdNE6Itt7p2Gr3HAHKblxVcyfsp724x5CnPfizbh36WVDvpaUNIMfhplbb+1Xtp87hhfPr687lq/qB4HD9ec1vN98+OzhQ9Rfp26zKq34BS47ygVtBZdNS3AjMCnb0MU/d0NyH/NEH15WmYu/BZ+7q2L6b1oN9LvVS3se5z+B4w6lWIOSHOl5+rmiSJoOI9b0jZZATMPUD7bsm5ZGjrsKfjfNcb+faPH0LyoNW7KCBgAA",
+ "callbackUri": "https://app.contoso.com/callback"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA",
+ "sourceCallerIdNumber": {
+ "value": "+18440123456"
+ },
+ "source": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
+ }
+ },
+ "targets": [
+ {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9"
+ }
+ }
+ ],
+ "callConnectionState": "connected",
+ "callbackUri": "https://app.contoso.com/callback"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_AddParticipant.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_AddParticipant.json
new file mode 100644
index 000000000000..45e3b116f964
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_AddParticipant.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "addParticipantRequest": {
+ "participantToAdd": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
+ }
+ },
+ "operationContext": "adding participant",
+ "sourceCallerIdNumber": {
+ "value": "+18440123456"
+ },
+ "operationCallbackUri": "https://app.contoso.com/callback"
+ }
+ },
+ "responses": {
+ "202": {
+ "body": {
+ "operationContext": "adding participant",
+ "participant": {
+ "identifier": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
+ }
+ },
+ "isMuted": false
+ },
+ "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_CancelAddParticipant.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_CancelAddParticipant.json
new file mode 100644
index 000000000000..8e92690ccd27
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_CancelAddParticipant.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "cancelAddParticipantRequest": {
+ "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40",
+ "operationContext": "cancelling add participant",
+ "operationCallbackUri": "https://app.contoso.com/callback"
+ }
+ },
+ "responses": {
+ "202": {
+ "body": {
+ "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40",
+ "operationContext": "cancelling add participant"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_GetCall.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_GetCall.json
new file mode 100644
index 000000000000..ac083bf4d5b3
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_GetCall.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA",
+ "sourceCallerIdNumber": {
+ "value": "+18440123456"
+ },
+ "source": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
+ }
+ },
+ "targets": [
+ {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9"
+ }
+ },
+ {
+ "kind": "phoneNumber",
+ "phoneNumber": {
+ "value": "+14250123456"
+ }
+ }
+ ],
+ "callConnectionState": "connected",
+ "callbackUri": "https://app.contoso.com/callback"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_GetParticipant.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_GetParticipant.json
new file mode 100644
index 000000000000..e31e6f4ed77d
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_GetParticipant.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "participantRawId": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "identifier": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
+ }
+ },
+ "isMuted": false
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_GetParticipants.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_GetParticipants.json
new file mode 100644
index 000000000000..ec9ebc38d086
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_GetParticipants.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "identifier": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
+ }
+ },
+ "isMuted": true
+ }
+ ],
+ "nextLink": "string"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_HangupCall.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_HangupCall.json
new file mode 100644
index 000000000000..bd33c91de15f
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_HangupCall.json
@@ -0,0 +1,10 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_Mute.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_Mute.json
new file mode 100644
index 000000000000..ba17211d2e3e
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_Mute.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "muteParticipantsRequest": {
+ "targetParticipants": [
+ {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
+ }
+ }
+ ],
+ "operationContext": "mute participant"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "operationContext": "mute participant"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_RemoveParticipant.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_RemoveParticipant.json
new file mode 100644
index 000000000000..75889220576d
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_RemoveParticipant.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "removeParticipantRequest": {
+ "participantToRemove": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
+ }
+ },
+ "operationContext": "removing participant",
+ "operationCallbackUri": "https://app.contoso.com/callback"
+ }
+ },
+ "responses": {
+ "202": {
+ "body": {
+ "operationContext": "removing participant"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_TerminateCall.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_TerminateCall.json
new file mode 100644
index 000000000000..bd33c91de15f
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_TerminateCall.json
@@ -0,0 +1,10 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_TransferToParticipant.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_TransferToParticipant.json
new file mode 100644
index 000000000000..855ac037aab0
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallConnection_TransferToParticipant.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "transferToParticipantRequest": {
+ "targetParticipant": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
+ }
+ },
+ "transferee": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
+ }
+ },
+ "operationCallbackUri": "https://app.contoso.com/callback",
+ "operationContext": "trasferring call"
+ }
+ },
+ "responses": {
+ "202": {
+ "body": {
+ "operationContext": "trasferring call"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_CancelAllMediaOperations.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_CancelAllMediaOperations.json
new file mode 100644
index 000000000000..6ddb1315d8da
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_CancelAllMediaOperations.json
@@ -0,0 +1,10 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c"
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_Hold.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_Hold.json
new file mode 100644
index 000000000000..e913d0b6ff4a
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_Hold.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "holdRequest": {
+ "targetParticipant": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9"
+ }
+ },
+ "playSourceInfo": {
+ "kind": "file",
+ "file": {
+ "uri": "https://some.file.azure.com/sample.wav"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_Play.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_Play.json
new file mode 100644
index 000000000000..d9139f4200b7
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_Play.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "playRequest": {
+ "playSources": [
+ {
+ "kind": "file",
+ "playSourceCacheId": "string",
+ "file": {
+ "uri": "https://some.file.azure.com/sample.wav"
+ }
+ }
+ ],
+ "playTo": [
+ {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
+ }
+ }
+ ],
+ "playOptions": {
+ "loop": true
+ },
+ "operationCallbackUri": "https://app.contoso.com/callback"
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_Recognize.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_Recognize.json
new file mode 100644
index 000000000000..ae45de0faca0
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_Recognize.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "recognizeRequest": {
+ "recognizeInputType": "dtmf",
+ "playPrompt": {
+ "kind": "file",
+ "file": {
+ "uri": "https://some.file.azure.com/sample.wav"
+ }
+ },
+ "recognizeOptions": {
+ "interruptPrompt": true,
+ "initialSilenceTimeoutInSeconds": 5,
+ "targetParticipant": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
+ }
+ },
+ "dtmfOptions": {
+ "interToneTimeoutInSeconds": 3,
+ "maxTonesToCollect": 5,
+ "stopTones": [
+ "pound"
+ ]
+ }
+ },
+ "operationCallbackUri": "https://app.contoso.com/callback"
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_SendDtmfTones.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_SendDtmfTones.json
new file mode 100644
index 000000000000..103824067d18
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_SendDtmfTones.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "sendDtmfTonesRequest": {
+ "tones": [
+ "zero"
+ ],
+ "targetParticipant": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
+ }
+ },
+ "operationContext": "sendDtmf operation context",
+ "operationCallbackUri": "https://app.contoso.com/callback"
+ }
+ },
+ "responses": {
+ "202": {
+ "body": {
+ "operationContext": "sendDtmf operation context"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StartContinuousDtmfRecognition.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StartContinuousDtmfRecognition.json
new file mode 100644
index 000000000000..ff1f272bbee4
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StartContinuousDtmfRecognition.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "continuousDtmfRecognitionRequest": {
+ "targetParticipant": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StartMediaStreaming.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StartMediaStreaming.json
new file mode 100644
index 000000000000..3c2aa8005e26
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StartMediaStreaming.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "startMediaStreamingRequest": {}
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StartTranscription.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StartTranscription.json
new file mode 100644
index 000000000000..227036d7919d
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StartTranscription.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "startTranscriptionRequest": {}
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StopContinuousDtmfRecognition.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StopContinuousDtmfRecognition.json
new file mode 100644
index 000000000000..4658f8addc7f
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StopContinuousDtmfRecognition.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "continuousDtmfRecognitionRequest": {
+ "targetParticipant": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
+ }
+ },
+ "operationCallbackUri": "https://app.contoso.com/callback"
+ }
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StopMediaStreaming.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StopMediaStreaming.json
new file mode 100644
index 000000000000..8e1602a87ed2
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StopMediaStreaming.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "stopMediaStreamingRequest": {}
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StopTranscription.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StopTranscription.json
new file mode 100644
index 000000000000..7d078d63ee01
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_StopTranscription.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "stopTranscriptionRequest": {}
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_Unhold.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_Unhold.json
new file mode 100644
index 000000000000..c791f44a5b4c
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_Unhold.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "unholdRequest": {
+ "targetParticipant": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_UpdateTranscription.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_UpdateTranscription.json
new file mode 100644
index 000000000000..153fa51bdb31
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallMedia_UpdateTranscription.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "updateTranscriptionRequest": {
+ "locale": "en-us"
+ }
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallRecording_GetRecordingProperties.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallRecording_GetRecordingProperties.json
new file mode 100644
index 000000000000..62b9725768ac
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallRecording_GetRecordingProperties.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUifQ=="
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUifQ==",
+ "recordingState": "inactive"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallRecording_PauseRecording.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallRecording_PauseRecording.json
new file mode 100644
index 000000000000..ed0aedafc2bc
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallRecording_PauseRecording.json
@@ -0,0 +1,10 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUifQ=="
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallRecording_ResumeRecording.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallRecording_ResumeRecording.json
new file mode 100644
index 000000000000..ed0aedafc2bc
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallRecording_ResumeRecording.json
@@ -0,0 +1,10 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUifQ=="
+ },
+ "responses": {
+ "202": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallRecording_StartRecording.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallRecording_StartRecording.json
new file mode 100644
index 000000000000..0b47123d8a75
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallRecording_StartRecording.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "startCallRecording": {
+ "recordingStateCallbackUri": "https://contoso.communications.azure.com/callback",
+ "recordingContentType": null,
+ "recordingChannelType": null,
+ "recordingFormatType": null,
+ "pauseOnStart": true,
+ "externalStorage": {
+ "recordingStorageKind": "azureBlobStorage",
+ "recordingDestinationContainerUrl": "https://contoso.blob.core.windows.net/recordings"
+ },
+ "callLocator": {
+ "serverCallId": "aHR0cHM6Ly9za3lwZS5uZXQvYXBpL3YyL2NwL3NreXBlLm5ldC9jb252LzFQd3ZKMTcxZFI/aT0wJmU9NzU3NzA4NzU3OQ==",
+ "kind": "serverCallLocator"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUifQ==",
+ "recordingState": "inactive",
+ "recordingKind": "teamsCompliance"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallRecording_StopRecording.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallRecording_StopRecording.json
new file mode 100644
index 000000000000..017ffe85016c
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CallRecording_StopRecording.json
@@ -0,0 +1,10 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUifQ=="
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/Connect.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/Connect.json
new file mode 100644
index 000000000000..6c82ff0a2b76
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/Connect.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "connectRequest": {
+ "callbackUri": "https://contoso.communications.azure.com/callback",
+ "callLocator": {
+ "roomId": "99434917639286209",
+ "kind": "roomCallLocator"
+ },
+ "callIntelligenceOptions": {
+ "cognitiveServicesEndpoint": "https://cognitiveservice.com"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA",
+ "targets": [],
+ "callConnectionState": "connecting",
+ "callbackUri": "https://contoso.communications.azure.com/callback"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CreateCall.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CreateCall.json
new file mode 100644
index 000000000000..d7aa833a4517
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/CreateCall.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "createCallRequest": {
+ "targets": [
+ {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9"
+ }
+ }
+ ],
+ "callbackUri": "https://app.contoso.com/callback"
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
+ "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA",
+ "source": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
+ }
+ },
+ "targets": [
+ {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9"
+ }
+ }
+ ],
+ "callConnectionState": "connected",
+ "callbackUri": "https://app.contoso.com/callback"
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/RedirectCall.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/RedirectCall.json
new file mode 100644
index 000000000000..69e302f7a7b2
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/RedirectCall.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "redirectCallRequest": {
+ "target": {
+ "kind": "communicationUser",
+ "communicationUser": {
+ "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9"
+ }
+ },
+ "incomingCallContext": "H4sIAAAAAAAEAMVVS2/bOBD+LzrspaElPiSSBoJFNnvYoNi0aHaBtpcFRQ5t1rIokLRTJ8h/X1J2soHRQ4A9lAdZ4ry+mflm/FhpNQy3PjnrtErOj9XysbLBb8uvM9WyEkul49J2ioEiGhlKADHVKiR7oVDXUGo5tkpa8k8zH9yglhuKuLQNkqLpEMZUNSZLNFfVRWVcnAZ1uFVbyP53EQLOtzCaybsx3ZSgnZFKKk4QgLGIybZFfU8oolIZzFrWGk6yzaDG1U6tYLaBMd9MKiSn3aROjjSRoAUHhG1PEDMdIGFlg4yRUmhChWQsm62dMdl+adUQ4aIKEP0u6KPft6RePV1Uyf/PmmmT5VijnlmMpD7VDLg4r9m4G4azgjWng37weD5nBTt6OS8YlcRyBhpJwD1iggFSbccQJVRJANW1gp4XLCc/uHETS/4qJaXX2dE6pSku61pNbgETMrBfxM1hgsUIqVzWe1Lrqda6iBBpmsXx9ZWW1vUe19aHDZja9pqBMRyBpQyxriVIgNBIGa11D9wy2tWE1Q7np6iPOH51lyXtLRinrsZ4D6FwQmdY28LEKfhV7nX8+XCfkZwAB/gGOv18WEccJ1A7M/0V1BgnHwq0/JmBYSoWEi84XTC+pIyLuszCXPBrPyYY0zPTsv57OBSOxJxoXjXzV3WzJs1D/+X22gy/36m762/vhk8PV5eXOWAm5gZKqDZ5/PCdc2L/vvmjbynGh3fhPus8lVIZFzLI7PBj8BNkOsPMRBc/nURXw+DvIbM7hR3MJnmWdNE6Itt7p2Gr3HAHKblxVcyfsp724x5CnPfizbh36WVDvpaUNIMfhplbb+1Xtp87hhfPr687lq/qB4HD9ec1vN98+OzhQ9Rfp26zKq34BS47ygVtBZdNS3AjMCnb0MU/d0NyH/NEH15WmYu/BZ+7q2L6b1oN9LvVS3se5z+B4w6lWIOSHOl5+rmiSJoOI9b0jZZATMPUD7bsm5ZGjrsKfjfNcb+faPH0LyoNW7KCBgAA"
+ }
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/RejectCall.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/RejectCall.json
new file mode 100644
index 000000000000..4ac95e608c13
--- /dev/null
+++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/examples/RejectCall.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "endpoint": "https://contoso.communications.azure.com",
+ "api-version": "2024-06-15-preview",
+ "rejectCallRequest": {
+ "incomingCallContext": "H4sIAAAAAAAEAMVVS2/bOBD+LzrspaElPiSSBoJFNnvYoNi0aHaBtpcFRQ5t1rIokLRTJ8h/X1J2soHRQ4A9lAdZ4ry+mflm/FhpNQy3PjnrtErOj9XysbLBb8uvM9WyEkul49J2ioEiGhlKADHVKiR7oVDXUGo5tkpa8k8zH9yglhuKuLQNkqLpEMZUNSZLNFfVRWVcnAZ1uFVbyP53EQLOtzCaybsx3ZSgnZFKKk4QgLGIybZFfU8oolIZzFrWGk6yzaDG1U6tYLaBMd9MKiSn3aROjjSRoAUHhG1PEDMdIGFlg4yRUmhChWQsm62dMdl+adUQ4aIKEP0u6KPft6RePV1Uyf/PmmmT5VijnlmMpD7VDLg4r9m4G4azgjWng37weD5nBTt6OS8YlcRyBhpJwD1iggFSbccQJVRJANW1gp4XLCc/uHETS/4qJaXX2dE6pSku61pNbgETMrBfxM1hgsUIqVzWe1Lrqda6iBBpmsXx9ZWW1vUe19aHDZja9pqBMRyBpQyxriVIgNBIGa11D9wy2tWE1Q7np6iPOH51lyXtLRinrsZ4D6FwQmdY28LEKfhV7nX8+XCfkZwAB/gGOv18WEccJ1A7M/0V1BgnHwq0/JmBYSoWEi84XTC+pIyLuszCXPBrPyYY0zPTsv57OBSOxJxoXjXzV3WzJs1D/+X22gy/36m762/vhk8PV5eXOWAm5gZKqDZ5/PCdc2L/vvmjbynGh3fhPus8lVIZFzLI7PBj8BNkOsPMRBc/nURXw+DvIbM7hR3MJnmWdNE6Itt7p2Gr3HAHKblxVcyfsp724x5CnPfizbh36WVDvpaUNIMfhplbb+1Xtp87hhfPr687lq/qB4HD9ec1vN98+OzhQ9Rfp26zKq34BS47ygVtBZdNS3AjMCnb0MU/d0NyH/NEH15WmYu/BZ+7q2L6b1oN9LvVS3se5z+B4w6lWIOSHOl5+rmiSJoOI9b0jZZATMPUD7bsm5ZGjrsKfjfNcb+faPH0LyoNW7KCBgAA"
+ }
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/communication/data-plane/CallAutomation/readme.md b/specification/communication/data-plane/CallAutomation/readme.md
index 14f8df5a8d86..475691dd098c 100644
--- a/specification/communication/data-plane/CallAutomation/readme.md
+++ b/specification/communication/data-plane/CallAutomation/readme.md
@@ -83,6 +83,21 @@ title:
Azure Communication Services
```
+### Tag: package-2024-06-15-preview
+
+These settings apply only when `--tag=package-2024-06-15-preview` is specified on the command line.
+
+```yaml $(tag) == 'package-2024-06-15-preview'
+input-file:
+ - preview/2024-06-15-preview/communicationservicescallautomation.json
+title:
+ Azure Communication Services
+suppressions:
+ - code: LroExtension
+ from: communicationservicescallautomation.json
+ reason: Our LRO behavior does not fit the default behavior
+```
+
---
# Code Generation