diff --git a/specification/communication/data-plane/CallAutomation/stable/2024-09-15/communicationservicescallautomation.json b/specification/communication/data-plane/CallAutomation/stable/2024-09-15/communicationservicescallautomation.json index 15d613162960..3807bdd7a0fd 100644 --- a/specification/communication/data-plane/CallAutomation/stable/2024-09-15/communicationservicescallautomation.json +++ b/specification/communication/data-plane/CallAutomation/stable/2024-09-15/communicationservicescallautomation.json @@ -1,19 +1,13 @@ { "swagger": "2.0", "info": { - "version": "2024-09-15", "title": "Azure Communication Service Call Automation APIs", - "description": "Azure Communication Service Call Automation APIs" + "description": "Azure Communication Service Call Automation APIs", + "version": "2024-09-15" }, "schemes": [ "https" ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], "paths": { "/calling/callConnections": { "post": { @@ -21,33 +15,40 @@ "PreConnections" ], "summary": "Create an outbound call.", + "description": "Create an outbound call.", "operationId": "CreateCall", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "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", + "name": "Repeatability-Request-ID", "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", + "name": "Repeatability-First-Sent", "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" + }, + { + "in": "body", + "name": "createCallRequest", + "description": "The create call request.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateCallRequest" + } } ], "responses": { @@ -79,32 +80,38 @@ "summary": "Answer a Call.", "description": "Answer a call using the IncomingCallContext from Event Grid.", "operationId": "AnswerCall", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "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", + "name": "Repeatability-Request-ID", "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", + "name": "Repeatability-First-Sent", "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" + }, + { + "in": "body", + "name": "answerCallRequest", + "description": "The answer call request.", + "required": true, + "schema": { + "$ref": "#/definitions/AnswerCallRequest" + } } ], "responses": { @@ -134,33 +141,40 @@ "PreConnections" ], "summary": "Redirect a call.", + "description": "Redirect a call.", "operationId": "RedirectCall", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "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", + "name": "Repeatability-Request-ID", "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", + "name": "Repeatability-First-Sent", "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" + }, + { + "in": "body", + "name": "redirectCallRequest", + "description": "The redirect call request.", + "required": true, + "schema": { + "$ref": "#/definitions/RedirectCallRequest" + } } ], "responses": { @@ -187,33 +201,40 @@ "PreConnections" ], "summary": "Reject the call.", + "description": "Reject the call.", "operationId": "RejectCall", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "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", + "name": "Repeatability-Request-ID", "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", + "name": "Repeatability-First-Sent", "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" + }, + { + "in": "body", + "name": "rejectCallRequest", + "description": "The reject call request.", + "required": true, + "schema": { + "$ref": "#/definitions/RejectCallRequest" + } } ], "responses": { @@ -242,32 +263,38 @@ "summary": "Create a Connection to a CallLocator.", "description": "Create a connection to a CallLocator.", "operationId": "Connect", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "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", + "name": "Repeatability-Request-ID", "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", + "name": "Repeatability-First-Sent", "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" + }, + { + "in": "body", + "name": "connectRequest", + "description": "The create connection request.", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectRequest" + } } ], "responses": { @@ -298,16 +325,18 @@ ], "summary": "Get the detail properties of an ongoing call.", "operationId": "CallConnection_GetCall", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The call connection id.", + "name": "callConnectionId", "required": true, "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -335,17 +364,20 @@ "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", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The call connection id.", + "name": "callConnectionId", "required": true, "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -372,28 +404,31 @@ "MidConnections" ], "summary": "Terminate a call using CallConnectionId.", + "description": "Terminate a call using CallConnectionId.", "operationId": "CallConnection_TerminateCall", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The terminate call request.", + "name": "callConnectionId", "required": true, "type": "string" }, { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "Repeatability-Request-ID", "in": "header", + "name": "Repeatability-Request-ID", "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", + "name": "Repeatability-First-Sent", "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" @@ -423,40 +458,46 @@ "MidConnections" ], "summary": "Transfer the call to a participant.", + "description": "Transfer the call to a participant.", "operationId": "CallConnection_TransferToParticipant", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id.", - "required": true, - "type": "string" + "$ref": "#/parameters/ApiVersionParameter" }, { - "name": "transferToParticipantRequest", - "in": "body", - "description": "The transfer to participant request.", + "in": "path", + "name": "callConnectionId", "required": true, - "schema": { - "$ref": "#/definitions/TransferToParticipantRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" + "type": "string" }, { - "name": "Repeatability-Request-ID", "in": "header", + "name": "Repeatability-Request-ID", "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", + "name": "Repeatability-First-Sent", "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" + }, + { + "in": "body", + "name": "transferToParticipantRequest", + "description": "The transfer to participant request.", + "required": true, + "schema": { + "$ref": "#/definitions/TransferToParticipantRequest" + } } ], "responses": { @@ -488,25 +529,30 @@ "summary": "Plays audio to participants in the call.", "description": "Plays audio to participants in the call.", "operationId": "CallMedia_Play", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The call connection id.", + "name": "callConnectionId", "required": true, "type": "string" }, { - "name": "playRequest", "in": "body", + "name": "playRequest", "description": "play request payload.", "required": true, "schema": { "$ref": "#/definitions/PlayRequest" } - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -533,17 +579,20 @@ "MidConnections" ], "summary": "Cancel all media operations in a call.", + "description": "Cancel all media operations in a call.", "operationId": "CallMedia_CancelAllMediaOperations", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The call connection id", + "name": "callConnectionId", "required": true, "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -572,25 +621,30 @@ "summary": "Recognize media from call.", "description": "Recognize media from call.", "operationId": "CallMedia_Recognize", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The call connection id", + "name": "callConnectionId", "required": true, "type": "string" }, { - "name": "recognizeRequest", "in": "body", + "name": "recognizeRequest", "description": "The media recognize request", "required": true, "schema": { "$ref": "#/definitions/RecognizeRequest" } - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -618,25 +672,30 @@ ], "summary": "Start continuous Dtmf recognition by subscribing to tones.", "operationId": "CallMedia_StartContinuousDtmfRecognition", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The call connection id", + "name": "callConnectionId", "required": true, "type": "string" }, { - "name": "continuousDtmfRecognitionRequest", "in": "body", + "name": "continuousDtmfRecognitionRequest", "description": "The continuous recognize request", "required": true, "schema": { "$ref": "#/definitions/ContinuousDtmfRecognitionRequest" } - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -664,25 +723,30 @@ ], "summary": "Stop continuous Dtmf recognition by unsubscribing to tones.", "operationId": "CallMedia_StopContinuousDtmfRecognition", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The call connection id", + "name": "callConnectionId", "required": true, "type": "string" }, { - "name": "continuousDtmfRecognitionRequest", "in": "body", + "name": "continuousDtmfRecognitionRequest", "description": "The continuous recognize request", "required": true, "schema": { "$ref": "#/definitions/ContinuousDtmfRecognitionRequest" } - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -711,39 +775,44 @@ "summary": "Send dtmf tones.", "description": "Send dtmf tones.", "operationId": "CallMedia_SendDtmfTones", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The call connection id", + "name": "callConnectionId", "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", + "name": "Repeatability-Request-ID", "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", + "name": "Repeatability-First-Sent", "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" + }, + { + "in": "body", + "name": "sendDtmfTonesRequest", + "description": "The send dtmf tones request", + "required": true, + "schema": { + "$ref": "#/definitions/SendDtmfTonesRequest" + } } ], "responses": { @@ -775,25 +844,30 @@ "summary": "Hold participant from the call using identifier.", "description": "Hold participant from the call using identifier.", "operationId": "CallMedia_Hold", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The call connection id.", + "name": "callConnectionId", "required": true, "type": "string" }, { - "name": "holdRequest", "in": "body", + "name": "holdRequest", "description": "The participants to be hold from the call.", "required": true, "schema": { "$ref": "#/definitions/HoldRequest" } - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -822,25 +896,30 @@ "summary": "Unhold participants from the call using identifier.", "description": "Unhold participants from the call using identifier.", "operationId": "CallMedia_Unhold", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The call connection id.", + "name": "callConnectionId", "required": true, "type": "string" }, { - "name": "unholdRequest", "in": "body", + "name": "unholdRequest", "description": "The participants to be hold from the call.", "required": true, "schema": { "$ref": "#/definitions/UnholdRequest" } - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -867,17 +946,20 @@ "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", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The call connection Id", + "name": "callConnectionId", "required": true, "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -911,40 +993,45 @@ "MidConnections" ], "summary": "Add a participant to the call.", + "description": "Add a participant to the call.", "operationId": "CallConnection_AddParticipant", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", - "in": "path", - "description": "The call connection Id", - "required": true, - "type": "string" + "$ref": "#/parameters/ApiVersionParameter" }, { - "name": "addParticipantRequest", - "in": "body", - "description": "The add participants request.", + "in": "path", + "name": "callConnectionId", "required": true, - "schema": { - "$ref": "#/definitions/AddParticipantRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" + "type": "string" }, { - "name": "Repeatability-Request-ID", "in": "header", + "name": "Repeatability-Request-ID", "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", + "name": "Repeatability-First-Sent", "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" + }, + { + "in": "body", + "name": "addParticipantRequest", + "required": true, + "schema": { + "$ref": "#/definitions/AddParticipantRequest" + } } ], "responses": { @@ -974,40 +1061,46 @@ "MidConnections" ], "summary": "Remove a participant from the call using identifier.", + "description": "Remove a participant from the call using identifier.", "operationId": "CallConnection_RemoveParticipant", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id.", - "required": true, - "type": "string" + "$ref": "#/parameters/ApiVersionParameter" }, { - "name": "removeParticipantRequest", - "in": "body", - "description": "The participant to be removed from the call.", + "in": "path", + "name": "callConnectionId", "required": true, - "schema": { - "$ref": "#/definitions/RemoveParticipantRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" + "type": "string" }, { - "name": "Repeatability-Request-ID", "in": "header", + "name": "Repeatability-Request-ID", "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", + "name": "Repeatability-First-Sent", "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" + }, + { + "in": "body", + "name": "removeParticipantRequest", + "description": "The participant to be removed from the call.", + "required": true, + "schema": { + "$ref": "#/definitions/RemoveParticipantRequest" + } } ], "responses": { @@ -1037,40 +1130,46 @@ "MidConnections" ], "summary": "Mute participants from the call using identifier.", + "description": "Mute participants from the call using identifier.", "operationId": "CallConnection_Mute", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id.", - "required": true, - "type": "string" + "$ref": "#/parameters/ApiVersionParameter" }, { - "name": "muteParticipantsRequest", - "in": "body", - "description": "The participants to be muted from the call.", + "in": "path", + "name": "callConnectionId", "required": true, - "schema": { - "$ref": "#/definitions/MuteParticipantsRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" + "type": "string" }, { - "name": "Repeatability-Request-ID", "in": "header", + "name": "Repeatability-Request-ID", "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", + "name": "Repeatability-First-Sent", "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" + }, + { + "in": "body", + "name": "muteParticipantsRequest", + "description": "The participants to be muted from the call.", + "required": true, + "schema": { + "$ref": "#/definitions/MuteParticipantsRequest" + } } ], "responses": { @@ -1100,40 +1199,46 @@ "MidConnections" ], "summary": "Cancel add participant operation.", + "description": "Cancel add participant operation.", "operationId": "CallConnection_CancelAddParticipant", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", - "in": "path", - "description": "The call connection Id", - "required": true, - "type": "string" + "$ref": "#/parameters/ApiVersionParameter" }, { - "name": "cancelAddParticipantRequest", - "in": "body", - "description": "Cancellation request.", + "in": "path", + "name": "callConnectionId", "required": true, - "schema": { - "$ref": "#/definitions/CancelAddParticipantRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" + "type": "string" }, { - "name": "Repeatability-Request-ID", "in": "header", + "name": "Repeatability-Request-ID", "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", + "name": "Repeatability-First-Sent", "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" + }, + { + "in": "body", + "name": "cancelAddParticipantRequest", + "description": "Cancellation request.", + "required": true, + "schema": { + "$ref": "#/definitions/CancelAddParticipantRequest" + } } ], "responses": { @@ -1163,24 +1268,26 @@ "MidConnections" ], "summary": "Get participant from a call.", + "description": "Get participant from a call.", "operationId": "CallConnection_GetParticipant", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "callConnectionId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The call connection Id", + "name": "callConnectionId", "required": true, "type": "string" }, { - "name": "participantRawId", "in": "path", - "description": "Raw id of the participant to retrieve.", + "name": "participantRawId", "required": true, "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1211,32 +1318,38 @@ ], "summary": "Start recording the call.", "operationId": "CallRecording_StartRecording", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "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", + "name": "Repeatability-Request-ID", "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", + "name": "Repeatability-First-Sent", "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" + }, + { + "in": "body", + "name": "startCallRecording", + "description": "The request body of start call recording request.", + "required": true, + "schema": { + "$ref": "#/definitions/StartCallRecordingRequest" + } } ], "responses": { @@ -1267,16 +1380,18 @@ ], "summary": "Get call recording properties.", "operationId": "CallRecording_GetRecordingProperties", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "recordingId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The recording id.", + "name": "recordingId", "required": true, "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1305,16 +1420,18 @@ ], "summary": "Stop recording the call.", "operationId": "CallRecording_StopRecording", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "recordingId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The recording id.", + "name": "recordingId", "required": true, "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1342,16 +1459,18 @@ ], "summary": "Pause recording the call.", "operationId": "CallRecording_PauseRecording", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "recordingId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The recording id.", + "name": "recordingId", "required": true, "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1379,16 +1498,18 @@ ], "summary": "Resume recording the call.", "operationId": "CallRecording_ResumeRecording", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "recordingId", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "path", - "description": "The recording id.", + "name": "recordingId", "required": true, "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1411,149 +1532,125 @@ } }, "definitions": { - "CreateCallRequest": { - "description": "The request payload for creating the call.", - "required": [ - "targets", - "callbackUri" - ], + "AddParticipantFailed": { + "description": "The failed to add participants event.", "type": "object", "properties": { - "targets": { - "description": "The targets of the call.", - "type": "array", - "items": { - "$ref": "#/definitions/CommunicationIdentifierModel" - } + "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" }, + "participant": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } + }, + "additionalProperties": false + }, + "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 calling a PSTN callee." + "$ref": "#/definitions/PhoneNumberIdentifierModel" }, "sourceDisplayName": { - "description": "Display name of the call if dialing out to a pstn number", + "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" }, - "source": { - "$ref": "#/definitions/CommunicationUserIdentifierModel", - "description": "The identifier of the source of the call" + "participantToAdd": { + "$ref": "#/definitions/CommunicationIdentifierModel" + }, + "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": "A customer set value used to track the answering of a call.", + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", "type": "string" }, - "callbackUri": { - "description": "The callback URI.", + "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" }, - "callIntelligenceOptions": { - "$ref": "#/definitions/CallIntelligenceOptions", - "description": "AI options for the call." + "customCallingContext": { + "$ref": "#/definitions/CustomCallingContext" } - } - }, - "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" + }, + "additionalProperties": false }, - "CallIntelligenceOptions": { - "description": "AI options for the call.", + "AddParticipantResponse": { + "description": "The response payload for adding participants to the call.", "type": "object", "properties": { - "cognitiveServicesEndpoint": { - "description": "The identifier of the Cognitive Service resource assigned to this call.", + "participant": { + "$ref": "#/definitions/CallParticipant" + }, + "operationContext": { + "description": "The operation context provided by client.", + "type": "string" + }, + "invitationId": { + "description": "Invitation ID used to add a participant.", "type": "string" } - } - }, - "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 - } + }, + "additionalProperties": false }, - "CallConnectionProperties": { - "description": "Properties of a call connection", + "AddParticipantSucceeded": { + "description": "The participants successfully added event.", "type": "object", "properties": { "callConnectionId": { - "description": "The call connection id.", + "description": "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.", + "description": "Server call ID.", "type": "string" }, - "sourceCallerIdNumber": { - "$ref": "#/definitions/PhoneNumberIdentifierModel", - "description": "The source caller Id, a phone number, that's shown to the PSTN participant being invited.\r\nOnly populated in outbound PSTN calls." - }, - "sourceDisplayName": { - "description": "Display name of the call if dialing out to a pstn number.", + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", "type": "string" }, - "source": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Source identity." - }, - "correlationId": { - "description": "The correlation ID.", + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", "type": "string" }, - "answeredBy": { - "$ref": "#/definitions/CommunicationUserIdentifierModel", - "description": "Identity of the answering entity. Only populated when identity is provided in the request and an inbound call." + "resultInformation": { + "$ref": "#/definitions/ResultInformation" }, - "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 and an inbound call." + "participant": { + "$ref": "#/definitions/CommunicationIdentifierModel" } - } + }, + "additionalProperties": false }, "AnswerCallRequest": { "description": "The request payload for answering the call.", "required": [ - "incomingCallContext", - "callbackUri" + "callbackUri", + "incomingCallContext" ], "type": "object", "properties": { @@ -1570,944 +1667,739 @@ "type": "string" }, "callIntelligenceOptions": { - "$ref": "#/definitions/CallIntelligenceOptions", - "description": "AI options for the call." + "$ref": "#/definitions/CallIntelligenceOptions" }, "answeredBy": { - "$ref": "#/definitions/CommunicationUserIdentifierModel", - "description": "The identifier of the call automation entity which answers the call" + "$ref": "#/definitions/CommunicationUserIdentifierModel" } - } + }, + "additionalProperties": false }, - "RedirectCallRequest": { - "description": "The request payload for redirecting the call.", - "required": [ - "incomingCallContext", - "target" - ], + "AnswerFailed": { + "description": "The failed to answer call event.", "type": "object", "properties": { - "incomingCallContext": { - "description": "The context associated with the call.", + "callConnectionId": { + "description": "Call connection ID.", "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.", + "serverCallId": { + "description": "Server call ID.", "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.", + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", "type": "string" }, "operationContext": { - "description": "Used by customers to correlate the request to the response event.", + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", "type": "string" }, - "callIntelligenceOptions": { - "$ref": "#/definitions/CallIntelligenceOptions", - "description": "AI options for the call." + "resultInformation": { + "$ref": "#/definitions/ResultInformation" } - } - }, - "CallLocatorKind": { - "description": "The call locator kind.", - "enum": [ - "groupCallLocator", - "serverCallLocator", - "roomCallLocator" - ], - "type": "string", - "x-ms-enum": { - "name": "CallLocatorKind", - "modelAsString": true - } + }, + "additionalProperties": false }, - "CallLocator": { - "description": "The locator used for joining or taking action on a call", + "CallConnected": { + "description": "The call connected event.", "type": "object", "properties": { - "groupCallId": { - "description": "The group call id", + "callConnectionId": { + "description": "Call connection ID.", "type": "string" }, "serverCallId": { - "description": "The server call id.", + "description": "Server call ID.", "type": "string" }, - "roomId": { - "description": "The Acs room id", + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", "type": "string" }, - "kind": { - "$ref": "#/definitions/CallLocatorKind" + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation" } - } + }, + "additionalProperties": false }, - "TransferToParticipantRequest": { - "description": "The request payload for transferring call to a participant.", - "required": [ - "targetParticipant" - ], + "CallConnectionProperties": { + "description": "Properties of a call connection", "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.", + "callConnectionId": { + "description": "The call connection id.", "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.", + "serverCallId": { + "description": "The server call id.", "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.", + "targets": { + "description": "The targets of the call.", "type": "array", "items": { "$ref": "#/definitions/CommunicationIdentifierModel" } }, - "interruptCallMediaOperation": { - "description": "If set play can barge into other existing queued-up/currently-processing requests.", - "type": "boolean" + "callConnectionState": { + "$ref": "#/definitions/CallConnectionStateModel" }, - "playOptions": { - "$ref": "#/definitions/PlayOptions", - "description": "Defines options for playing the audio." + "callbackUri": { + "description": "The callback URI.", + "type": "string" }, - "operationContext": { - "description": "The value to identify context of the operation.", + "sourceCallerIdNumber": { + "$ref": "#/definitions/PhoneNumberIdentifierModel" + }, + "sourceDisplayName": { + "description": "Display name of the call if dialing out to a pstn number.", "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.", + "source": { + "$ref": "#/definitions/CommunicationIdentifierModel" + }, + "correlationId": { + "description": "The correlation ID.", "type": "string" + }, + "answeredBy": { + "$ref": "#/definitions/CommunicationUserIdentifierModel" + }, + "answeredFor": { + "$ref": "#/definitions/PhoneNumberIdentifierModel" } - } + }, + "additionalProperties": false }, - "PlaySourceType": { - "description": "Defines the type of the play source", + "CallConnectionStateModel": { + "description": "The states of a call connection.", "enum": [ - "file", - "text", - "ssml" + "unknown", + "connecting", + "connected", + "transferring", + "transferAccepted", + "disconnecting", + "disconnected" ], "type": "string", "x-ms-enum": { - "name": "PlaySourceType", + "name": "CallConnectionStateModel", "modelAsString": true } }, - "PlaySource": { - "required": [ - "kind" - ], + "CallDisconnected": { + "description": "The call disconnected event.", "type": "object", "properties": { - "kind": { - "$ref": "#/definitions/PlaySourceType" + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" }, - "playSourceCacheId": { - "description": "Defines the identifier to be used for caching related media", + "serverCallId": { + "description": "Server call ID.", "type": "string" }, - "file": { - "$ref": "#/definitions/FileSource", - "description": "Defines the file source info to be used for play" + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" }, - "text": { - "$ref": "#/definitions/TextSource", - "description": "Defines the text source info to be used for play" + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" }, - "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" + "resultInformation": { + "$ref": "#/definitions/ResultInformation" } - } + }, + "additionalProperties": false }, - "FileSource": { - "required": [ - "uri" - ], + "CallIntelligenceOptions": { + "description": "AI options for the call.", "type": "object", "properties": { - "uri": { - "description": "Uri for the audio file to be played", + "cognitiveServicesEndpoint": { + "description": "The identifier of the Cognitive Service resource assigned to this call.", "type": "string" } - } - }, - "VoiceKind": { - "description": "Voice kind type", - "enum": [ - "male", - "female" - ], - "type": "string", - "x-ms-enum": { - "name": "VoiceKind", - "modelAsString": true - } + }, + "additionalProperties": false }, - "TextSource": { - "required": [ - "text" - ], + "CallLocator": { + "description": "The locator used for joining or taking action on a call", "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: ", + "groupCallId": { + "description": "The group call id", "type": "string" }, - "voiceKind": { - "$ref": "#/definitions/VoiceKind" - }, - "voiceName": { - "description": "Voice name to be played\r\nRefer to available Text-to-speech voices here: ", + "serverCallId": { + "description": "The server call id.", "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", + "roomId": { + "description": "The Acs room id. (Not supported for Start Recording)", "type": "string" }, - "customVoiceEndpointId": { - "description": "Endpoint where the custom voice was deployed.", - "type": "string" + "kind": { + "$ref": "#/definitions/CallLocatorKind" } - } + }, + "additionalProperties": false }, - "RecognizeInputType": { - "description": "Determines the type of the recognition.", + "CallLocatorKind": { + "description": "The call locator kind", "enum": [ - "dtmf", - "speech", - "speechOrDtmf", - "choices" + "groupCallLocator", + "serverCallLocator", + "roomCallLocator" ], "type": "string", "x-ms-enum": { - "name": "RecognizeInputType", + "name": "CallLocatorKind", "modelAsString": true } }, - "RecognizeRequest": { - "required": [ - "recognizeInputType", - "recognizeOptions" - ], + "CallParticipant": { + "description": "A call participant.", "type": "object", "properties": { - "recognizeInputType": { - "$ref": "#/definitions/RecognizeInputType" - }, - "playPrompt": { - "$ref": "#/definitions/PlaySource", - "description": "The source of the audio to be played for recognition." - }, - "playPrompts": { - "description": "The source of the audio to be played for recognition.", - "type": "array", - "items": { - "$ref": "#/definitions/PlaySource" - } + "identifier": { + "$ref": "#/definitions/CommunicationIdentifierModel" }, - "interruptCallMediaOperation": { - "description": "If set recognize can barge into other existing queued-up/currently-processing requests.", + "isMuted": { + "description": "Is participant muted", "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.", + "isOnHold": { + "description": "Is participant on hold.", "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." } - } + }, + "additionalProperties": false }, - "Tone": { + "CallRejectReason": { + "description": "Reason of rejecting a call", "enum": [ - "zero", - "one", - "two", - "three", - "four", - "five", - "six", - "seven", - "eight", - "nine", - "a", - "b", - "c", - "d", - "pound", - "asterisk" + "none", + "busy", + "forbidden" ], "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" - } - } + "x-ms-enum": { + "name": "CallRejectReason", + "modelAsString": true } }, - "Choice": { - "required": [ - "label", - "phrases" - ], + "CallTransferAccepted": { + "description": "The call transfer accepted event.", "type": "object", "properties": { - "label": { - "description": "Identifier for a given choice", + "callConnectionId": { + "description": "Call connection ID.", "type": "string" }, - "phrases": { - "description": "List of phrases to recognize", - "type": "array", - "items": { - "type": "string" - } + "serverCallId": { + "description": "Server call ID.", + "type": "string" }, - "tone": { - "$ref": "#/definitions/Tone" + "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" + }, + "transferTarget": { + "$ref": "#/definitions/CommunicationIdentifierModel" + }, + "transferee": { + "$ref": "#/definitions/CommunicationIdentifierModel" } - } + }, + "additionalProperties": false }, - "SpeechOptions": { - "description": "Options for continuous speech recognition", + "CallTransferFailed": { + "description": "The call transfer failed event.", "type": "object", "properties": { - "endSilenceTimeoutInMs": { - "format": "int64", - "description": "The length of end silence when user stops speaking and cogservice send response.", - "type": "integer" + "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" } - } + }, + "additionalProperties": false }, - "ContinuousDtmfRecognitionRequest": { - "required": [ - "targetParticipant" - ], + "CancelAddParticipantFailed": { + "description": "Failed cancel add participant event.", "type": "object", "properties": { - "targetParticipant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Defines options for recognition." + "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": "The value to identify context of the operation.", + "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.", + "resultInformation": { + "$ref": "#/definitions/ResultInformation" + }, + "invitationId": { + "description": "Invitation ID used to cancel the request.", "type": "string" } - } + }, + "additionalProperties": false }, - "SendDtmfTonesRequest": { + "CancelAddParticipantRequest": { + "description": "Request payload for cancelling add participant request.", "required": [ - "tones", - "targetParticipant" + "invitationId" ], "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." + "invitationId": { + "description": "Invitation ID used to add a participant.", + "type": "string" }, "operationContext": { - "description": "The value to identify context of the operation.", + "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" } - } + }, + "additionalProperties": false }, - "SendDtmfTonesResult": { + "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" } - } + }, + "additionalProperties": false }, - "HoldRequest": { - "description": "The request payload for holding participant from the call.", - "required": [ - "targetParticipant" - ], + "CancelAddParticipantSucceeded": { + "description": "Successful cancel add participant event.", "type": "object", "properties": { - "targetParticipant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Participant to be held from the call." + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" }, - "playSourceInfo": { - "$ref": "#/definitions/PlaySource", - "description": "Prompt to play while in hold." + "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" }, - "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.", + "invitationId": { + "description": "Invitation ID used to cancel the request.", "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation" } - } + }, + "additionalProperties": false }, - "UnholdRequest": { - "description": "The request payload for holding participant from the call.", + "ChannelAffinity": { + "description": "Channel affinity for a participant", "required": [ - "targetParticipant" + "participant" ], "type": "object", "properties": { - "targetParticipant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Participants to be hold from the call.\r\nOnly ACS Users are supported." + "channel": { + "format": "int32", + "description": "Channel number to which bitstream from a particular participant will be written.", + "maximum": 4, + "minimum": 0, + "type": "integer" }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" + "participant": { + "$ref": "#/definitions/CommunicationIdentifierModel" } - } + }, + "additionalProperties": false }, - "GetParticipantsResponse": { - "description": "The response payload for getting participants of the call.", + "Choice": { "required": [ - "value" + "label", + "phrases" ], "type": "object", "properties": { - "value": { - "description": "List of the current participants in the call.", + "label": { + "description": "Identifier for a given choice", + "type": "string" + }, + "phrases": { + "description": "List of phrases to recognize", "type": "array", "items": { - "$ref": "#/definitions/CallParticipant" + "type": "string" } }, - "nextLink": { - "description": "Continue of the list of participants", - "type": "string" + "tone": { + "$ref": "#/definitions/Tone" } - } + }, + "additionalProperties": false }, - "CallParticipant": { - "description": "A call participant.", + "ChoiceResult": { "type": "object", "properties": { - "identifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Communication identifier of the participant" - }, - "isMuted": { - "description": "Is participant muted", - "type": "boolean" + "label": { + "description": "Label is the primary identifier for the choice detected", + "type": "string" }, - "isOnHold": { - "description": "Is participant on hold.", - "type": "boolean" + "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" } - } + }, + "additionalProperties": false }, - "AddParticipantRequest": { - "description": "The request payload for adding participant to the call.", - "required": [ - "participantToAdd" - ], + "CommunicationError": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationError" + }, + "CommunicationErrorResponse": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationErrorResponse" + }, + "CommunicationIdentifierModel": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" + }, + "CommunicationUserIdentifierModel": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationUserIdentifierModel" + }, + "ConnectFailed": { + "description": "The ConnectFailed event.", "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.", + "callConnectionId": { + "description": "Call connection ID.", "type": "string" }, - "participantToAdd": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The participant to invite." + "serverCallId": { + "description": "Server call ID.", + "type": "string" }, - "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" + "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" }, - "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" + "resultInformation": { + "$ref": "#/definitions/ResultInformation" } - } + }, + "additionalProperties": false }, - "AddParticipantResponse": { - "description": "The response payload for adding participants to the call.", + "ConnectRequest": { + "description": "The request payload for creating a connection to a CallLocator.", + "required": [ + "callbackUri", + "callLocator" + ], "type": "object", "properties": { - "participant": { - "$ref": "#/definitions/CallParticipant", - "description": "List of current participants in the call." + "callLocator": { + "$ref": "#/definitions/CallLocator" }, - "operationContext": { - "description": "The operation context provided by client.", + "callbackUri": { + "description": "The callback URI.", "type": "string" }, - "invitationId": { - "description": "Invitation ID used to add a participant.", + "operationContext": { + "description": "Used by customers to correlate the request to the response event.", "type": "string" + }, + "callIntelligenceOptions": { + "$ref": "#/definitions/CallIntelligenceOptions" } - } + }, + "additionalProperties": false }, - "RemoveParticipantRequest": { - "description": "The remove participant by identifier request.", + "ContinuousDtmfRecognitionRequest": { "required": [ - "participantToRemove" + "targetParticipant" ], "type": "object", "properties": { - "participantToRemove": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The participants to be removed from the call." + "targetParticipant": { + "$ref": "#/definitions/CommunicationIdentifierModel" }, "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "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" } - } + }, + "additionalProperties": false }, - "RemoveParticipantResponse": { - "description": "The response payload for removing participants of the call.", + "ContinuousDtmfRecognitionStopped": { "type": "object", "properties": { - "operationContext": { - "description": "The operation context provided by client.", + "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" - } - } - }, - "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" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation" } - } + }, + "additionalProperties": false }, - "MuteParticipantsResult": { - "description": "The result payload for muting participants from the call.", + "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. Also called ChainId for skype chain ID.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation" + }, "operationContext": { - "description": "The operation context provided by client.", + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", "type": "string" } - } + }, + "additionalProperties": false }, - "CancelAddParticipantRequest": { - "description": "Request payload for cancelling add participant request.", - "required": [ - "invitationId" - ], + "ContinuousDtmfRecognitionToneReceived": { "type": "object", "properties": { - "invitationId": { - "description": "Invitation ID used to add a participant.", + "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 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" }, - "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" + "resultInformation": { + "$ref": "#/definitions/ResultInformation" } - } + }, + "additionalProperties": false }, - "CancelAddParticipantResponse": { - "description": "Response payload for cancel add participant request.", + "CreateCallFailed": { + "description": "The create call failed event.", "type": "object", "properties": { - "invitationId": { - "description": "Invitation ID used to cancel the add participant action.", + "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": "The operation context provided by client.", + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation" } - } - }, - "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 - } + }, + "additionalProperties": false }, - "StartCallRecordingRequest": { - "description": "The request payload start for call recording operation with call locator.", + "CreateCallRequest": { + "description": "The request payload for creating the call.", "required": [ - "callLocator" + "callbackUri", + "targets" ], "type": "object", "properties": { - "callLocator": { - "$ref": "#/definitions/CallLocator", - "description": "The call locator." + "targets": { + "description": "The targets of the call.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } }, - "recordingStateCallbackUri": { - "description": "The uri to send notifications to.", + "sourceCallerIdNumber": { + "$ref": "#/definitions/PhoneNumberIdentifierModel" + }, + "sourceDisplayName": { + "description": "Display name of the call if dialing out to a pstn number", "type": "string" }, - "recordingContentType": { - "$ref": "#/definitions/RecordingContentType" + "source": { + "$ref": "#/definitions/CommunicationUserIdentifierModel" }, - "recordingChannelType": { - "$ref": "#/definitions/RecordingChannelType" + "operationContext": { + "description": "A customer set value used to track the answering of a call.", + "type": "string" }, - "recordingFormatType": { - "$ref": "#/definitions/RecordingFormatType" + "callbackUri": { + "description": "The callback URI.", + "type": "string" }, - "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" + "callIntelligenceOptions": { + "$ref": "#/definitions/CallIntelligenceOptions" + } + }, + "additionalProperties": false + }, + "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" } }, - "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" + "sipHeaders": { + "description": "Custom calling context SIP headers", + "type": "object", + "additionalProperties": { + "type": "string" } - }, - "pauseOnStart": { - "description": "When set to true will start recording in Pause mode, which can be resumed.", - "type": "boolean" - }, - "externalStorage": { - "$ref": "#/definitions/ExternalStorage", - "description": "Optional property to specify location where recording will be stored" } - } + }, + "additionalProperties": false }, - "ChannelAffinity": { - "description": "Channel affinity for a participant", - "required": [ - "participant" - ], + "DtmfOptions": { + "description": "Options for DTMF recognition", "type": "object", "properties": { - "channel": { + "interToneTimeoutInSeconds": { + "format": "int32", + "description": "Time to wait between DTMF inputs to stop recognizing.", + "maximum": 60, + "minimum": 1, + "type": "integer" + }, + "maxTonesToCollect": { "format": "int32", - "description": "Channel number to which bitstream from a particular participant will be written.", - "maximum": 4, - "minimum": 0, + "description": "Maximum number of DTMF tones to be collected.", "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." + "stopTones": { + "description": "List of tones that will stop recognizing.", + "type": "array", + "items": { + "$ref": "#/definitions/Tone" + } } - } + }, + "additionalProperties": false }, - "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" + "DtmfResult": { + "type": "object", + "properties": { + "tones": { + "type": "array", + "items": { + "$ref": "#/definitions/Tone" }, - { - "name": "AzureBlobStorage", - "description": "Storage managed by provided Azure blob", - "value": "AzureBlobStorage" - } - ] - } + "readOnly": true + } + }, + "additionalProperties": false }, "ExternalStorage": { "required": [ @@ -2523,64 +2415,44 @@ "description": "Uri of a container or a location within a container", "type": "string" } - } + }, + "additionalProperties": false }, - "RecordingState": { - "enum": [ - "active", - "inactive" + "FileSource": { + "required": [ + "uri" ], - "type": "string", - "x-ms-enum": { - "name": "RecordingState", - "modelAsString": true - } + "type": "object", + "properties": { + "uri": { + "description": "Uri for the audio file to be played", + "type": "string" + } + }, + "additionalProperties": false }, - "RecordingKind": { - "enum": [ - "azureCommunicationServices", - "teams", - "teamsCompliance" + "GetParticipantsResponse": { + "description": "The response payload for getting participants of the call.", + "required": [ + "value" ], - "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" + "value": { + "description": "List of the current participants in the call.", + "type": "array", + "items": { + "$ref": "#/definitions/CallParticipant" + } }, - "recordingKind": { - "$ref": "#/definitions/RecordingKind" + "nextLink": { + "description": "Continue of the list of participants", + "type": "string" } - } + }, + "additionalProperties": false }, - "AddParticipantFailed": { - "description": "The failed to add participants event.", + "HoldFailed": { "type": "object", "properties": { "callConnectionId": { @@ -2600,38 +2472,80 @@ "type": "string" }, "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." - }, - "participant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Participant" + "$ref": "#/definitions/ResultInformation" } - } + }, + "additionalProperties": false }, - "ResultInformation": { + "HoldRequest": { + "description": "The request payload for holding participant from the call.", + "required": [ + "targetParticipant" + ], "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" + "targetParticipant": { + "$ref": "#/definitions/CommunicationIdentifierModel" }, - "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" + "playSourceInfo": { + "$ref": "#/definitions/PlaySource" }, - "message": { - "description": "Detail message that describes the current result.", + "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" } - } + }, + "additionalProperties": false }, - "AddParticipantSucceeded": { - "description": "The participants successfully added event.", + "MicrosoftTeamsAppIdentifierModel": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/MicrosoftTeamsAppIdentifierModel" + }, + "MicrosoftTeamsUserIdentifierModel": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/MicrosoftTeamsUserIdentifierModel" + }, + "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" + } + }, + "additionalProperties": false + }, + "MuteParticipantsResult": { + "description": "The result payload for muting participants from the call.", + "type": "object", + "properties": { + "operationContext": { + "description": "The operation context provided by client.", + "type": "string" + } + }, + "additionalProperties": false + }, + "ParticipantsUpdated": { + "description": "The participants updated in a call event.", "type": "object", "properties": { + "operationContext": { + "type": "string" + }, "callConnectionId": { "description": "Call connection ID.", "type": "string" @@ -2644,22 +2558,28 @@ "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" + "sequenceNumber": { + "format": "int32", + "description": "The Sequence Number of the event", + "type": "integer" }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." + "participants": { + "description": "The list of participants in the call.", + "type": "array", + "items": { + "$ref": "#/definitions/CallParticipant" + } }, - "participant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Participant" + "resultInformation": { + "$ref": "#/definitions/ResultInformation" } - } + }, + "additionalProperties": false }, - "CallConnected": { - "description": "The call connected event.", + "PhoneNumberIdentifierModel": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/PhoneNumberIdentifierModel" + }, + "PlayCanceled": { "type": "object", "properties": { "callConnectionId": { @@ -2675,17 +2595,16 @@ "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.", + "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." + "$ref": "#/definitions/ResultInformation" } - } + }, + "additionalProperties": false }, - "CallDisconnected": { - "description": "The call disconnected event.", + "PlayCompleted": { "type": "object", "properties": { "callConnectionId": { @@ -2701,17 +2620,16 @@ "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.", + "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." + "$ref": "#/definitions/ResultInformation" } - } + }, + "additionalProperties": false }, - "CallTransferAccepted": { - "description": "The call transfer accepted event.", + "PlayFailed": { "type": "object", "properties": { "callConnectionId": { @@ -2731,81 +2649,107 @@ "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." + "$ref": "#/definitions/ResultInformation" }, - "transferee": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "the participant who is being transferred away." + "failedPlaySourceIndex": { + "format": "int32", + "description": "Contains the index of the failed play source.", + "type": "integer" } - } + }, + "additionalProperties": false }, - "CallTransferFailed": { - "description": "The call transfer failed event.", + "PlayOptions": { + "required": [ + "loop" + ], "type": "object", "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" + "loop": { + "description": "The option to play the provided audio source in loop when set to true", + "type": "boolean" + } + }, + "additionalProperties": false + }, + "PlayRequest": { + "required": [ + "playSources" + ], + "type": "object", + "properties": { + "playSources": { + "description": "The source of the audio to be played.", + "type": "array", + "items": { + "$ref": "#/definitions/PlaySource" + } }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" + "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" + } }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" + "interruptCallMediaOperation": { + "description": "If set play can barge into other existing queued-up/currently-processing requests.", + "type": "boolean" + }, + "playOptions": { + "$ref": "#/definitions/PlayOptions" }, "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "description": "The value to identify context of the operation.", "type": "string" }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." + "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" } - } + }, + "additionalProperties": false }, - "ParticipantsUpdated": { - "description": "The participants updated in a call event.", + "PlaySource": { + "required": [ + "kind" + ], "type": "object", "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" + "kind": { + "$ref": "#/definitions/PlaySourceType" }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "playSourceCacheId": { + "description": "Defines the identifier to be used for caching related media", "type": "string" }, - "sequenceNumber": { - "format": "int32", - "description": "The Sequence Number of the event", - "type": "integer" + "file": { + "$ref": "#/definitions/FileSource" }, - "participants": { - "description": "The list of participants in the call.", - "type": "array", - "items": { - "$ref": "#/definitions/CallParticipant" - } + "text": { + "$ref": "#/definitions/TextSource" }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." + "ssml": { + "$ref": "#/definitions/SsmlSource" } + }, + "additionalProperties": false + }, + "PlaySourceType": { + "description": "Defines the types of play source", + "enum": [ + "file", + "text", + "ssml" + ], + "type": "string", + "x-ms-enum": { + "name": "PlaySourceType", + "modelAsString": true } }, - "RemoveParticipantSucceeded": { - "description": "The participant removed event.", + "PlayStarted": { + "description": "Play started event.", "type": "object", "properties": { "callConnectionId": { @@ -2825,17 +2769,25 @@ "type": "string" }, "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." - }, - "participant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Participant" + "$ref": "#/definitions/ResultInformation" } + }, + "additionalProperties": false + }, + "RecognitionType": { + "description": "Recognition type determines the sub-type of the recognition operation\r\nPossible values will be Dtmf, Speech, or Choices", + "enum": [ + "dtmf", + "speech", + "choices" + ], + "type": "string", + "x-ms-enum": { + "name": "RecognitionType", + "modelAsString": true } }, - "RemoveParticipantFailed": { - "description": "The failed to remove participant event.", + "RecognizeCanceled": { "type": "object", "properties": { "callConnectionId": { @@ -2855,17 +2807,12 @@ "type": "string" }, "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." - }, - "participant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Participant" + "$ref": "#/definitions/ResultInformation" } - } + }, + "additionalProperties": false }, - "CancelAddParticipantSucceeded": { - "description": "Successful cancel add participant event.", + "RecognizeCompleted": { "type": "object", "properties": { "callConnectionId": { @@ -2884,18 +2831,25 @@ "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" - }, "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." + "$ref": "#/definitions/ResultInformation" + }, + "recognitionType": { + "$ref": "#/definitions/RecognitionType" + }, + "dtmfResult": { + "$ref": "#/definitions/DtmfResult" + }, + "choiceResult": { + "$ref": "#/definitions/ChoiceResult" + }, + "speechResult": { + "$ref": "#/definitions/SpeechResult" } - } + }, + "additionalProperties": false }, - "CancelAddParticipantFailed": { - "description": "Failed cancel add participant event.", + "RecognizeFailed": { "type": "object", "properties": { "callConnectionId": { @@ -2915,70 +2869,177 @@ "type": "string" }, "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services." + "$ref": "#/definitions/ResultInformation" }, - "invitationId": { - "description": "Invitation ID used to cancel the request.", - "type": "string" + "failedPlaySourceIndex": { + "format": "int32", + "description": "Contains the index of the failed play source.", + "type": "integer" } + }, + "additionalProperties": false + }, + "RecognizeInputType": { + "description": "Defines the type of the recognize input", + "enum": [ + "dtmf", + "speech", + "speechOrDtmf", + "choices" + ], + "type": "string", + "x-ms-enum": { + "name": "RecognizeInputType", + "modelAsString": true } }, - "AnswerFailed": { - "description": "The failed to answer call event.", + "RecognizeOptions": { + "required": [ + "targetParticipant" + ], "type": "object", "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" + "interruptPrompt": { + "description": "Determines if we interrupt the prompt and start recognizing.", + "type": "boolean" }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" + "initialSilenceTimeoutInSeconds": { + "format": "int32", + "description": "Time to wait for first input after prompt (if any).", + "maximum": 300, + "minimum": 0, + "type": "integer" }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "targetParticipant": { + "$ref": "#/definitions/CommunicationIdentifierModel" + }, + "speechLanguage": { + "description": "Speech language to be recognized, If not set default is en-US", "type": "string" }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "speechRecognitionModelEndpointId": { + "description": "Endpoint where the custom model was deployed.", "type": "string" }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." + "dtmfOptions": { + "$ref": "#/definitions/DtmfOptions" + }, + "choices": { + "description": "Defines Ivr choices for recognize.", + "type": "array", + "items": { + "$ref": "#/definitions/Choice" + } + }, + "speechOptions": { + "$ref": "#/definitions/SpeechOptions" } - } + }, + "additionalProperties": false }, - "CreateCallFailed": { - "description": "The create call failed event.", + "RecognizeRequest": { + "required": [ + "recognizeInputType", + "recognizeOptions" + ], "type": "object", "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" + "recognizeInputType": { + "$ref": "#/definitions/RecognizeInputType" }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" + "playPrompt": { + "$ref": "#/definitions/PlaySource" }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" + "playPrompts": { + "description": "The source of the audio to be played for recognition.", + "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" }, "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "description": "The value to identify context of the operation.", "type": "string" }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." + "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" } + }, + "additionalProperties": false + }, + "RecordingChannelType": { + "description": "Defines the channel type of call recording.", + "enum": [ + "mixed", + "unmixed" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingChannelType", + "modelAsString": true + } + }, + "RecordingContentType": { + "enum": [ + "audio", + "audioVideo" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingContentType", + "modelAsString": true + } + }, + "RecordingFormatType": { + "description": "Defines the format type of call recording.", + "enum": [ + "wav", + "mp3", + "mp4" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingFormatType", + "modelAsString": true + } + }, + "RecordingKind": { + "enum": [ + "azureCommunicationServices", + "teams", + "teamsCompliance" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingKind", + "modelAsString": true + } + }, + "RecordingState": { + "enum": [ + "active", + "inactive" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingState", + "modelAsString": true } }, "RecordingStateChanged": { "type": "object", "properties": { + "operationContext": { + "type": "string" + }, "callConnectionId": { "description": "Call connection ID.", "type": "string" @@ -2988,7 +3049,7 @@ "type": "string" }, "correlationId": { - "description": "Correlation ID for event to call correlation.", + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", "type": "string" }, "recordingId": { @@ -3009,93 +3070,74 @@ "$ref": "#/definitions/RecordingKind" }, "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." + "$ref": "#/definitions/ResultInformation" } - } + }, + "additionalProperties": false }, - "PlayStarted": { - "description": "Play started event.", + "RecordingStateResponse": { "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.", + "recordingId": { "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" + "recordingState": { + "$ref": "#/definitions/RecordingState" }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Gets or sets contains the resulting SIP code, sub-code and message." + "recordingKind": { + "$ref": "#/definitions/RecordingKind" } + }, + "additionalProperties": false + }, + "RecordingStorageKind": { + "enum": [ + "azureCommunicationServices", + "azureBlobStorage" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingStorageKind", + "modelAsString": true } }, - "PlayCompleted": { + "RedirectCallRequest": { + "description": "The request payload for redirecting the call.", + "required": [ + "incomingCallContext", + "target" + ], "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.", + "incomingCallContext": { + "description": "The context associated with the call.", "type": "string" }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." + "target": { + "$ref": "#/definitions/CommunicationIdentifierModel" } - } + }, + "additionalProperties": false }, - "PlayFailed": { + "RejectCallRequest": { + "description": "The request payload for rejecting the call.", + "required": [ + "incomingCallContext" + ], "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.", + "incomingCallContext": { + "description": "The context associated with the call.", "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" + "callRejectReason": { + "$ref": "#/definitions/CallRejectReason" } - } + }, + "additionalProperties": false }, - "PlayCanceled": { + "RemoveParticipantFailed": { + "description": "The failed to remove participant event.", "type": "object", "properties": { "callConnectionId": { @@ -3107,7 +3149,7 @@ "type": "string" }, "correlationId": { - "description": "Correlation ID for event to call correlation.", + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", "type": "string" }, "operationContext": { @@ -3115,131 +3157,48 @@ "type": "string" }, "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." + "$ref": "#/definitions/ResultInformation" + }, + "participant": { + "$ref": "#/definitions/CommunicationIdentifierModel" } - } + }, + "additionalProperties": false }, - "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" + "RemoveParticipantRequest": { + "description": "The remove participant by identifier request.", + "required": [ + "participantToRemove" ], - "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" + "participantToRemove": { + "$ref": "#/definitions/CommunicationIdentifierModel" }, "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.", + "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" } - } + }, + "additionalProperties": false }, - "RecognizeFailed": { + "RemoveParticipantResponse": { + "description": "The response payload for removing participants of the call.", "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.", + "description": "The operation context provided by client.", "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" } - } + }, + "additionalProperties": false }, - "RecognizeCanceled": { + "RemoveParticipantSucceeded": { + "description": "The participant removed event.", "type": "object", "properties": { "callConnectionId": { @@ -3251,7 +3210,7 @@ "type": "string" }, "correlationId": { - "description": "Correlation ID for event to call correlation.", + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", "type": "string" }, "operationContext": { @@ -3259,48 +3218,43 @@ "type": "string" }, "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." + "$ref": "#/definitions/ResultInformation" + }, + "participant": { + "$ref": "#/definitions/CommunicationIdentifierModel" } - } + }, + "additionalProperties": false }, - "ContinuousDtmfRecognitionToneFailed": { + "ResultInformation": { "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" + "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" }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." + "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" }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "message": { + "description": "Detail message that describes the current result.", "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" + "sipDetails": { + "$ref": "#/definitions/SipDiagnosticInfo" }, + "q850Details": { + "$ref": "#/definitions/SipDiagnosticInfo" + } + }, + "additionalProperties": false + }, + "SendDtmfTonesCompleted": { + "type": "object", + "properties": { "callConnectionId": { "description": "Call connection ID.", "type": "string" @@ -3310,20 +3264,20 @@ "type": "string" }, "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId or skype chain ID.", + "description": "Correlation ID for event to call correlation. Also called ChainId for 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" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation" } - } + }, + "additionalProperties": false }, - "ContinuousDtmfRecognitionStopped": { + "SendDtmfTonesFailed": { "type": "object", "properties": { "callConnectionId": { @@ -3335,7 +3289,7 @@ "type": "string" }, "correlationId": { - "description": "Correlation ID for event to call correlation.", + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", "type": "string" }, "operationContext": { @@ -3343,126 +3297,289 @@ "type": "string" }, "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." + "$ref": "#/definitions/ResultInformation" } - } + }, + "additionalProperties": false }, - "SendDtmfTonesCompleted": { + "SendDtmfTonesRequest": { + "required": [ + "targetParticipant", + "tones" + ], "type": "object", "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" + "tones": { + "description": "List of tones to be sent to target participant.", + "type": "array", + "items": { + "$ref": "#/definitions/Tone" + } }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" + "targetParticipant": { + "$ref": "#/definitions/CommunicationIdentifierModel" }, - "correlationId": { - "description": "Correlation ID for event to call correlation.", + "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" + } + }, + "additionalProperties": false + }, + "SendDtmfTonesResult": { + "type": "object", + "properties": { "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "description": "The operation context provided by client.", "type": "string" + } + }, + "additionalProperties": false + }, + "SipDiagnosticInfo": { + "type": "object", + "properties": { + "code": { + "format": "int32", + "description": "Represents the diagnostic code returned by the SIP service, used for identifying specific issues or statuses.", + "type": "integer" }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." + "message": { + "description": "Message associated with the code for diagnosing.", + "type": "string" } - } + }, + "additionalProperties": false }, - "SendDtmfTonesFailed": { + "SpeechOptions": { + "description": "Options for continuous speech recognition", "type": "object", "properties": { - "callConnectionId": { - "description": "Call connection ID.", + "endSilenceTimeoutInMs": { + "format": "int64", + "description": "The length of end silence when user stops speaking and cogservice send response.", + "type": "integer" + } + }, + "additionalProperties": false + }, + "SpeechResult": { + "description": "The speech status as a result.", + "type": "object", + "properties": { + "speech": { + "description": "The recognized speech in string.", "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", + } + }, + "additionalProperties": false + }, + "SsmlSource": { + "required": [ + "ssmlText" + ], + "type": "object", + "properties": { + "ssmlText": { + "description": "Ssml string for the cognitive service to be played", "type": "string" }, - "correlationId": { - "description": "Correlation ID for event to call correlation.", + "customVoiceEndpointId": { + "description": "Endpoint where the custom voice was deployed.", "type": "string" + } + }, + "additionalProperties": false + }, + "StartCallRecordingRequest": { + "description": "The request payload start for call recording operation with call locator.", + "required": [ + "callLocator" + ], + "type": "object", + "properties": { + "callLocator": { + "$ref": "#/definitions/CallLocator" }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "recordingStateCallbackUri": { + "description": "The uri to send notifications to.", "type": "string" }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." + "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" } - } + }, + "additionalProperties": false }, - "HoldFailed": { + "TextSource": { + "required": [ + "text" + ], "type": "object", "properties": { - "callConnectionId": { - "description": "Call connection ID.", + "text": { + "description": "Text for the cognitive service to be played", "type": "string" }, - "serverCallId": { - "description": "Server call ID.", + "sourceLocale": { + "description": "Source language locale to be played\r\nRefer to available locales here: ", "type": "string" }, - "correlationId": { - "description": "Correlation ID for event to call correlation.", - "type": "string" + "voiceKind": { + "$ref": "#/definitions/VoiceKind" }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "voiceName": { + "description": "Voice name to be played\r\nRefer to available Text-to-speech voices here: ", "type": "string" }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." + "customVoiceEndpointId": { + "description": "Endpoint where the custom voice was deployed.", + "type": "string" } + }, + "additionalProperties": false + }, + "Tone": { + "description": "List of valid stop tones", + "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 } }, - "ConnectFailed": { - "description": "The ConnectFailed event.", + "TransferCallResponse": { + "description": "The response payload for transferring the call.", "type": "object", "properties": { - "callConnectionId": { - "description": "Call connection ID.", + "operationContext": { + "description": "The operation context provided by client.", "type": "string" + } + }, + "additionalProperties": false + }, + "TransferToParticipantRequest": { + "description": "The request payload for transferring call to a participant.", + "required": [ + "targetParticipant" + ], + "type": "object", + "properties": { + "targetParticipant": { + "$ref": "#/definitions/CommunicationIdentifierModel" }, - "serverCallId": { - "description": "Server call ID.", + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", "type": "string" }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "transferee": { + "$ref": "#/definitions/CommunicationIdentifierModel" + }, + "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" + }, + "sourceCallerIdNumber": { + "$ref": "#/definitions/PhoneNumberIdentifierModel" + } + }, + "additionalProperties": false + }, + "UnholdRequest": { + "description": "The request payload for holding participant from the call.", + "required": [ + "targetParticipant" + ], + "type": "object", + "properties": { + "targetParticipant": { + "$ref": "#/definitions/CommunicationIdentifierModel" + }, "operationContext": { - "description": "Used by customers to correlate the request to the response event.", + "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." } + }, + "additionalProperties": false + }, + "VoiceKind": { + "description": "Audio kind type", + "enum": [ + "male", + "female" + ], + "type": "string", + "x-ms-enum": { + "name": "VoiceKind", + "modelAsString": true } } }, "parameters": { "ApiVersionParameter": { - "name": "api-version", "in": "query", - "description": "Version of API to invoke.", + "name": "api-version", + "description": "Version of the 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.", + "name": "endpoint", + "description": "The endpoint of the Azure Communication Service resource.", "required": true, "type": "string", "format": "url", @@ -3473,9 +3590,9 @@ "securityDefinitions": { "Authorization": { "type": "apiKey", - "description": "An Azure Communication Services user access token.", "name": "Authorization", - "in": "header" + "in": "header", + "description": "An Azure Communication Services user access token." } }, "security": [