Azure Communication Service Call Automation APIs (preview:2025-03-30)

2025/05/15 • 33 new methods

CreateCall (new)
Description :  Create an outbound call.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections
{
createCallRequest:
{
Description: The create call request. ,
Required: True ,
}
{
targets:
{
Description: The targets of the call. ,
Required: True ,
}
[
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
sourceCallerIdNumber:
{
Description: The source caller Id, a phone number, that's shown to the PSTN participant being invited. Required only when calling a PSTN callee. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
sourceDisplayName:
{
Description: Display name of the call if dialing out to a pstn number ,
Required: False ,
}
string ,
source:
{
Description: The identifier of the source of the call ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
operationContext:
{
Description: A customer set value used to track the answering of a call. ,
Required: False ,
}
string ,
callbackUri:
{
Description: The callback URI. ,
Required: True ,
}
string ,
callIntelligenceOptions:
{
Description: AI options for the call. ,
Required: False ,
}
{
cognitiveServicesEndpoint:
{
Description: The identifier of the Cognitive Service resource assigned to this call. ,
Required: False ,
}
string ,
}
,
mediaStreamingOptions:
{
Description: Media Streaming Options. ,
Required: False ,
}
{
transportUrl:
{
Description: Transport URL for media streaming ,
Required: True ,
}
string ,
transportType:
{
Description: The type of transport to be used for media streaming, eg. Websocket ,
Enum:
{
websocket: No description available. ,
}
,
Required: True ,
}
enum ,
contentType:
{
Description: Content type to stream, eg. audio ,
Enum:
{
audio: No description available. ,
}
,
Required: True ,
}
enum ,
audioChannelType:
{
Description: Audio channel type to stream, eg. unmixed audio, mixed audio ,
Enum:
{
mixed: No description available. ,
unmixed: No description available. ,
}
,
Required: True ,
}
enum ,
startMediaStreaming:
{
Description: Determines if the media streaming should be started immediately after call is answered or not. ,
Required: False ,
}
boolean ,
enableBidirectional:
{
Description: A value indicating whether bidirectional streaming is enabled. ,
Required: False ,
}
boolean ,
audioFormat:
{
Description: Specifies the audio format used for encoding, including sample rate and channel type. ,
Enum:
{
pcm16KMono: No description available. ,
pcm24KMono: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
transcriptionOptions:
{
Description: Transcription Options. ,
Required: False ,
}
{
transportUrl:
{
Description: Transport URL for live transcription ,
Required: True ,
}
string ,
transportType:
{
Description: The type of transport to be used for live transcription, eg. Websocket ,
Enum:
{
websocket: No description available. ,
}
,
Required: True ,
}
enum ,
locale:
{
Description: Defines the locale for the data e.g en-CA, en-AU ,
Required: True ,
}
string ,
speechRecognitionModelEndpointId:
{
Description: Endpoint where the custom model was deployed. ,
Required: False ,
}
string ,
startTranscription:
{
Description: Determines if the transcription should be started immediately after call is answered or not. ,
Required: True ,
}
boolean ,
enableIntermediateResults:
{
Description: Enables intermediate results for the transcribed speech. ,
Required: False ,
}
boolean ,
}
,
teamsAppSource:
{
Description: The identifier of the source for creating call with Teams resource account ID. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
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. ,
Format: uuid ,
Required: False ,
}
string ,
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
callConnectionId:
{
Description: The call connection id. ,
Required: False ,
}
string ,
serverCallId:
{
Description: The server call id. ,
Required: False ,
}
string ,
targets:
{
Description: The targets of the call. ,
Required: False ,
}
[
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
callConnectionState:
{
Description: The state of the call connection. ,
Enum:
{
unknown: No description available. ,
connecting: No description available. ,
connected: No description available. ,
transferring: No description available. ,
transferAccepted: No description available. ,
disconnecting: No description available. ,
disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
callbackUri:
{
Description: The callback URI. ,
Required: False ,
}
string ,
sourceCallerIdNumber:
{
Description: The source caller Id, a phone number, that's shown to the PSTN participant being invited. Required only when calling a PSTN callee. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
sourceDisplayName:
{
Description: Display name of the call if dialing out to a pstn number. ,
Required: False ,
}
string ,
source:
{
Description: Source identity. ,
Required: False ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
correlationId:
{
Description: The correlation ID. ,
Required: False ,
}
string ,
answeredBy:
{
Description: Identity of the answering entity. Only populated when identity is provided in the request. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
mediaStreamingSubscription:
{
Description: The state of media streaming subscription for the call ,
Required: False ,
}
{
id:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
state:
{
Description: Media streaming subscription state. ,
Enum:
{
disabled: No description available. ,
inactive: No description available. ,
active: No description available. ,
}
,
Required: False ,
}
enum ,
subscribedContentTypes:
{
Description: Subscribed media streaming content types. ,
Required: False ,
}
[
string ,
]
,
}
,
transcriptionSubscription:
{
Description: Transcription Subscription. ,
Required: False ,
}
{
id:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
state:
{
Description: Transcription subscription state. ,
Enum:
{
disabled: No description available. ,
inactive: No description available. ,
active: No description available. ,
}
,
Required: False ,
}
enum ,
subscribedResultTypes:
{
Description: Subscribed transcription result types. ,
Required: False ,
}
[
string ,
]
,
}
,
answeredFor:
{
Description: Identity of the original Pstn target of an incoming Call. Only populated when the original target is a Pstn number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
}
AnswerCall (new)
Description :  Answer a call using the IncomingCallContext from Event Grid.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections:answer
{
answerCallRequest:
{
Description: The answer call request. ,
Required: True ,
}
{
incomingCallContext:
{
Description: The context associated with the call. ,
Required: True ,
}
string ,
callbackUri:
{
Description: The callback uri. ,
Required: True ,
}
string ,
operationContext:
{
Description: A customer set value used to track the answering of a call. ,
Required: False ,
}
string ,
callIntelligenceOptions:
{
Description: AI options for the call. ,
Required: False ,
}
{
cognitiveServicesEndpoint:
{
Description: The identifier of the Cognitive Service resource assigned to this call. ,
Required: False ,
}
string ,
}
,
answeredBy:
{
Description: The identifier of the call automation entity which answers the call ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
mediaStreamingOptions:
{
Description: Media Streaming Options. ,
Required: False ,
}
{
transportUrl:
{
Description: Transport URL for media streaming ,
Required: True ,
}
string ,
transportType:
{
Description: The type of transport to be used for media streaming, eg. Websocket ,
Enum:
{
websocket: No description available. ,
}
,
Required: True ,
}
enum ,
contentType:
{
Description: Content type to stream, eg. audio ,
Enum:
{
audio: No description available. ,
}
,
Required: True ,
}
enum ,
audioChannelType:
{
Description: Audio channel type to stream, eg. unmixed audio, mixed audio ,
Enum:
{
mixed: No description available. ,
unmixed: No description available. ,
}
,
Required: True ,
}
enum ,
startMediaStreaming:
{
Description: Determines if the media streaming should be started immediately after call is answered or not. ,
Required: False ,
}
boolean ,
enableBidirectional:
{
Description: A value indicating whether bidirectional streaming is enabled. ,
Required: False ,
}
boolean ,
audioFormat:
{
Description: Specifies the audio format used for encoding, including sample rate and channel type. ,
Enum:
{
pcm16KMono: No description available. ,
pcm24KMono: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
transcriptionOptions:
{
Description: Transcription Options. ,
Required: False ,
}
{
transportUrl:
{
Description: Transport URL for live transcription ,
Required: True ,
}
string ,
transportType:
{
Description: The type of transport to be used for live transcription, eg. Websocket ,
Enum:
{
websocket: No description available. ,
}
,
Required: True ,
}
enum ,
locale:
{
Description: Defines the locale for the data e.g en-CA, en-AU ,
Required: True ,
}
string ,
speechRecognitionModelEndpointId:
{
Description: Endpoint where the custom model was deployed. ,
Required: False ,
}
string ,
startTranscription:
{
Description: Determines if the transcription should be started immediately after call is answered or not. ,
Required: True ,
}
boolean ,
enableIntermediateResults:
{
Description: Enables intermediate results for the transcribed speech. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
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. ,
Format: uuid ,
Required: False ,
}
string ,
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
callConnectionId:
{
Description: The call connection id. ,
Required: False ,
}
string ,
serverCallId:
{
Description: The server call id. ,
Required: False ,
}
string ,
targets:
{
Description: The targets of the call. ,
Required: False ,
}
[
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
callConnectionState:
{
Description: The state of the call connection. ,
Enum:
{
unknown: No description available. ,
connecting: No description available. ,
connected: No description available. ,
transferring: No description available. ,
transferAccepted: No description available. ,
disconnecting: No description available. ,
disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
callbackUri:
{
Description: The callback URI. ,
Required: False ,
}
string ,
sourceCallerIdNumber:
{
Description: The source caller Id, a phone number, that's shown to the PSTN participant being invited. Required only when calling a PSTN callee. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
sourceDisplayName:
{
Description: Display name of the call if dialing out to a pstn number. ,
Required: False ,
}
string ,
source:
{
Description: Source identity. ,
Required: False ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
correlationId:
{
Description: The correlation ID. ,
Required: False ,
}
string ,
answeredBy:
{
Description: Identity of the answering entity. Only populated when identity is provided in the request. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
mediaStreamingSubscription:
{
Description: The state of media streaming subscription for the call ,
Required: False ,
}
{
id:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
state:
{
Description: Media streaming subscription state. ,
Enum:
{
disabled: No description available. ,
inactive: No description available. ,
active: No description available. ,
}
,
Required: False ,
}
enum ,
subscribedContentTypes:
{
Description: Subscribed media streaming content types. ,
Required: False ,
}
[
string ,
]
,
}
,
transcriptionSubscription:
{
Description: Transcription Subscription. ,
Required: False ,
}
{
id:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
state:
{
Description: Transcription subscription state. ,
Enum:
{
disabled: No description available. ,
inactive: No description available. ,
active: No description available. ,
}
,
Required: False ,
}
enum ,
subscribedResultTypes:
{
Description: Subscribed transcription result types. ,
Required: False ,
}
[
string ,
]
,
}
,
answeredFor:
{
Description: Identity of the original Pstn target of an incoming Call. Only populated when the original target is a Pstn number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
}
RedirectCall (new)
Description :  Redirect a call.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections:redirect
{
redirectCallRequest:
{
Description: The redirect call request. ,
Required: True ,
}
{
incomingCallContext:
{
Description: The context associated with the call. ,
Required: True ,
}
string ,
target:
{
Description: The target identity to redirect the call to. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
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. ,
Format: uuid ,
Required: False ,
}
string ,
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}
RejectCall (new)
Description :  Reject the call.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections:reject
{
rejectCallRequest:
{
Description: The reject call request. ,
Required: True ,
}
{
incomingCallContext:
{
Description: The context associated with the call. ,
Required: True ,
}
string ,
callRejectReason:
{
Description: The rejection reason. ,
Enum:
{
none: No description available. ,
busy: No description available. ,
forbidden: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
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. ,
Format: uuid ,
Required: False ,
}
string ,
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}
Connect (new)
Description :  Create a connection to a CallLocator.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections:connect
{
connectRequest:
{
Description: The create connection request. ,
Required: True ,
}
{
callLocator:
{
Description: The call locator. ,
Required: True ,
}
{
groupCallId:
{
Description: The group call id ,
Required: False ,
}
string ,
serverCallId:
{
Description: The server call id. ,
Required: False ,
}
string ,
roomId:
{
Description: The Acs room id. (Not supported for Start Recording) ,
Required: False ,
}
string ,
kind:
{
Description: The call locator kind. ,
Enum:
{
groupCallLocator: No description available. ,
serverCallLocator: No description available. ,
roomCallLocator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
callbackUri:
{
Description: The callback URI. ,
Required: True ,
}
string ,
operationContext:
{
Description: Used by customers to correlate the request to the response event. ,
Required: False ,
}
string ,
callIntelligenceOptions:
{
Description: AI options for the call. ,
Required: False ,
}
{
cognitiveServicesEndpoint:
{
Description: The identifier of the Cognitive Service resource assigned to this call. ,
Required: False ,
}
string ,
}
,
mediaStreamingOptions:
{
Description: Media Streaming Configuration. ,
Required: False ,
}
{
transportUrl:
{
Description: Transport URL for media streaming ,
Required: True ,
}
string ,
transportType:
{
Description: The type of transport to be used for media streaming, eg. Websocket ,
Enum:
{
websocket: No description available. ,
}
,
Required: True ,
}
enum ,
contentType:
{
Description: Content type to stream, eg. audio ,
Enum:
{
audio: No description available. ,
}
,
Required: True ,
}
enum ,
audioChannelType:
{
Description: Audio channel type to stream, eg. unmixed audio, mixed audio ,
Enum:
{
mixed: No description available. ,
unmixed: No description available. ,
}
,
Required: True ,
}
enum ,
startMediaStreaming:
{
Description: Determines if the media streaming should be started immediately after call is answered or not. ,
Required: False ,
}
boolean ,
enableBidirectional:
{
Description: A value indicating whether bidirectional streaming is enabled. ,
Required: False ,
}
boolean ,
audioFormat:
{
Description: Specifies the audio format used for encoding, including sample rate and channel type. ,
Enum:
{
pcm16KMono: No description available. ,
pcm24KMono: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
transcriptionOptions:
{
Description: Live Transcription Configuration. ,
Required: False ,
}
{
transportUrl:
{
Description: Transport URL for live transcription ,
Required: True ,
}
string ,
transportType:
{
Description: The type of transport to be used for live transcription, eg. Websocket ,
Enum:
{
websocket: No description available. ,
}
,
Required: True ,
}
enum ,
locale:
{
Description: Defines the locale for the data e.g en-CA, en-AU ,
Required: True ,
}
string ,
speechRecognitionModelEndpointId:
{
Description: Endpoint where the custom model was deployed. ,
Required: False ,
}
string ,
startTranscription:
{
Description: Determines if the transcription should be started immediately after call is answered or not. ,
Required: True ,
}
boolean ,
enableIntermediateResults:
{
Description: Enables intermediate results for the transcribed speech. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
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. ,
Format: uuid ,
Required: False ,
}
string ,
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
callConnectionId:
{
Description: The call connection id. ,
Required: False ,
}
string ,
serverCallId:
{
Description: The server call id. ,
Required: False ,
}
string ,
targets:
{
Description: The targets of the call. ,
Required: False ,
}
[
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
callConnectionState:
{
Description: The state of the call connection. ,
Enum:
{
unknown: No description available. ,
connecting: No description available. ,
connected: No description available. ,
transferring: No description available. ,
transferAccepted: No description available. ,
disconnecting: No description available. ,
disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
callbackUri:
{
Description: The callback URI. ,
Required: False ,
}
string ,
sourceCallerIdNumber:
{
Description: The source caller Id, a phone number, that's shown to the PSTN participant being invited. Required only when calling a PSTN callee. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
sourceDisplayName:
{
Description: Display name of the call if dialing out to a pstn number. ,
Required: False ,
}
string ,
source:
{
Description: Source identity. ,
Required: False ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
correlationId:
{
Description: The correlation ID. ,
Required: False ,
}
string ,
answeredBy:
{
Description: Identity of the answering entity. Only populated when identity is provided in the request. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
mediaStreamingSubscription:
{
Description: The state of media streaming subscription for the call ,
Required: False ,
}
{
id:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
state:
{
Description: Media streaming subscription state. ,
Enum:
{
disabled: No description available. ,
inactive: No description available. ,
active: No description available. ,
}
,
Required: False ,
}
enum ,
subscribedContentTypes:
{
Description: Subscribed media streaming content types. ,
Required: False ,
}
[
string ,
]
,
}
,
transcriptionSubscription:
{
Description: Transcription Subscription. ,
Required: False ,
}
{
id:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
state:
{
Description: Transcription subscription state. ,
Enum:
{
disabled: No description available. ,
inactive: No description available. ,
active: No description available. ,
}
,
Required: False ,
}
enum ,
subscribedResultTypes:
{
Description: Subscribed transcription result types. ,
Required: False ,
}
[
string ,
]
,
}
,
answeredFor:
{
Description: Identity of the original Pstn target of an incoming Call. Only populated when the original target is a Pstn number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
}
CallConnection_GetCall (new)
Description :  Get the detail properties of an ongoing call.
Reference :  Link ¶

⚼ Request

GET:  /calling/callConnections/{callConnectionId}
{
callConnectionId:
{
Description: The call connection id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
callConnectionId:
{
Description: The call connection id. ,
Required: False ,
}
string ,
serverCallId:
{
Description: The server call id. ,
Required: False ,
}
string ,
targets:
{
Description: The targets of the call. ,
Required: False ,
}
[
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
callConnectionState:
{
Description: The state of the call connection. ,
Enum:
{
unknown: No description available. ,
connecting: No description available. ,
connected: No description available. ,
transferring: No description available. ,
transferAccepted: No description available. ,
disconnecting: No description available. ,
disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
callbackUri:
{
Description: The callback URI. ,
Required: False ,
}
string ,
sourceCallerIdNumber:
{
Description: The source caller Id, a phone number, that's shown to the PSTN participant being invited. Required only when calling a PSTN callee. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
sourceDisplayName:
{
Description: Display name of the call if dialing out to a pstn number. ,
Required: False ,
}
string ,
source:
{
Description: Source identity. ,
Required: False ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
correlationId:
{
Description: The correlation ID. ,
Required: False ,
}
string ,
answeredBy:
{
Description: Identity of the answering entity. Only populated when identity is provided in the request. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
mediaStreamingSubscription:
{
Description: The state of media streaming subscription for the call ,
Required: False ,
}
{
id:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
state:
{
Description: Media streaming subscription state. ,
Enum:
{
disabled: No description available. ,
inactive: No description available. ,
active: No description available. ,
}
,
Required: False ,
}
enum ,
subscribedContentTypes:
{
Description: Subscribed media streaming content types. ,
Required: False ,
}
[
string ,
]
,
}
,
transcriptionSubscription:
{
Description: Transcription Subscription. ,
Required: False ,
}
{
id:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
state:
{
Description: Transcription subscription state. ,
Enum:
{
disabled: No description available. ,
inactive: No description available. ,
active: No description available. ,
}
,
Required: False ,
}
enum ,
subscribedResultTypes:
{
Description: Subscribed transcription result types. ,
Required: False ,
}
[
string ,
]
,
}
,
answeredFor:
{
Description: Identity of the original Pstn target of an incoming Call. Only populated when the original target is a Pstn number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
}
CallConnection_HangupCall (new)
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.
Reference :  Link ¶

⚼ Request

DELETE:  /calling/callConnections/{callConnectionId}
{
callConnectionId:
{
Description: The call connection id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}
CallConnection_TerminateCall (new)
Description :  Terminate a call using CallConnectionId.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}:terminate
{
callConnectionId:
{
Description: The terminate call request. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
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. ,
Format: uuid ,
Required: False ,
}
string ,
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}
CallConnection_TransferToParticipant (new)
Description :  Transfer the call to a participant.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}:transferToParticipant
{
callConnectionId:
{
Description: The call connection id. ,
Required: True ,
}
string ,
transferToParticipantRequest:
{
Description: The transfer to participant request. ,
Required: True ,
}
{
targetParticipant:
{
Description: The identity of the target where call should be transferred to. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
operationContext:
{
Description: Used by customers when calling mid-call actions to correlate the request to the response event. ,
Required: False ,
}
string ,
transferee:
{
Description: Transferee is the participant who is transferred away. ,
Required: False ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
operationCallbackUri:
{
Description: Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used. ,
Required: False ,
}
string ,
customCallingContext:
{
Description: Used by customer to send custom calling context to targets ,
Required: False ,
}
{
voipHeaders:
{
Description: Custom calling context VoiP headers ,
Required: False ,
}
object ,
sipHeaders:
{
Description: Custom calling context SIP headers ,
Required: False ,
}
object ,
}
,
sourceCallerIdNumber:
{
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. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
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. ,
Format: uuid ,
Required: False ,
}
string ,
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
operationContext:
{
Description: The operation context provided by client. ,
Required: False ,
}
string ,
}
CallMedia_Play (new)
Description :  Plays audio to participants in the call.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}:play
{
callConnectionId:
{
Description: The call connection id. ,
Required: True ,
}
string ,
playRequest:
{
Description: play request payload. ,
Required: True ,
}
{
playSources:
{
Description: The source of the audio to be played. ,
Required: True ,
}
[
{
kind:
{
Description: Defines the type of the play source ,
Enum:
{
file: No description available. ,
text: No description available. ,
ssml: No description available. ,
}
,
Required: True ,
}
enum ,
playSourceCacheId:
{
Description: Defines the identifier to be used for caching related media ,
Required: False ,
}
string ,
file:
{
Description: Defines the file source info to be used for play ,
Required: False ,
}
{
uri:
{
Description: Uri for the audio file to be played ,
Required: True ,
}
string ,
}
,
text:
{
Description: Defines the text source info to be used for play ,
Required: False ,
}
{
text:
{
Description: Text for the cognitive service to be played ,
Required: True ,
}
string ,
sourceLocale:
{
Description: Source language locale to be played Refer to available locales here: ,
Required: False ,
}
string ,
voiceKind:
{
Description: Voice kind type ,
Enum:
{
male: No description available. ,
female: No description available. ,
}
,
Required: False ,
}
enum ,
voiceName:
{
Description: Voice name to be played Refer to available Text-to-speech voices here: ,
Required: False ,
}
string ,
customVoiceEndpointId:
{
Description: Endpoint where the custom voice was deployed. ,
Required: False ,
}
string ,
}
,
ssml:
{
Description: Defines the ssml(Speech Synthesis Markup Language) source info to be used for play ,
Required: False ,
}
{
ssmlText:
{
Description: Ssml string for the cognitive service to be played ,
Required: True ,
}
string ,
customVoiceEndpointId:
{
Description: Endpoint where the custom voice was deployed. ,
Required: False ,
}
string ,
}
,
}
,
]
,
playTo:
{
Description: The list of call participants play provided audio to. Plays to everyone in the call when not provided. ,
Required: False ,
}
[
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
interruptCallMediaOperation:
{
Description: If set play can barge into other existing queued-up/currently-processing requests. ,
Required: False ,
}
boolean ,
playOptions:
{
Description: Defines options for playing the audio. ,
Required: False ,
}
{
loop:
{
Description: The option to play the provided audio source in loop when set to true ,
Required: True ,
}
boolean ,
}
,
operationContext:
{
Description: The value to identify context of the operation. ,
Required: False ,
}
string ,
operationCallbackUri:
{
Description: Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
CallMedia_StartTranscription (new)
Description :  Starts transcription in the call
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}:startTranscription
{
callConnectionId:
{
Description: The call connection id. ,
Required: True ,
}
string ,
startTranscriptionRequest:
{
Required: True ,
}
{
locale:
{
Description: Defines Locale for the transcription e,g en-US ,
Required: False ,
}
string ,
speechRecognitionModelEndpointId:
{
Description: Endpoint where the custom model was deployed. ,
Required: False ,
}
string ,
operationContext:
{
Description: The value to identify context of the operation. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
CallMedia_StopTranscription (new)
Description :  Stops transcription in the call.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}:stopTranscription
{
callConnectionId:
{
Description: The call connection id. ,
Required: True ,
}
string ,
stopTranscriptionRequest:
{
Description: stop transcription request payload. ,
Required: True ,
}
{
operationContext:
{
Description: The value to identify context of the operation. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
CallMedia_UpdateTranscription (new)
Description :  API to change transcription language.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}:updateTranscription
{
callConnectionId:
{
Description: The call connection id ,
Required: True ,
}
string ,
updateTranscriptionRequest:
{
Description: The UpdateTranscription request ,
Required: True ,
}
{
locale:
{
Description: Sets new locale for transcription. ,
Required: True ,
}
string ,
speechRecognitionModelEndpointId:
{
Description: Sets Endpoint id where the custom model was deployed. ,
Required: False ,
}
string ,
operationContext:
{
Description: The value to identify context of the operation. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
CallMedia_CancelAllMediaOperations (new)
Description :  Cancel all media operations in a call.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}:cancelAllMediaOperations
{
callConnectionId:
{
Description: The call connection id ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
CallMedia_Recognize (new)
Description :  Recognize media from call.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}:recognize
{
callConnectionId:
{
Description: The call connection id ,
Required: True ,
}
string ,
recognizeRequest:
{
Description: The media recognize request ,
Required: True ,
}
{
recognizeInputType:
{
Description: Determines the type of the recognition. ,
Enum:
{
dtmf: No description available. ,
speech: No description available. ,
speechOrDtmf: No description available. ,
choices: No description available. ,
}
,
Required: True ,
}
enum ,
playPrompt:
{
Description: The source of the audio to be played for recognition. ,
Required: False ,
}
{
kind:
{
Description: Defines the type of the play source ,
Enum:
{
file: No description available. ,
text: No description available. ,
ssml: No description available. ,
}
,
Required: True ,
}
enum ,
playSourceCacheId:
{
Description: Defines the identifier to be used for caching related media ,
Required: False ,
}
string ,
file:
{
Description: Defines the file source info to be used for play ,
Required: False ,
}
{
uri:
{
Description: Uri for the audio file to be played ,
Required: True ,
}
string ,
}
,
text:
{
Description: Defines the text source info to be used for play ,
Required: False ,
}
{
text:
{
Description: Text for the cognitive service to be played ,
Required: True ,
}
string ,
sourceLocale:
{
Description: Source language locale to be played Refer to available locales here: ,
Required: False ,
}
string ,
voiceKind:
{
Description: Voice kind type ,
Enum:
{
male: No description available. ,
female: No description available. ,
}
,
Required: False ,
}
enum ,
voiceName:
{
Description: Voice name to be played Refer to available Text-to-speech voices here: ,
Required: False ,
}
string ,
customVoiceEndpointId:
{
Description: Endpoint where the custom voice was deployed. ,
Required: False ,
}
string ,
}
,
ssml:
{
Description: Defines the ssml(Speech Synthesis Markup Language) source info to be used for play ,
Required: False ,
}
{
ssmlText:
{
Description: Ssml string for the cognitive service to be played ,
Required: True ,
}
string ,
customVoiceEndpointId:
{
Description: Endpoint where the custom voice was deployed. ,
Required: False ,
}
string ,
}
,
}
,
playPrompts:
{
Description: The source of the audio to be played for recognition. ,
Required: False ,
}
[
{
kind:
{
Description: Defines the type of the play source ,
Enum:
{
file: No description available. ,
text: No description available. ,
ssml: No description available. ,
}
,
Required: True ,
}
enum ,
playSourceCacheId:
{
Description: Defines the identifier to be used for caching related media ,
Required: False ,
}
string ,
file:
{
Description: Defines the file source info to be used for play ,
Required: False ,
}
{
uri:
{
Description: Uri for the audio file to be played ,
Required: True ,
}
string ,
}
,
text:
{
Description: Defines the text source info to be used for play ,
Required: False ,
}
{
text:
{
Description: Text for the cognitive service to be played ,
Required: True ,
}
string ,
sourceLocale:
{
Description: Source language locale to be played Refer to available locales here: ,
Required: False ,
}
string ,
voiceKind:
{
Description: Voice kind type ,
Enum:
{
male: No description available. ,
female: No description available. ,
}
,
Required: False ,
}
enum ,
voiceName:
{
Description: Voice name to be played Refer to available Text-to-speech voices here: ,
Required: False ,
}
string ,
customVoiceEndpointId:
{
Description: Endpoint where the custom voice was deployed. ,
Required: False ,
}
string ,
}
,
ssml:
{
Description: Defines the ssml(Speech Synthesis Markup Language) source info to be used for play ,
Required: False ,
}
{
ssmlText:
{
Description: Ssml string for the cognitive service to be played ,
Required: True ,
}
string ,
customVoiceEndpointId:
{
Description: Endpoint where the custom voice was deployed. ,
Required: False ,
}
string ,
}
,
}
,
]
,
interruptCallMediaOperation:
{
Description: If set recognize can barge into other existing queued-up/currently-processing requests. ,
Required: False ,
}
boolean ,
recognizeOptions:
{
Description: Defines options for recognition. ,
Required: True ,
}
{
interruptPrompt:
{
Description: Determines if we interrupt the prompt and start recognizing. ,
Required: False ,
}
boolean ,
initialSilenceTimeoutInSeconds:
{
Description: Time to wait for first input after prompt (if any). ,
Format: int32 ,
Required: False ,
}
integer ,
targetParticipant:
{
Description: Target participant of DTMF tone recognition. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
speechLanguage:
{
Description: Speech language to be recognized, If not set default is en-US ,
Required: False ,
}
string ,
speechRecognitionModelEndpointId:
{
Description: Endpoint where the custom model was deployed. ,
Required: False ,
}
string ,
dtmfOptions:
{
Description: Defines configurations for DTMF. ,
Required: False ,
}
{
interToneTimeoutInSeconds:
{
Description: Time to wait between DTMF inputs to stop recognizing. ,
Format: int32 ,
Required: False ,
}
integer ,
maxTonesToCollect:
{
Description: Maximum number of DTMF tones to be collected. ,
Format: int32 ,
Required: False ,
}
integer ,
stopTones:
{
Description: List of tones that will stop recognizing. ,
Required: False ,
}
[
string ,
]
,
}
,
choices:
{
Description: Defines Ivr choices for recognize. ,
Required: False ,
}
[
{
label:
{
Description: Identifier for a given choice ,
Required: True ,
}
string ,
phrases:
{
Description: List of phrases to recognize ,
Required: True ,
}
[
string ,
]
,
tone:
{
Enum:
{
zero: No description available. ,
one: No description available. ,
two: No description available. ,
three: No description available. ,
four: No description available. ,
five: No description available. ,
six: No description available. ,
seven: No description available. ,
eight: No description available. ,
nine: No description available. ,
a: No description available. ,
b: No description available. ,
c: No description available. ,
d: No description available. ,
pound: No description available. ,
asterisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
speechOptions:
{
Description: Defines continuous speech recognition option. ,
Required: False ,
}
{
endSilenceTimeoutInMs:
{
Description: The length of end silence when user stops speaking and cogservice send response. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
operationContext:
{
Description: The value to identify context of the operation. ,
Required: False ,
}
string ,
operationCallbackUri:
{
Description: Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
CallMedia_StartContinuousDtmfRecognition (new)
Description :  Start continuous Dtmf recognition by subscribing to tones.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}:startContinuousDtmfRecognition
{
callConnectionId:
{
Description: The call connection id ,
Required: True ,
}
string ,
continuousDtmfRecognitionRequest:
{
Description: The continuous recognize request ,
Required: True ,
}
{
targetParticipant:
{
Description: Defines options for recognition. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
operationContext:
{
Description: The value to identify context of the operation. ,
Required: False ,
}
string ,
operationCallbackUri:
{
Description: Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}
CallMedia_StopContinuousDtmfRecognition (new)
Description :  Stop continuous Dtmf recognition by unsubscribing to tones.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}:stopContinuousDtmfRecognition
{
callConnectionId:
{
Description: The call connection id ,
Required: True ,
}
string ,
continuousDtmfRecognitionRequest:
{
Description: The continuous recognize request ,
Required: True ,
}
{
targetParticipant:
{
Description: Defines options for recognition. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
operationContext:
{
Description: The value to identify context of the operation. ,
Required: False ,
}
string ,
operationCallbackUri:
{
Description: Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}
CallMedia_SendDtmfTones (new)
Description :  Send dtmf tones.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}:sendDtmfTones
{
callConnectionId:
{
Description: The call connection id ,
Required: True ,
}
string ,
sendDtmfTonesRequest:
{
Description: The send dtmf tones request ,
Required: True ,
}
{
tones:
{
Description: List of tones to be sent to target participant. ,
Required: True ,
}
[
string ,
]
,
targetParticipant:
{
Description: Target participant of send Dtmf tones. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
operationContext:
{
Description: The value to identify context of the operation. ,
Required: False ,
}
string ,
operationCallbackUri:
{
Description: Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
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. ,
Format: uuid ,
Required: False ,
}
string ,
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
operationContext:
{
Description: The operation context provided by client. ,
Required: False ,
}
string ,
}
CallMedia_Hold (new)
Description :  Hold participant from the call using identifier.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}:hold
{
callConnectionId:
{
Description: The call connection id. ,
Required: True ,
}
string ,
holdRequest:
{
Description: The participants to be hold from the call. ,
Required: True ,
}
{
targetParticipant:
{
Description: Participant to be held from the call. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
playSourceInfo:
{
Description: Prompt to play while in hold. ,
Required: False ,
}
{
kind:
{
Description: Defines the type of the play source ,
Enum:
{
file: No description available. ,
text: No description available. ,
ssml: No description available. ,
}
,
Required: True ,
}
enum ,
playSourceCacheId:
{
Description: Defines the identifier to be used for caching related media ,
Required: False ,
}
string ,
file:
{
Description: Defines the file source info to be used for play ,
Required: False ,
}
{
uri:
{
Description: Uri for the audio file to be played ,
Required: True ,
}
string ,
}
,
text:
{
Description: Defines the text source info to be used for play ,
Required: False ,
}
{
text:
{
Description: Text for the cognitive service to be played ,
Required: True ,
}
string ,
sourceLocale:
{
Description: Source language locale to be played Refer to available locales here: ,
Required: False ,
}
string ,
voiceKind:
{
Description: Voice kind type ,
Enum:
{
male: No description available. ,
female: No description available. ,
}
,
Required: False ,
}
enum ,
voiceName:
{
Description: Voice name to be played Refer to available Text-to-speech voices here: ,
Required: False ,
}
string ,
customVoiceEndpointId:
{
Description: Endpoint where the custom voice was deployed. ,
Required: False ,
}
string ,
}
,
ssml:
{
Description: Defines the ssml(Speech Synthesis Markup Language) source info to be used for play ,
Required: False ,
}
{
ssmlText:
{
Description: Ssml string for the cognitive service to be played ,
Required: True ,
}
string ,
customVoiceEndpointId:
{
Description: Endpoint where the custom voice was deployed. ,
Required: False ,
}
string ,
}
,
}
,
operationContext:
{
Description: Used by customers when calling mid-call actions to correlate the request to the response event. ,
Required: False ,
}
string ,
operationCallbackUri:
{
Description: Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}
CallMedia_Unhold (new)
Description :  Unhold participants from the call using identifier.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}:unhold
{
callConnectionId:
{
Description: The call connection id. ,
Required: True ,
}
string ,
unholdRequest:
{
Description: The participants to be hold from the call. ,
Required: True ,
}
{
targetParticipant:
{
Description: Participants to be hold from the call. Only ACS Users are supported. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
operationContext:
{
Description: Used by customers when calling mid-call actions to correlate the request to the response event. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}
CallMedia_StartMediaStreaming (new)
Description :  Starts media streaming in the call.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}:startMediaStreaming
{
callConnectionId:
{
Description: The call connection id. ,
Required: True ,
}
string ,
startMediaStreamingRequest:
{
Required: True ,
}
{
operationCallbackUri:
{
Description: Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used. ,
Required: False ,
}
string ,
operationContext:
{
Description: The value to identify context of the operation. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
CallMedia_StopMediaStreaming (new)
Description :  Stops media streaming in the call.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}:stopMediaStreaming
{
callConnectionId:
{
Description: The call connection id. ,
Required: True ,
}
string ,
stopMediaStreamingRequest:
{
Description: stop media streaming request payload. ,
Required: True ,
}
{
operationCallbackUri:
{
Description: Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used. ,
Required: False ,
}
string ,
operationContext:
{
Description: The value to identify context of the operation. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
CallConnection_GetParticipants (new)
Description :  Get participants from a call. Recording and transcription bots are omitted from this list.
Reference :  Link ¶

⚼ Request

GET:  /calling/callConnections/{callConnectionId}/participants
{
callConnectionId:
{
Description: The call connection Id ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of the current participants in the call. ,
Required: True ,
}
[
{
identifier:
{
Description: Communication identifier of the participant ,
Required: False ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
isMuted:
{
Description: Is participant muted ,
Required: False ,
}
boolean ,
isOnHold:
{
Description: Is participant on hold. ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: Continue of the list of participants ,
Required: False ,
}
string ,
}
CallConnection_AddParticipant (new)
Description :  Add a participant to the call.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}/participants:add
{
callConnectionId:
{
Description: The call connection Id ,
Required: True ,
}
string ,
addParticipantRequest:
{
Required: True ,
}
{
sourceCallerIdNumber:
{
Description: The source caller Id, a phone number, that's shown to the PSTN participant being invited. Required only when inviting a PSTN participant. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
sourceDisplayName:
{
Description: (Optional) The display name of the source that is associated with this invite operation when adding a PSTN participant or teams user. Note: Will not update the display name in the roster. ,
Required: False ,
}
string ,
participantToAdd:
{
Description: The participant to invite. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
invitationTimeoutInSeconds:
{
Description: Gets or sets the timeout to wait for the invited participant to pickup. The maximum value of this is 180 seconds ,
Format: int32 ,
Required: False ,
}
integer ,
operationContext:
{
Description: Used by customers when calling mid-call actions to correlate the request to the response event. ,
Required: False ,
}
string ,
operationCallbackUri:
{
Description: Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used. ,
Required: False ,
}
string ,
customCallingContext:
{
Description: Used by customer to send custom calling context to targets ,
Required: False ,
}
{
voipHeaders:
{
Description: Custom calling context VoiP headers ,
Required: False ,
}
object ,
sipHeaders:
{
Description: Custom calling context SIP headers ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
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. ,
Format: uuid ,
Required: False ,
}
string ,
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
participant:
{
Description: List of current participants in the call. ,
Required: False ,
}
{
identifier:
{
Description: Communication identifier of the participant ,
Required: False ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
isMuted:
{
Description: Is participant muted ,
Required: False ,
}
boolean ,
isOnHold:
{
Description: Is participant on hold. ,
Required: False ,
}
boolean ,
}
,
operationContext:
{
Description: The operation context provided by client. ,
Required: False ,
}
string ,
invitationId:
{
Description: Invitation ID used to add a participant. ,
Required: False ,
}
string ,
}
CallConnection_RemoveParticipant (new)
Description :  Remove a participant from the call using identifier.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}/participants:remove
{
callConnectionId:
{
Description: The call connection id. ,
Required: True ,
}
string ,
removeParticipantRequest:
{
Description: The participant to be removed from the call. ,
Required: True ,
}
{
participantToRemove:
{
Description: The participants to be removed from the call. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
operationContext:
{
Description: Used by customers when calling mid-call actions to correlate the request to the response event. ,
Required: False ,
}
string ,
operationCallbackUri:
{
Description: Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
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. ,
Format: uuid ,
Required: False ,
}
string ,
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
operationContext:
{
Description: The operation context provided by client. ,
Required: False ,
}
string ,
}
CallConnection_Mute (new)
Description :  Mute participants from the call using identifier.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}/participants:mute
{
callConnectionId:
{
Description: The call connection id. ,
Required: True ,
}
string ,
muteParticipantsRequest:
{
Description: The participants to be muted from the call. ,
Required: True ,
}
{
targetParticipants:
{
Description: Participants to be muted from the call. Only ACS Users are supported. ,
Required: True ,
}
[
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
operationContext:
{
Description: Used by customers when calling mid-call actions to correlate the request to the response event. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
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. ,
Format: uuid ,
Required: False ,
}
string ,
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
operationContext:
{
Description: The operation context provided by client. ,
Required: False ,
}
string ,
}
CallConnection_CancelAddParticipant (new)
Description :  Cancel add participant operation.
Reference :  Link ¶

⚼ Request

POST:  /calling/callConnections/{callConnectionId}/participants:cancelAddParticipant
{
callConnectionId:
{
Description: The call connection Id ,
Required: True ,
}
string ,
cancelAddParticipantRequest:
{
Description: Cancellation request. ,
Required: True ,
}
{
invitationId:
{
Description: Invitation ID used to add a participant. ,
Required: True ,
}
string ,
operationContext:
{
Description: Used by customers when calling mid-call actions to correlate the request to the response event. ,
Required: False ,
}
string ,
operationCallbackUri:
{
Description: Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
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. ,
Format: uuid ,
Required: False ,
}
string ,
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
invitationId:
{
Description: Invitation ID used to cancel the add participant action. ,
Required: False ,
}
string ,
operationContext:
{
Description: The operation context provided by client. ,
Required: False ,
}
string ,
}
CallConnection_GetParticipant (new)
Description :  Get participant from a call.
Reference :  Link ¶

⚼ Request

GET:  /calling/callConnections/{callConnectionId}/participants/{participantRawId}
{
callConnectionId:
{
Description: The call connection Id ,
Required: True ,
}
string ,
participantRawId:
{
Description: Raw id of the participant to retrieve. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
identifier:
{
Description: Communication identifier of the participant ,
Required: False ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
isMuted:
{
Description: Is participant muted ,
Required: False ,
}
boolean ,
isOnHold:
{
Description: Is participant on hold. ,
Required: False ,
}
boolean ,
}
CallRecording_StartRecording (new)
Description :  Start recording the call.
Reference :  Link ¶

⚼ Request

POST:  /calling/recordings
{
startCallRecording:
{
Description: The request body of start call recording request. ,
Required: True ,
}
{
callLocator:
{
Description: The call locator. (Only one of callLocator or callConnectionId to be used) ,
Required: False ,
}
{
groupCallId:
{
Description: The group call id ,
Required: False ,
}
string ,
serverCallId:
{
Description: The server call id. ,
Required: False ,
}
string ,
roomId:
{
Description: The Acs room id. (Not supported for Start Recording) ,
Required: False ,
}
string ,
kind:
{
Description: The call locator kind. ,
Enum:
{
groupCallLocator: No description available. ,
serverCallLocator: No description available. ,
roomCallLocator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
callConnectionId:
{
Description: The call connection Id. (Only one of callLocator or callConnectionId to be used) ,
Required: False ,
}
string ,
recordingStateCallbackUri:
{
Description: The uri to send notifications to. ,
Required: False ,
}
string ,
recordingContentType:
{
Description: The content type of call recording. ,
Enum:
{
audio: No description available. ,
audioVideo: No description available. ,
}
,
Required: False ,
}
enum ,
recordingChannelType:
{
Description: The channel type of call recording. ,
Enum:
{
mixed: No description available. ,
unmixed: No description available. ,
}
,
Required: False ,
}
enum ,
recordingFormatType:
{
Description: The format type of call recording. ,
Enum:
{
wav: No description available. ,
mp3: No description available. ,
mp4: No description available. ,
}
,
Required: False ,
}
enum ,
audioChannelParticipantOrdering:
{
Description: The sequential order in which audio channels are assigned to participants in the unmixed recording. When 'recordingChannelType' is set to 'unmixed' and `audioChannelParticipantOrdering is not specified, the audio channel to participant mapping will be automatically assigned based on the order in which participant first audio was detected. Channel to participant mapping details can be found in the metadata of the recording. ,
Required: False ,
}
[
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
channelAffinity:
{
Description: The channel affinity of call recording When 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified, 'channel' will be automatically assigned. Channel-Participant mapping details can be found in the metadata of the recording. /// ,
Required: False ,
}
[
{
channel:
{
Description: Channel number to which bitstream from a particular participant will be written. ,
Format: int32 ,
Required: False ,
}
integer ,
participant:
{
Description: The identifier for the participant whose bitstream will be written to the channel represented by the channel number. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
pauseOnStart:
{
Description: When set to true will start recording in Pause mode, which can be resumed. ,
Required: False ,
}
boolean ,
externalStorage:
{
Description: Optional property to specify location where recording will be stored ,
Required: False ,
}
{
recordingStorageKind:
{
Description: Defines the kind of external storage ,
Enum:
{
azureCommunicationServices: No description available. ,
azureBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
recordingDestinationContainerUrl:
{
Description: Uri of a container or a location within a container ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
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. ,
Format: uuid ,
Required: False ,
}
string ,
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
recordingId:
{
Required: False ,
}
string ,
recordingState:
{
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recordingKind:
{
Enum:
{
azureCommunicationServices: No description available. ,
teams: No description available. ,
teamsCompliance: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
recordingId:
{
Required: False ,
}
string ,
recordingState:
{
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recordingKind:
{
Enum:
{
azureCommunicationServices: No description available. ,
teams: No description available. ,
teamsCompliance: No description available. ,
}
,
Required: False ,
}
enum ,
}
CallRecording_GetRecordingProperties (new)
Description :  Get call recording properties.
Reference :  Link ¶

⚼ Request

GET:  /calling/recordings/{recordingId}
{
recordingId:
{
Description: The recording id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
recordingId:
{
Required: False ,
}
string ,
recordingState:
{
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
recordingKind:
{
Enum:
{
azureCommunicationServices: No description available. ,
teams: No description available. ,
teamsCompliance: No description available. ,
}
,
Required: False ,
}
enum ,
}
CallRecording_StopRecording (new)
Description :  Stop recording the call.
Reference :  Link ¶

⚼ Request

DELETE:  /calling/recordings/{recordingId}
{
recordingId:
{
Description: The recording id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}
CallRecording_PauseRecording (new)
Description :  Pause recording the call.
Reference :  Link ¶

⚼ Request

POST:  /calling/recordings/{recordingId}:pause
{
recordingId:
{
Description: The recording id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
CallRecording_ResumeRecording (new)
Description :  Resume recording the call.
Reference :  Link ¶

⚼ Request

POST:  /calling/recordings/{recordingId}:resume
{
recordingId:
{
Description: The recording id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}