@azure/communication-call-automation 1.5.0-beta.2 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (281) hide show
  1. package/README.md +3 -1
  2. package/dist/browser/callAutomationClient.d.ts +2 -3
  3. package/dist/browser/callAutomationClient.d.ts.map +1 -1
  4. package/dist/browser/callAutomationClient.js +79 -31
  5. package/dist/browser/callAutomationClient.js.map +1 -1
  6. package/dist/browser/callAutomationEventParser.d.ts.map +1 -1
  7. package/dist/browser/callAutomationEventParser.js +9 -10
  8. package/dist/browser/callAutomationEventParser.js.map +1 -1
  9. package/dist/browser/callConnection.d.ts +1 -1
  10. package/dist/browser/callConnection.d.ts.map +1 -1
  11. package/dist/browser/callConnection.js +82 -38
  12. package/dist/browser/callConnection.js.map +1 -1
  13. package/dist/browser/callMedia.d.ts +1 -1
  14. package/dist/browser/callMedia.d.ts.map +1 -1
  15. package/dist/browser/callMedia.js +33 -12
  16. package/dist/browser/callMedia.js.map +1 -1
  17. package/dist/browser/callRecording.js +11 -6
  18. package/dist/browser/callRecording.js.map +1 -1
  19. package/dist/browser/contentDownloader.js +11 -12
  20. package/dist/browser/contentDownloader.js.map +1 -1
  21. package/dist/browser/credential/callAutomationAccessKeyCredentialPolicy.js +1 -2
  22. package/dist/browser/credential/callAutomationAccessKeyCredentialPolicy.js.map +1 -1
  23. package/dist/browser/credential/callAutomationAuthPolicy.js +1 -1
  24. package/dist/browser/credential/callAutomationAuthPolicy.js.map +1 -1
  25. package/dist/browser/credential/cryptoUtils-browser.mjs.map +1 -1
  26. package/dist/browser/credential/cryptoUtils.js +1 -2
  27. package/dist/browser/generated/src/callAutomationApiClient.js +14 -5
  28. package/dist/browser/generated/src/callAutomationApiClient.js.map +1 -1
  29. package/dist/browser/generated/src/models/index.d.ts +305 -322
  30. package/dist/browser/generated/src/models/index.d.ts.map +1 -1
  31. package/dist/browser/generated/src/models/index.js +29 -35
  32. package/dist/browser/generated/src/models/index.js.map +1 -1
  33. package/dist/browser/generated/src/models/mappers.d.ts +41 -34
  34. package/dist/browser/generated/src/models/mappers.d.ts.map +1 -1
  35. package/dist/browser/generated/src/models/mappers.js +481 -462
  36. package/dist/browser/generated/src/models/mappers.js.map +1 -1
  37. package/dist/browser/generated/src/models/parameters.js +1 -1
  38. package/dist/browser/generated/src/models/parameters.js.map +1 -1
  39. package/dist/browser/generated/src/operations/callConnection.js +23 -40
  40. package/dist/browser/generated/src/operations/callConnection.js.map +1 -1
  41. package/dist/browser/generated/src/operations/callMedia.js +1 -0
  42. package/dist/browser/generated/src/operations/callMedia.js.map +1 -1
  43. package/dist/browser/generated/src/operations/callRecording.js +1 -0
  44. package/dist/browser/generated/src/operations/callRecording.js.map +1 -1
  45. package/dist/browser/generated/src/pagingHelper.js +2 -4
  46. package/dist/browser/generated/src/pagingHelper.js.map +1 -1
  47. package/dist/browser/models/constants.d.ts.map +1 -1
  48. package/dist/browser/models/constants.js +1 -1
  49. package/dist/browser/models/constants.js.map +1 -1
  50. package/dist/browser/models/events.d.ts +295 -209
  51. package/dist/browser/models/events.d.ts.map +1 -1
  52. package/dist/browser/models/events.js.map +1 -1
  53. package/dist/browser/models/models.d.ts +44 -4
  54. package/dist/browser/models/models.d.ts.map +1 -1
  55. package/dist/browser/models/models.js +1 -1
  56. package/dist/browser/models/models.js.map +1 -1
  57. package/dist/browser/models/options.d.ts +17 -0
  58. package/dist/browser/models/options.d.ts.map +1 -1
  59. package/dist/browser/models/options.js.map +1 -1
  60. package/dist/browser/models/responses.d.ts +1 -1
  61. package/dist/browser/models/responses.d.ts.map +1 -1
  62. package/dist/browser/models/responses.js.map +1 -1
  63. package/dist/browser/models/streaming.d.ts +26 -27
  64. package/dist/browser/models/streaming.d.ts.map +1 -1
  65. package/dist/browser/models/streaming.js +28 -57
  66. package/dist/browser/models/streaming.js.map +1 -1
  67. package/dist/browser/streamingData.d.ts.map +1 -1
  68. package/dist/browser/streamingData.js +10 -1
  69. package/dist/browser/streamingData.js.map +1 -1
  70. package/dist/browser/utli/converters.d.ts.map +1 -1
  71. package/dist/browser/utli/converters.js +30 -9
  72. package/dist/browser/utli/converters.js.map +1 -1
  73. package/dist/commonjs/callAutomationClient.d.ts +2 -3
  74. package/dist/commonjs/callAutomationClient.d.ts.map +1 -1
  75. package/dist/commonjs/callAutomationClient.js +79 -31
  76. package/dist/commonjs/callAutomationClient.js.map +1 -1
  77. package/dist/commonjs/callAutomationEventParser.d.ts.map +1 -1
  78. package/dist/commonjs/callAutomationEventParser.js +9 -10
  79. package/dist/commonjs/callAutomationEventParser.js.map +1 -1
  80. package/dist/commonjs/callConnection.d.ts +1 -1
  81. package/dist/commonjs/callConnection.d.ts.map +1 -1
  82. package/dist/commonjs/callConnection.js +82 -38
  83. package/dist/commonjs/callConnection.js.map +1 -1
  84. package/dist/commonjs/callMedia.d.ts +1 -1
  85. package/dist/commonjs/callMedia.d.ts.map +1 -1
  86. package/dist/commonjs/callMedia.js +42 -21
  87. package/dist/commonjs/callMedia.js.map +1 -1
  88. package/dist/commonjs/callRecording.js +12 -7
  89. package/dist/commonjs/callRecording.js.map +1 -1
  90. package/dist/commonjs/contentDownloader.js +11 -12
  91. package/dist/commonjs/contentDownloader.js.map +1 -1
  92. package/dist/commonjs/credential/callAutomationAccessKeyCredentialPolicy.js +1 -2
  93. package/dist/commonjs/credential/callAutomationAccessKeyCredentialPolicy.js.map +1 -1
  94. package/dist/commonjs/credential/callAutomationAuthPolicy.js +1 -1
  95. package/dist/commonjs/credential/callAutomationAuthPolicy.js.map +1 -1
  96. package/dist/commonjs/generated/src/callAutomationApiClient.js +14 -5
  97. package/dist/commonjs/generated/src/callAutomationApiClient.js.map +1 -1
  98. package/dist/commonjs/generated/src/models/index.d.ts +305 -322
  99. package/dist/commonjs/generated/src/models/index.d.ts.map +1 -1
  100. package/dist/commonjs/generated/src/models/index.js +30 -36
  101. package/dist/commonjs/generated/src/models/index.js.map +1 -1
  102. package/dist/commonjs/generated/src/models/mappers.d.ts +41 -34
  103. package/dist/commonjs/generated/src/models/mappers.d.ts.map +1 -1
  104. package/dist/commonjs/generated/src/models/mappers.js +484 -465
  105. package/dist/commonjs/generated/src/models/mappers.js.map +1 -1
  106. package/dist/commonjs/generated/src/models/parameters.js +1 -1
  107. package/dist/commonjs/generated/src/models/parameters.js.map +1 -1
  108. package/dist/commonjs/generated/src/operations/callConnection.js +23 -39
  109. package/dist/commonjs/generated/src/operations/callConnection.js.map +1 -1
  110. package/dist/commonjs/generated/src/operations/callMedia.js +1 -0
  111. package/dist/commonjs/generated/src/operations/callMedia.js.map +1 -1
  112. package/dist/commonjs/generated/src/operations/callRecording.js +1 -0
  113. package/dist/commonjs/generated/src/operations/callRecording.js.map +1 -1
  114. package/dist/commonjs/generated/src/pagingHelper.js +2 -4
  115. package/dist/commonjs/generated/src/pagingHelper.js.map +1 -1
  116. package/dist/commonjs/models/constants.d.ts.map +1 -1
  117. package/dist/commonjs/models/constants.js +1 -1
  118. package/dist/commonjs/models/constants.js.map +1 -1
  119. package/dist/commonjs/models/events.d.ts +295 -209
  120. package/dist/commonjs/models/events.d.ts.map +1 -1
  121. package/dist/commonjs/models/events.js.map +1 -1
  122. package/dist/commonjs/models/models.d.ts +44 -4
  123. package/dist/commonjs/models/models.d.ts.map +1 -1
  124. package/dist/commonjs/models/models.js +2 -16
  125. package/dist/commonjs/models/models.js.map +1 -1
  126. package/dist/commonjs/models/options.d.ts +17 -0
  127. package/dist/commonjs/models/options.d.ts.map +1 -1
  128. package/dist/commonjs/models/options.js.map +1 -1
  129. package/dist/commonjs/models/responses.d.ts +1 -1
  130. package/dist/commonjs/models/responses.d.ts.map +1 -1
  131. package/dist/commonjs/models/responses.js.map +1 -1
  132. package/dist/commonjs/models/streaming.d.ts +26 -27
  133. package/dist/commonjs/models/streaming.d.ts.map +1 -1
  134. package/dist/commonjs/models/streaming.js +31 -59
  135. package/dist/commonjs/models/streaming.js.map +1 -1
  136. package/dist/commonjs/streamingData.d.ts.map +1 -1
  137. package/dist/commonjs/streamingData.js +10 -1
  138. package/dist/commonjs/streamingData.js.map +1 -1
  139. package/dist/commonjs/tsdoc-metadata.json +11 -11
  140. package/dist/commonjs/utli/converters.d.ts.map +1 -1
  141. package/dist/commonjs/utli/converters.js +30 -9
  142. package/dist/commonjs/utli/converters.js.map +1 -1
  143. package/dist/esm/callAutomationClient.d.ts +2 -3
  144. package/dist/esm/callAutomationClient.d.ts.map +1 -1
  145. package/dist/esm/callAutomationClient.js +79 -31
  146. package/dist/esm/callAutomationClient.js.map +1 -1
  147. package/dist/esm/callAutomationEventParser.d.ts.map +1 -1
  148. package/dist/esm/callAutomationEventParser.js +9 -10
  149. package/dist/esm/callAutomationEventParser.js.map +1 -1
  150. package/dist/esm/callConnection.d.ts +1 -1
  151. package/dist/esm/callConnection.d.ts.map +1 -1
  152. package/dist/esm/callConnection.js +82 -38
  153. package/dist/esm/callConnection.js.map +1 -1
  154. package/dist/esm/callMedia.d.ts +1 -1
  155. package/dist/esm/callMedia.d.ts.map +1 -1
  156. package/dist/esm/callMedia.js +33 -12
  157. package/dist/esm/callMedia.js.map +1 -1
  158. package/dist/esm/callRecording.js +11 -6
  159. package/dist/esm/callRecording.js.map +1 -1
  160. package/dist/esm/contentDownloader.js +11 -12
  161. package/dist/esm/contentDownloader.js.map +1 -1
  162. package/dist/esm/credential/callAutomationAccessKeyCredentialPolicy.js +1 -2
  163. package/dist/esm/credential/callAutomationAccessKeyCredentialPolicy.js.map +1 -1
  164. package/dist/esm/credential/callAutomationAuthPolicy.js +1 -1
  165. package/dist/esm/credential/callAutomationAuthPolicy.js.map +1 -1
  166. package/dist/esm/generated/src/callAutomationApiClient.js +14 -5
  167. package/dist/esm/generated/src/callAutomationApiClient.js.map +1 -1
  168. package/dist/esm/generated/src/models/index.d.ts +305 -322
  169. package/dist/esm/generated/src/models/index.d.ts.map +1 -1
  170. package/dist/esm/generated/src/models/index.js +29 -35
  171. package/dist/esm/generated/src/models/index.js.map +1 -1
  172. package/dist/esm/generated/src/models/mappers.d.ts +41 -34
  173. package/dist/esm/generated/src/models/mappers.d.ts.map +1 -1
  174. package/dist/esm/generated/src/models/mappers.js +481 -462
  175. package/dist/esm/generated/src/models/mappers.js.map +1 -1
  176. package/dist/esm/generated/src/models/parameters.js +1 -1
  177. package/dist/esm/generated/src/models/parameters.js.map +1 -1
  178. package/dist/esm/generated/src/operations/callConnection.js +23 -40
  179. package/dist/esm/generated/src/operations/callConnection.js.map +1 -1
  180. package/dist/esm/generated/src/operations/callMedia.js +1 -0
  181. package/dist/esm/generated/src/operations/callMedia.js.map +1 -1
  182. package/dist/esm/generated/src/operations/callRecording.js +1 -0
  183. package/dist/esm/generated/src/operations/callRecording.js.map +1 -1
  184. package/dist/esm/generated/src/pagingHelper.js +2 -4
  185. package/dist/esm/generated/src/pagingHelper.js.map +1 -1
  186. package/dist/esm/models/constants.d.ts.map +1 -1
  187. package/dist/esm/models/constants.js +1 -1
  188. package/dist/esm/models/constants.js.map +1 -1
  189. package/dist/esm/models/events.d.ts +295 -209
  190. package/dist/esm/models/events.d.ts.map +1 -1
  191. package/dist/esm/models/events.js.map +1 -1
  192. package/dist/esm/models/models.d.ts +44 -4
  193. package/dist/esm/models/models.d.ts.map +1 -1
  194. package/dist/esm/models/models.js +1 -1
  195. package/dist/esm/models/models.js.map +1 -1
  196. package/dist/esm/models/options.d.ts +17 -0
  197. package/dist/esm/models/options.d.ts.map +1 -1
  198. package/dist/esm/models/options.js.map +1 -1
  199. package/dist/esm/models/responses.d.ts +1 -1
  200. package/dist/esm/models/responses.d.ts.map +1 -1
  201. package/dist/esm/models/responses.js.map +1 -1
  202. package/dist/esm/models/streaming.d.ts +26 -27
  203. package/dist/esm/models/streaming.d.ts.map +1 -1
  204. package/dist/esm/models/streaming.js +28 -57
  205. package/dist/esm/models/streaming.js.map +1 -1
  206. package/dist/esm/streamingData.d.ts.map +1 -1
  207. package/dist/esm/streamingData.js +10 -1
  208. package/dist/esm/streamingData.js.map +1 -1
  209. package/dist/esm/utli/converters.d.ts.map +1 -1
  210. package/dist/esm/utli/converters.js +30 -9
  211. package/dist/esm/utli/converters.js.map +1 -1
  212. package/dist/react-native/callAutomationClient.d.ts +2 -3
  213. package/dist/react-native/callAutomationClient.d.ts.map +1 -1
  214. package/dist/react-native/callAutomationClient.js +79 -31
  215. package/dist/react-native/callAutomationClient.js.map +1 -1
  216. package/dist/react-native/callAutomationEventParser.d.ts.map +1 -1
  217. package/dist/react-native/callAutomationEventParser.js +9 -10
  218. package/dist/react-native/callAutomationEventParser.js.map +1 -1
  219. package/dist/react-native/callConnection.d.ts +1 -1
  220. package/dist/react-native/callConnection.d.ts.map +1 -1
  221. package/dist/react-native/callConnection.js +82 -38
  222. package/dist/react-native/callConnection.js.map +1 -1
  223. package/dist/react-native/callMedia.d.ts +1 -1
  224. package/dist/react-native/callMedia.d.ts.map +1 -1
  225. package/dist/react-native/callMedia.js +33 -12
  226. package/dist/react-native/callMedia.js.map +1 -1
  227. package/dist/react-native/callRecording.js +11 -6
  228. package/dist/react-native/callRecording.js.map +1 -1
  229. package/dist/react-native/contentDownloader.js +11 -12
  230. package/dist/react-native/contentDownloader.js.map +1 -1
  231. package/dist/react-native/credential/callAutomationAccessKeyCredentialPolicy.js +1 -2
  232. package/dist/react-native/credential/callAutomationAccessKeyCredentialPolicy.js.map +1 -1
  233. package/dist/react-native/credential/callAutomationAuthPolicy.js +1 -1
  234. package/dist/react-native/credential/callAutomationAuthPolicy.js.map +1 -1
  235. package/dist/react-native/generated/src/callAutomationApiClient.js +14 -5
  236. package/dist/react-native/generated/src/callAutomationApiClient.js.map +1 -1
  237. package/dist/react-native/generated/src/models/index.d.ts +305 -322
  238. package/dist/react-native/generated/src/models/index.d.ts.map +1 -1
  239. package/dist/react-native/generated/src/models/index.js +29 -35
  240. package/dist/react-native/generated/src/models/index.js.map +1 -1
  241. package/dist/react-native/generated/src/models/mappers.d.ts +41 -34
  242. package/dist/react-native/generated/src/models/mappers.d.ts.map +1 -1
  243. package/dist/react-native/generated/src/models/mappers.js +481 -462
  244. package/dist/react-native/generated/src/models/mappers.js.map +1 -1
  245. package/dist/react-native/generated/src/models/parameters.js +1 -1
  246. package/dist/react-native/generated/src/models/parameters.js.map +1 -1
  247. package/dist/react-native/generated/src/operations/callConnection.js +23 -40
  248. package/dist/react-native/generated/src/operations/callConnection.js.map +1 -1
  249. package/dist/react-native/generated/src/operations/callMedia.js +1 -0
  250. package/dist/react-native/generated/src/operations/callMedia.js.map +1 -1
  251. package/dist/react-native/generated/src/operations/callRecording.js +1 -0
  252. package/dist/react-native/generated/src/operations/callRecording.js.map +1 -1
  253. package/dist/react-native/generated/src/pagingHelper.js +2 -4
  254. package/dist/react-native/generated/src/pagingHelper.js.map +1 -1
  255. package/dist/react-native/models/constants.d.ts.map +1 -1
  256. package/dist/react-native/models/constants.js +1 -1
  257. package/dist/react-native/models/constants.js.map +1 -1
  258. package/dist/react-native/models/events.d.ts +295 -209
  259. package/dist/react-native/models/events.d.ts.map +1 -1
  260. package/dist/react-native/models/events.js.map +1 -1
  261. package/dist/react-native/models/models.d.ts +44 -4
  262. package/dist/react-native/models/models.d.ts.map +1 -1
  263. package/dist/react-native/models/models.js +1 -1
  264. package/dist/react-native/models/models.js.map +1 -1
  265. package/dist/react-native/models/options.d.ts +17 -0
  266. package/dist/react-native/models/options.d.ts.map +1 -1
  267. package/dist/react-native/models/options.js.map +1 -1
  268. package/dist/react-native/models/responses.d.ts +1 -1
  269. package/dist/react-native/models/responses.d.ts.map +1 -1
  270. package/dist/react-native/models/responses.js.map +1 -1
  271. package/dist/react-native/models/streaming.d.ts +26 -27
  272. package/dist/react-native/models/streaming.d.ts.map +1 -1
  273. package/dist/react-native/models/streaming.js +28 -57
  274. package/dist/react-native/models/streaming.js.map +1 -1
  275. package/dist/react-native/streamingData.d.ts.map +1 -1
  276. package/dist/react-native/streamingData.js +10 -1
  277. package/dist/react-native/streamingData.js.map +1 -1
  278. package/dist/react-native/utli/converters.d.ts.map +1 -1
  279. package/dist/react-native/utli/converters.js +30 -9
  280. package/dist/react-native/utli/converters.js.map +1 -1
  281. package/package.json +37 -44
@@ -1,4 +1,6 @@
1
1
  import * as coreClient from "@azure/core-client";
2
+ export type MediaStreamingOptionsInternalUnion = MediaStreamingOptionsInternal | WebSocketMediaStreamingOptions;
3
+ export type TranscriptionOptionsInternalUnion = TranscriptionOptionsInternal | WebSocketTranscriptionOptions;
2
4
  /** The request payload for creating the call. */
3
5
  export interface CreateCallRequest {
4
6
  /** The targets of the call. */
@@ -19,9 +21,9 @@ export interface CreateCallRequest {
19
21
  /** AI options for the call. */
20
22
  callIntelligenceOptions?: CallIntelligenceOptionsInternal;
21
23
  /** Media Streaming Options. */
22
- mediaStreamingOptions?: MediaStreamingOptions;
24
+ mediaStreamingOptions?: MediaStreamingOptionsInternalUnion;
23
25
  /** Transcription Options. */
24
- transcriptionOptions?: TranscriptionOptions;
26
+ transcriptionOptions?: TranscriptionOptionsInternalUnion;
25
27
  /** The identifier of the source for creating call with Teams resource account ID. */
26
28
  teamsAppSource?: MicrosoftTeamsAppIdentifierModel;
27
29
  }
@@ -88,37 +90,19 @@ export interface CallIntelligenceOptionsInternal {
88
90
  /** The identifier of the Cognitive Service resource assigned to this call. */
89
91
  cognitiveServicesEndpoint?: string;
90
92
  }
91
- /** Configuration of Media streaming. */
92
- export interface MediaStreamingOptions {
93
- /** Transport URL for media streaming */
94
- transportUrl: string;
95
- /** The type of transport to be used for media streaming, eg. Websocket */
96
- transportType: MediaStreamingTransportType;
97
- /** Content type to stream, eg. audio */
98
- contentType: MediaStreamingContentType;
99
- /** Audio channel type to stream, eg. unmixed audio, mixed audio */
93
+ /** Options for media streaming. */
94
+ export interface MediaStreamingOptionsInternal {
95
+ /** Polymorphic discriminator, which specifies the different types this object can be */
96
+ transportType: "websocket";
97
+ /** The audio channel type to stream, e.g., unmixed audio, mixed audio. */
100
98
  audioChannelType: MediaStreamingAudioChannelType;
101
- /** Determines if the media streaming should be started immediately after call is answered or not. */
102
- startMediaStreaming?: boolean;
103
- /** A value indicating whether bidirectional streaming is enabled. */
104
- enableBidirectional?: boolean;
105
- /** Specifies the audio format used for encoding, including sample rate and channel type. */
106
- audioFormat?: AudioFormat;
107
99
  }
108
- /** Configuration of live transcription. */
109
- export interface TranscriptionOptions {
110
- /** Transport URL for live transcription */
111
- transportUrl: string;
112
- /** The type of transport to be used for live transcription, eg. Websocket */
113
- transportType: TranscriptionTransportType;
114
- /** Defines the locale for the data e.g en-CA, en-AU */
100
+ /** Options for live transcription. */
101
+ export interface TranscriptionOptionsInternal {
102
+ /** Polymorphic discriminator, which specifies the different types this object can be */
103
+ transportType: "websocket";
104
+ /** Specifies the Locale used for transcription, e.g., en-CA or en-AU. */
115
105
  locale: string;
116
- /** Endpoint where the custom model was deployed. */
117
- speechRecognitionModelEndpointId?: string;
118
- /** Determines if the transcription should be started immediately after call is answered or not. */
119
- startTranscription: boolean;
120
- /** Enables intermediate results for the transcribed speech. */
121
- enableIntermediateResults?: boolean;
122
106
  }
123
107
  /** Properties of a call connection */
124
108
  export interface CallConnectionPropertiesInternal {
@@ -169,6 +153,8 @@ export interface TranscriptionSubscription {
169
153
  state?: TranscriptionSubscriptionState;
170
154
  /** Subscribed transcription result types. */
171
155
  subscribedResultStates?: TranscriptionResultState[];
156
+ /** Specifies the locale used for transcription, e.g., en-CA or en-AU. */
157
+ locale?: string;
172
158
  }
173
159
  /** The Communication Services error. */
174
160
  export interface CommunicationErrorResponse {
@@ -210,9 +196,9 @@ export interface AnswerCallRequest {
210
196
  /** The identifier of the call automation entity which answers the call */
211
197
  answeredBy?: CommunicationUserIdentifierModel;
212
198
  /** Media Streaming Options. */
213
- mediaStreamingOptions?: MediaStreamingOptions;
199
+ mediaStreamingOptions?: MediaStreamingOptionsInternalUnion;
214
200
  /** Transcription Options. */
215
- transcriptionOptions?: TranscriptionOptions;
201
+ transcriptionOptions?: TranscriptionOptionsInternalUnion;
216
202
  }
217
203
  /** The request payload for redirecting the call. */
218
204
  export interface RedirectCallRequest {
@@ -238,10 +224,10 @@ export interface ConnectRequest {
238
224
  operationContext?: string;
239
225
  /** AI options for the call. */
240
226
  callIntelligenceOptions?: CallIntelligenceOptionsInternal;
241
- /** Media Streaming Configuration. */
242
- mediaStreamingOptions?: MediaStreamingOptions;
243
- /** Live Transcription Configuration. */
244
- transcriptionOptions?: TranscriptionOptions;
227
+ /** Media Streaming Options. */
228
+ mediaStreamingOptions?: MediaStreamingOptionsInternalUnion;
229
+ /** Transcription Options. */
230
+ transcriptionOptions?: TranscriptionOptionsInternalUnion;
245
231
  }
246
232
  /** The locator used for joining or taking action on a call */
247
233
  export interface CallLocator {
@@ -353,24 +339,39 @@ export interface PlayOptionsInternal {
353
339
  loop: boolean;
354
340
  }
355
341
  export interface StartTranscriptionRequest {
356
- /** Defines Locale for the transcription e,g en-US */
342
+ /** Specifies the Locale used for transcription, e.g., en-CA or en-AU. */
357
343
  locale?: string;
358
- /** Endpoint where the custom model was deployed. */
359
- speechRecognitionModelEndpointId?: string;
344
+ /** The ID of the deployed custom model in GUID format. The GUID is generated by Azure Speech Studio, e.g., a259c255-1cdw-4ed7-a693-dd58563b6f6a. */
345
+ speechModelEndpointId?: string;
360
346
  /** The value to identify context of the operation. */
361
347
  operationContext?: string;
348
+ /**
349
+ * Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.
350
+ * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
351
+ */
352
+ operationCallbackUri?: string;
362
353
  }
363
354
  export interface StopTranscriptionRequest {
364
355
  /** The value to identify context of the operation. */
365
356
  operationContext?: string;
357
+ /**
358
+ * Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.
359
+ * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
360
+ */
361
+ operationCallbackUri?: string;
366
362
  }
367
363
  export interface UpdateTranscriptionRequest {
368
- /** Sets new locale for transcription. */
369
- locale: string;
370
- /** Sets Endpoint id where the custom model was deployed. */
371
- speechRecognitionModelEndpointId?: string;
364
+ /** Specifies the Locale used for transcription, e.g., en-CA or en-AU. */
365
+ locale?: string;
366
+ /** The ID of the deployed custom model, in GUID format, e.g., a259c255-1cdw-4ed7-a693-dd58563b6f6a. */
367
+ speechModelEndpointId?: string;
372
368
  /** The value to identify context of the operation. */
373
369
  operationContext?: string;
370
+ /**
371
+ * Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.
372
+ * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
373
+ */
374
+ operationCallbackUri?: string;
374
375
  }
375
376
  export interface RecognizeRequest {
376
377
  /** Determines the type of the recognition. */
@@ -481,6 +482,11 @@ export interface UnholdRequest {
481
482
  targetParticipant: CommunicationIdentifierModel;
482
483
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
483
484
  operationContext?: string;
485
+ /**
486
+ * Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.
487
+ * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
488
+ */
489
+ operationCallbackUri?: string;
484
490
  }
485
491
  export interface StartMediaStreamingRequest {
486
492
  /**
@@ -659,8 +665,8 @@ export interface RecordingStateResponse {
659
665
  recordingState?: RecordingState;
660
666
  recordingKind?: RecordingKind;
661
667
  }
662
- /** The ConnectFailed event. */
663
- export interface ConnectFailed {
668
+ /** The failed to add participants event. */
669
+ export interface AddParticipantFailed {
664
670
  /** Call connection ID. */
665
671
  callConnectionId?: string;
666
672
  /** Server call ID. */
@@ -670,9 +676,11 @@ export interface ConnectFailed {
670
676
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
671
677
  operationContext?: string;
672
678
  /** Contains the resulting SIP code, sub-code and message. */
673
- resultInformation?: RestResultInformation;
679
+ resultInformation?: ResultInformation;
680
+ /** Participant */
681
+ participant?: CommunicationIdentifierModel;
674
682
  }
675
- export interface RestResultInformation {
683
+ export interface ResultInformation {
676
684
  /** Code of the current result. This can be helpful to Call Automation team to troubleshoot the issue if this result was unexpected. */
677
685
  code?: number;
678
686
  /** Subcode of the current result. This can be helpful to Call Automation team to troubleshoot the issue if this result was unexpected. */
@@ -680,8 +688,8 @@ export interface RestResultInformation {
680
688
  /** Detail message that describes the current result. */
681
689
  message?: string;
682
690
  }
683
- /** Play started event. */
684
- export interface PlayStarted {
691
+ /** The participants successfully added event. */
692
+ export interface AddParticipantSucceeded {
685
693
  /** Call connection ID. */
686
694
  callConnectionId?: string;
687
695
  /** Server call ID. */
@@ -691,32 +699,12 @@ export interface PlayStarted {
691
699
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
692
700
  operationContext?: string;
693
701
  /** Contains the resulting SIP code, sub-code and message. */
694
- resultInformation?: RestResultInformation;
695
- }
696
- export interface DtmfResult {
697
- /** NOTE: This property will not be serialized. It can only be populated by the server. */
698
- readonly tones?: Tone[];
699
- }
700
- export interface ChoiceResult {
701
- /** Label is the primary identifier for the choice detected */
702
- label?: string;
703
- /**
704
- * Phrases are set to the value if choice is selected via phrase detection.
705
- * If Dtmf input is recognized, then Label will be the identifier for the choice detected and phrases will be set to null
706
- */
707
- recognizedPhrase?: string;
708
- }
709
- /** The speech status as a result. */
710
- export interface SpeechResult {
711
- /** The recognized speech in string. */
712
- speech?: string;
702
+ resultInformation?: ResultInformation;
703
+ /** Participant */
704
+ participant?: CommunicationIdentifierModel;
713
705
  }
714
- export interface MediaStreamingFailed {
715
- /**
716
- * Defines the result for MediaStreamingUpdate with the current status and the details about the status
717
- * NOTE: This property will not be serialized. It can only be populated by the server.
718
- */
719
- readonly mediaStreamingUpdate?: MediaStreamingUpdate;
706
+ /** The call connected event. */
707
+ export interface CallConnected {
720
708
  /** Call connection ID. */
721
709
  callConnectionId?: string;
722
710
  /** Server call ID. */
@@ -726,19 +714,10 @@ export interface MediaStreamingFailed {
726
714
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
727
715
  operationContext?: string;
728
716
  /** Contains the resulting SIP code, sub-code and message. */
729
- resultInformation?: RestResultInformation;
730
- }
731
- export interface MediaStreamingUpdate {
732
- contentType?: string;
733
- mediaStreamingStatus?: MediaStreamingStatus;
734
- mediaStreamingStatusDetails?: MediaStreamingStatusDetails;
717
+ resultInformation?: ResultInformation;
735
718
  }
736
- export interface MediaStreamingStarted {
737
- /**
738
- * Defines the result for MediaStreamingUpdate with the current status and the details about the status
739
- * NOTE: This property will not be serialized. It can only be populated by the server.
740
- */
741
- readonly mediaStreamingUpdate?: MediaStreamingUpdate;
719
+ /** The call disconnected event. */
720
+ export interface CallDisconnected {
742
721
  /** Call connection ID. */
743
722
  callConnectionId?: string;
744
723
  /** Server call ID. */
@@ -748,14 +727,10 @@ export interface MediaStreamingStarted {
748
727
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
749
728
  operationContext?: string;
750
729
  /** Contains the resulting SIP code, sub-code and message. */
751
- resultInformation?: RestResultInformation;
730
+ resultInformation?: ResultInformation;
752
731
  }
753
- export interface MediaStreamingStopped {
754
- /**
755
- * Defines the result for MediaStreamingUpdate with the current status and the details about the status
756
- * NOTE: This property will not be serialized. It can only be populated by the server.
757
- */
758
- readonly mediaStreamingUpdate?: MediaStreamingUpdate;
732
+ /** The call transfer accepted event. */
733
+ export interface CallTransferAccepted {
759
734
  /** Call connection ID. */
760
735
  callConnectionId?: string;
761
736
  /** Server call ID. */
@@ -765,14 +740,14 @@ export interface MediaStreamingStopped {
765
740
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
766
741
  operationContext?: string;
767
742
  /** Contains the resulting SIP code, sub-code and message. */
768
- resultInformation?: RestResultInformation;
743
+ resultInformation?: ResultInformation;
744
+ /** Target who the call is transferred to. */
745
+ transferTarget?: CommunicationIdentifierModel;
746
+ /** the participant who is being transferred away. */
747
+ transferee?: CommunicationIdentifierModel;
769
748
  }
770
- export interface StartRecordingFailed {
771
- /**
772
- * The call recording Id.
773
- * NOTE: This property will not be serialized. It can only be populated by the server.
774
- */
775
- readonly recordingId?: string;
749
+ /** The call transfer failed event. */
750
+ export interface CallTransferFailed {
776
751
  /** Call connection ID. */
777
752
  callConnectionId?: string;
778
753
  /** Server call ID. */
@@ -782,29 +757,25 @@ export interface StartRecordingFailed {
782
757
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
783
758
  operationContext?: string;
784
759
  /** Contains the resulting SIP code, sub-code and message. */
785
- resultInformation?: RestResultInformation;
786
- }
787
- export interface TranscriptionUpdate {
788
- transcriptionStatus?: TranscriptionStatus;
789
- transcriptionStatusDetails?: TranscriptionStatusDetails;
760
+ resultInformation?: ResultInformation;
790
761
  }
791
- /** The participants successfully added event. */
792
- export interface RestAddParticipantSucceeded {
762
+ /** The participants updated in a call event. */
763
+ export interface ParticipantsUpdated {
793
764
  /** Call connection ID. */
794
765
  callConnectionId?: string;
795
766
  /** Server call ID. */
796
767
  serverCallId?: string;
797
768
  /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
798
769
  correlationId?: string;
799
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
800
- operationContext?: string;
770
+ /** The Sequence Number of the event */
771
+ sequenceNumber?: number;
772
+ /** The list of participants in the call. */
773
+ participants?: CallParticipantInternal[];
801
774
  /** Contains the resulting SIP code, sub-code and message. */
802
- resultInformation?: RestResultInformation;
803
- /** Participant */
804
- participant?: CommunicationIdentifierModel;
775
+ resultInformation?: ResultInformation;
805
776
  }
806
- /** The failed to add participants event. */
807
- export interface RestAddParticipantFailed {
777
+ /** The participant removed event. */
778
+ export interface RemoveParticipantSucceeded {
808
779
  /** Call connection ID. */
809
780
  callConnectionId?: string;
810
781
  /** Server call ID. */
@@ -814,12 +785,12 @@ export interface RestAddParticipantFailed {
814
785
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
815
786
  operationContext?: string;
816
787
  /** Contains the resulting SIP code, sub-code and message. */
817
- resultInformation?: RestResultInformation;
788
+ resultInformation?: ResultInformation;
818
789
  /** Participant */
819
790
  participant?: CommunicationIdentifierModel;
820
791
  }
821
- /** The participant removed event. */
822
- export interface RestRemoveParticipantSucceeded {
792
+ /** The failed to remove participant event. */
793
+ export interface RemoveParticipantFailed {
823
794
  /** Call connection ID. */
824
795
  callConnectionId?: string;
825
796
  /** Server call ID. */
@@ -829,12 +800,12 @@ export interface RestRemoveParticipantSucceeded {
829
800
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
830
801
  operationContext?: string;
831
802
  /** Contains the resulting SIP code, sub-code and message. */
832
- resultInformation?: RestResultInformation;
803
+ resultInformation?: ResultInformation;
833
804
  /** Participant */
834
805
  participant?: CommunicationIdentifierModel;
835
806
  }
836
- /** The failed to remove participant event. */
837
- export interface RestRemoveParticipantFailed {
807
+ /** Successful cancel add participant event. */
808
+ export interface CancelAddParticipantSucceeded {
838
809
  /** Call connection ID. */
839
810
  callConnectionId?: string;
840
811
  /** Server call ID. */
@@ -843,13 +814,13 @@ export interface RestRemoveParticipantFailed {
843
814
  correlationId?: string;
844
815
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
845
816
  operationContext?: string;
817
+ /** Invitation ID used to cancel the request. */
818
+ invitationId?: string;
846
819
  /** Contains the resulting SIP code, sub-code and message. */
847
- resultInformation?: RestResultInformation;
848
- /** Participant */
849
- participant?: CommunicationIdentifierModel;
820
+ resultInformation?: ResultInformation;
850
821
  }
851
- /** The call connected event. */
852
- export interface RestCallConnected {
822
+ /** Failed cancel add participant event. */
823
+ export interface CancelAddParticipantFailed {
853
824
  /** Call connection ID. */
854
825
  callConnectionId?: string;
855
826
  /** Server call ID. */
@@ -859,10 +830,12 @@ export interface RestCallConnected {
859
830
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
860
831
  operationContext?: string;
861
832
  /** Contains the resulting SIP code, sub-code and message. */
862
- resultInformation?: RestResultInformation;
833
+ resultInformation?: ResultInformation;
834
+ /** Invitation ID used to cancel the request. */
835
+ invitationId?: string;
863
836
  }
864
- /** The call disconnected event. */
865
- export interface RestCallDisconnected {
837
+ /** The failed to answer call event. */
838
+ export interface AnswerFailed {
866
839
  /** Call connection ID. */
867
840
  callConnectionId?: string;
868
841
  /** Server call ID. */
@@ -872,10 +845,10 @@ export interface RestCallDisconnected {
872
845
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
873
846
  operationContext?: string;
874
847
  /** Contains the resulting SIP code, sub-code and message. */
875
- resultInformation?: RestResultInformation;
848
+ resultInformation?: ResultInformation;
876
849
  }
877
- /** The call transfer accepted event. */
878
- export interface RestCallTransferAccepted {
850
+ /** The create call failed event. */
851
+ export interface CreateCallFailed {
879
852
  /** Call connection ID. */
880
853
  callConnectionId?: string;
881
854
  /** Server call ID. */
@@ -885,14 +858,10 @@ export interface RestCallTransferAccepted {
885
858
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
886
859
  operationContext?: string;
887
860
  /** Contains the resulting SIP code, sub-code and message. */
888
- resultInformation?: RestResultInformation;
889
- /** Target who the call is transferred to. */
890
- transferTarget?: CommunicationIdentifierModel;
891
- /** the participant who is being transferred away. */
892
- transferee?: CommunicationIdentifierModel;
861
+ resultInformation?: ResultInformation;
893
862
  }
894
- /** The call transfer failed event. */
895
- export interface RestCallTransferFailed {
863
+ /** The ConnectFailed event. */
864
+ export interface ConnectFailed {
896
865
  /** Call connection ID. */
897
866
  callConnectionId?: string;
898
867
  /** Server call ID. */
@@ -902,9 +871,9 @@ export interface RestCallTransferFailed {
902
871
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
903
872
  operationContext?: string;
904
873
  /** Contains the resulting SIP code, sub-code and message. */
905
- resultInformation?: RestResultInformation;
874
+ resultInformation?: ResultInformation;
906
875
  }
907
- export interface RestRecordingStateChanged {
876
+ export interface RecordingStateChanged {
908
877
  /** Call connection ID. */
909
878
  callConnectionId?: string;
910
879
  /** Server call ID. */
@@ -924,24 +893,22 @@ export interface RestRecordingStateChanged {
924
893
  readonly startDateTime?: Date;
925
894
  recordingKind?: RecordingKind;
926
895
  /** Contains the resulting SIP code, sub-code and message. */
927
- resultInformation?: RestResultInformation;
896
+ resultInformation?: ResultInformation;
928
897
  }
929
- /** The participants updated in a call event. */
930
- export interface RestParticipantsUpdated {
898
+ /** Play started event. */
899
+ export interface PlayStarted {
931
900
  /** Call connection ID. */
932
901
  callConnectionId?: string;
933
902
  /** Server call ID. */
934
903
  serverCallId?: string;
935
904
  /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
936
905
  correlationId?: string;
937
- /** The Sequence Number of the event */
938
- sequenceNumber?: number;
939
- /** The list of participants in the call. */
940
- participants?: CallParticipantInternal[];
906
+ /** Used by customers when calling mid-call actions to correlate the request to the response event. */
907
+ operationContext?: string;
941
908
  /** Contains the resulting SIP code, sub-code and message. */
942
- resultInformation?: RestResultInformation;
909
+ resultInformation?: ResultInformation;
943
910
  }
944
- export interface RestPlayCompleted {
911
+ export interface PlayCompleted {
945
912
  /** Call connection ID. */
946
913
  callConnectionId?: string;
947
914
  /** Server call ID. */
@@ -951,9 +918,9 @@ export interface RestPlayCompleted {
951
918
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
952
919
  operationContext?: string;
953
920
  /** Contains the resulting SIP code, sub-code and message. */
954
- resultInformation?: RestResultInformation;
921
+ resultInformation?: ResultInformation;
955
922
  }
956
- export interface RestPlayFailed {
923
+ export interface PlayFailed {
957
924
  /** Call connection ID. */
958
925
  callConnectionId?: string;
959
926
  /** Server call ID. */
@@ -963,11 +930,11 @@ export interface RestPlayFailed {
963
930
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
964
931
  operationContext?: string;
965
932
  /** Contains the resulting SIP code, sub-code and message. */
966
- resultInformation?: RestResultInformation;
933
+ resultInformation?: ResultInformation;
967
934
  /** Contains the index of the failed play source. */
968
935
  failedPlaySourceIndex?: number;
969
936
  }
970
- export interface RestPlayCanceled {
937
+ export interface PlayCanceled {
971
938
  /** Call connection ID. */
972
939
  callConnectionId?: string;
973
940
  /** Server call ID. */
@@ -977,9 +944,9 @@ export interface RestPlayCanceled {
977
944
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
978
945
  operationContext?: string;
979
946
  /** Contains the resulting SIP code, sub-code and message. */
980
- resultInformation?: RestResultInformation;
947
+ resultInformation?: ResultInformation;
981
948
  }
982
- export interface RestRecognizeCompleted {
949
+ export interface RecognizeCompleted {
983
950
  /** Call connection ID. */
984
951
  callConnectionId?: string;
985
952
  /** Server call ID. */
@@ -989,7 +956,7 @@ export interface RestRecognizeCompleted {
989
956
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
990
957
  operationContext?: string;
991
958
  /** Contains the resulting SIP code, sub-code and message. */
992
- resultInformation?: RestResultInformation;
959
+ resultInformation?: ResultInformation;
993
960
  /**
994
961
  * Determines the sub-type of the recognize operation.
995
962
  * In case of cancel operation the this field is not set and is returned empty
@@ -1005,7 +972,29 @@ export interface RestRecognizeCompleted {
1005
972
  */
1006
973
  readonly speechResult?: SpeechResult;
1007
974
  }
1008
- export interface RestRecognizeFailed {
975
+ export interface DtmfResult {
976
+ /** NOTE: This property will not be serialized. It can only be populated by the server. */
977
+ readonly tones?: Tone[];
978
+ }
979
+ export interface ChoiceResult {
980
+ /** Label is the primary identifier for the choice detected */
981
+ label?: string;
982
+ /**
983
+ * Phrases are set to the value if choice is selected via phrase detection.
984
+ * If Dtmf input is recognized, then Label will be the identifier for the choice detected and phrases will be set to null
985
+ */
986
+ recognizedPhrase?: string;
987
+ /** The confidence level of the recognized speech, if available, ranges from 0.0 to 1.0 */
988
+ confidence?: number;
989
+ }
990
+ /** The speech status as a result. */
991
+ export interface SpeechResult {
992
+ /** The recognized speech in string. */
993
+ speech?: string;
994
+ /** The confidence level of the recognized speech, if available, ranges from 0.0 to 1.0. */
995
+ confidence?: number;
996
+ }
997
+ export interface RecognizeFailed {
1009
998
  /** Call connection ID. */
1010
999
  callConnectionId?: string;
1011
1000
  /** Server call ID. */
@@ -1015,11 +1004,11 @@ export interface RestRecognizeFailed {
1015
1004
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1016
1005
  operationContext?: string;
1017
1006
  /** Contains the resulting SIP code, sub-code and message. */
1018
- resultInformation?: RestResultInformation;
1007
+ resultInformation?: ResultInformation;
1019
1008
  /** Contains the index of the failed play source. */
1020
1009
  failedPlaySourceIndex?: number;
1021
1010
  }
1022
- export interface RestRecognizeCanceled {
1011
+ export interface RecognizeCanceled {
1023
1012
  /** Call connection ID. */
1024
1013
  callConnectionId?: string;
1025
1014
  /** Server call ID. */
@@ -1029,39 +1018,39 @@ export interface RestRecognizeCanceled {
1029
1018
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1030
1019
  operationContext?: string;
1031
1020
  /** Contains the resulting SIP code, sub-code and message. */
1032
- resultInformation?: RestResultInformation;
1021
+ resultInformation?: ResultInformation;
1033
1022
  }
1034
- export interface RestContinuousDtmfRecognitionToneReceived {
1035
- /**
1036
- * The sequence id which can be used to determine if the same tone was played multiple times or if any tones were missed.
1037
- * NOTE: This property will not be serialized. It can only be populated by the server.
1038
- */
1039
- readonly sequenceId?: number;
1040
- tone?: Tone;
1023
+ export interface ContinuousDtmfRecognitionToneFailed {
1041
1024
  /** Call connection ID. */
1042
1025
  callConnectionId?: string;
1043
1026
  /** Server call ID. */
1044
1027
  serverCallId?: string;
1045
1028
  /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1046
1029
  correlationId?: string;
1030
+ /** Contains the resulting SIP code, sub-code and message. */
1031
+ resultInformation?: ResultInformation;
1047
1032
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1048
1033
  operationContext?: string;
1049
- /** Contains the resulting SIP code, sub-code and message. */
1050
- resultInformation?: RestResultInformation;
1051
1034
  }
1052
- export interface RestContinuousDtmfRecognitionToneFailed {
1035
+ export interface ContinuousDtmfRecognitionToneReceived {
1036
+ /**
1037
+ * The sequence id which can be used to determine if the same tone was played multiple times or if any tones were missed.
1038
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1039
+ */
1040
+ readonly sequenceId?: number;
1041
+ tone?: Tone;
1053
1042
  /** Call connection ID. */
1054
1043
  callConnectionId?: string;
1055
1044
  /** Server call ID. */
1056
1045
  serverCallId?: string;
1057
1046
  /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1058
1047
  correlationId?: string;
1059
- /** Contains the resulting SIP code, sub-code and message. */
1060
- resultInformation?: RestResultInformation;
1061
1048
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1062
1049
  operationContext?: string;
1050
+ /** Contains the resulting SIP code, sub-code and message. */
1051
+ resultInformation?: ResultInformation;
1063
1052
  }
1064
- export interface RestContinuousDtmfRecognitionStopped {
1053
+ export interface ContinuousDtmfRecognitionStopped {
1065
1054
  /** Call connection ID. */
1066
1055
  callConnectionId?: string;
1067
1056
  /** Server call ID. */
@@ -1071,9 +1060,9 @@ export interface RestContinuousDtmfRecognitionStopped {
1071
1060
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1072
1061
  operationContext?: string;
1073
1062
  /** Contains the resulting SIP code, sub-code and message. */
1074
- resultInformation?: RestResultInformation;
1063
+ resultInformation?: ResultInformation;
1075
1064
  }
1076
- export interface RestSendDtmfTonesCompleted {
1065
+ export interface SendDtmfTonesCompleted {
1077
1066
  /** Call connection ID. */
1078
1067
  callConnectionId?: string;
1079
1068
  /** Server call ID. */
@@ -1083,9 +1072,9 @@ export interface RestSendDtmfTonesCompleted {
1083
1072
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1084
1073
  operationContext?: string;
1085
1074
  /** Contains the resulting SIP code, sub-code and message. */
1086
- resultInformation?: RestResultInformation;
1075
+ resultInformation?: ResultInformation;
1087
1076
  }
1088
- export interface RestSendDtmfTonesFailed {
1077
+ export interface SendDtmfTonesFailed {
1089
1078
  /** Call connection ID. */
1090
1079
  callConnectionId?: string;
1091
1080
  /** Server call ID. */
@@ -1095,10 +1084,14 @@ export interface RestSendDtmfTonesFailed {
1095
1084
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1096
1085
  operationContext?: string;
1097
1086
  /** Contains the resulting SIP code, sub-code and message. */
1098
- resultInformation?: RestResultInformation;
1087
+ resultInformation?: ResultInformation;
1099
1088
  }
1100
- /** Successful cancel add participant event. */
1101
- export interface RestCancelAddParticipantSucceeded {
1089
+ export interface MediaStreamingFailed {
1090
+ /**
1091
+ * Defines the result for MediaStreamingUpdate with the current status and the details about the status
1092
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1093
+ */
1094
+ readonly mediaStreamingUpdate?: MediaStreamingUpdate;
1102
1095
  /** Call connection ID. */
1103
1096
  callConnectionId?: string;
1104
1097
  /** Server call ID. */
@@ -1107,13 +1100,20 @@ export interface RestCancelAddParticipantSucceeded {
1107
1100
  correlationId?: string;
1108
1101
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1109
1102
  operationContext?: string;
1110
- /** Invitation ID used to cancel the request. */
1111
- invitationId?: string;
1112
1103
  /** Contains the resulting SIP code, sub-code and message. */
1113
- resultInformation?: RestResultInformation;
1104
+ resultInformation?: ResultInformation;
1114
1105
  }
1115
- /** Failed cancel add participant event. */
1116
- export interface RestCancelAddParticipantFailed {
1106
+ export interface MediaStreamingUpdate {
1107
+ contentType?: string;
1108
+ mediaStreamingStatus?: MediaStreamingStatus;
1109
+ mediaStreamingStatusDetails?: MediaStreamingStatusDetails;
1110
+ }
1111
+ export interface MediaStreamingStarted {
1112
+ /**
1113
+ * Defines the result for MediaStreamingUpdate with the current status and the details about the status
1114
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1115
+ */
1116
+ readonly mediaStreamingUpdate?: MediaStreamingUpdate;
1117
1117
  /** Call connection ID. */
1118
1118
  callConnectionId?: string;
1119
1119
  /** Server call ID. */
@@ -1123,16 +1123,14 @@ export interface RestCancelAddParticipantFailed {
1123
1123
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1124
1124
  operationContext?: string;
1125
1125
  /** Contains the resulting SIP code, sub-code and message. */
1126
- resultInformation?: RestResultInformation;
1127
- /** Invitation ID used to cancel the request. */
1128
- invitationId?: string;
1126
+ resultInformation?: ResultInformation;
1129
1127
  }
1130
- export interface RestTranscriptionStarted {
1128
+ export interface MediaStreamingStopped {
1131
1129
  /**
1132
- * Defines the result for TranscriptionUpdate with the current status and the details about the status
1130
+ * Defines the result for MediaStreamingUpdate with the current status and the details about the status
1133
1131
  * NOTE: This property will not be serialized. It can only be populated by the server.
1134
1132
  */
1135
- readonly transcriptionUpdate?: TranscriptionUpdate;
1133
+ readonly mediaStreamingUpdate?: MediaStreamingUpdate;
1136
1134
  /** Call connection ID. */
1137
1135
  callConnectionId?: string;
1138
1136
  /** Server call ID. */
@@ -1142,14 +1140,9 @@ export interface RestTranscriptionStarted {
1142
1140
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1143
1141
  operationContext?: string;
1144
1142
  /** Contains the resulting SIP code, sub-code and message. */
1145
- resultInformation?: RestResultInformation;
1143
+ resultInformation?: ResultInformation;
1146
1144
  }
1147
- export interface RestTranscriptionStopped {
1148
- /**
1149
- * Defines the result for TranscriptionUpdate with the current status and the details about the status
1150
- * NOTE: This property will not be serialized. It can only be populated by the server.
1151
- */
1152
- readonly transcriptionUpdate?: TranscriptionUpdate;
1145
+ export interface HoldFailed {
1153
1146
  /** Call connection ID. */
1154
1147
  callConnectionId?: string;
1155
1148
  /** Server call ID. */
@@ -1159,14 +1152,14 @@ export interface RestTranscriptionStopped {
1159
1152
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1160
1153
  operationContext?: string;
1161
1154
  /** Contains the resulting SIP code, sub-code and message. */
1162
- resultInformation?: RestResultInformation;
1155
+ resultInformation?: ResultInformation;
1163
1156
  }
1164
- export interface RestTranscriptionUpdated {
1157
+ export interface StartRecordingFailed {
1165
1158
  /**
1166
- * Defines the result for TranscriptionUpdate with the current status and the details about the status
1159
+ * The call recording Id.
1167
1160
  * NOTE: This property will not be serialized. It can only be populated by the server.
1168
1161
  */
1169
- readonly transcriptionUpdate?: TranscriptionUpdate;
1162
+ readonly recordingId?: string;
1170
1163
  /** Call connection ID. */
1171
1164
  callConnectionId?: string;
1172
1165
  /** Server call ID. */
@@ -1176,9 +1169,9 @@ export interface RestTranscriptionUpdated {
1176
1169
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1177
1170
  operationContext?: string;
1178
1171
  /** Contains the resulting SIP code, sub-code and message. */
1179
- resultInformation?: RestResultInformation;
1172
+ resultInformation?: ResultInformation;
1180
1173
  }
1181
- export interface RestTranscriptionFailed {
1174
+ export interface TranscriptionFailed {
1182
1175
  /**
1183
1176
  * Defines the result for TranscriptionUpdate with the current status and the details about the status
1184
1177
  * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -1193,10 +1186,18 @@ export interface RestTranscriptionFailed {
1193
1186
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1194
1187
  operationContext?: string;
1195
1188
  /** Contains the resulting SIP code, sub-code and message. */
1196
- resultInformation?: RestResultInformation;
1189
+ resultInformation?: ResultInformation;
1197
1190
  }
1198
- /** The create call failed event. */
1199
- export interface RestCreateCallFailed {
1191
+ export interface TranscriptionUpdate {
1192
+ transcriptionStatus?: TranscriptionStatus;
1193
+ transcriptionStatusDetails?: TranscriptionStatusDetails;
1194
+ }
1195
+ export interface TranscriptionStarted {
1196
+ /**
1197
+ * Defines the result for TranscriptionUpdate with the current status and the details about the status
1198
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1199
+ */
1200
+ readonly transcriptionUpdate?: TranscriptionUpdate;
1200
1201
  /** Call connection ID. */
1201
1202
  callConnectionId?: string;
1202
1203
  /** Server call ID. */
@@ -1206,10 +1207,14 @@ export interface RestCreateCallFailed {
1206
1207
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1207
1208
  operationContext?: string;
1208
1209
  /** Contains the resulting SIP code, sub-code and message. */
1209
- resultInformation?: RestResultInformation;
1210
+ resultInformation?: ResultInformation;
1210
1211
  }
1211
- /** The failed to answer call event. */
1212
- export interface RestAnswerFailed {
1212
+ export interface TranscriptionStopped {
1213
+ /**
1214
+ * Defines the result for TranscriptionUpdate with the current status and the details about the status
1215
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1216
+ */
1217
+ readonly transcriptionUpdate?: TranscriptionUpdate;
1213
1218
  /** Call connection ID. */
1214
1219
  callConnectionId?: string;
1215
1220
  /** Server call ID. */
@@ -1219,9 +1224,14 @@ export interface RestAnswerFailed {
1219
1224
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1220
1225
  operationContext?: string;
1221
1226
  /** Contains the resulting SIP code, sub-code and message. */
1222
- resultInformation?: RestResultInformation;
1227
+ resultInformation?: ResultInformation;
1223
1228
  }
1224
- export interface RestHoldFailed {
1229
+ export interface TranscriptionUpdated {
1230
+ /**
1231
+ * Defines the result for TranscriptionUpdate with the current status and the details about the status
1232
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1233
+ */
1234
+ readonly transcriptionUpdate?: TranscriptionUpdate;
1225
1235
  /** Call connection ID. */
1226
1236
  callConnectionId?: string;
1227
1237
  /** Server call ID. */
@@ -1231,50 +1241,36 @@ export interface RestHoldFailed {
1231
1241
  /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1232
1242
  operationContext?: string;
1233
1243
  /** Contains the resulting SIP code, sub-code and message. */
1234
- resultInformation?: RestResultInformation;
1235
- }
1236
- /** The incoming call event. */
1237
- export interface RestIncomingCall {
1238
- /**
1239
- * The communication identifier of the target user.
1240
- * NOTE: This property will not be serialized. It can only be populated by the server.
1241
- */
1242
- readonly to?: CommunicationIdentifierModel;
1243
- /**
1244
- * The communication identifier of the user who initiated the call.
1245
- * NOTE: This property will not be serialized. It can only be populated by the server.
1246
- */
1247
- readonly from?: CommunicationIdentifierModel;
1248
- /**
1249
- * Display name of caller.
1250
- * NOTE: This property will not be serialized. It can only be populated by the server.
1251
- */
1252
- readonly callerDisplayName?: string;
1253
- /**
1254
- * The server call id.
1255
- * NOTE: This property will not be serialized. It can only be populated by the server.
1256
- */
1257
- readonly serverCallId?: string;
1258
- /**
1259
- * Custom Context of Incoming Call
1260
- * NOTE: This property will not be serialized. It can only be populated by the server.
1261
- */
1262
- readonly customContext?: CustomCallingContextInternal;
1263
- /**
1264
- * Incoming call context.
1265
- * NOTE: This property will not be serialized. It can only be populated by the server.
1266
- */
1267
- readonly incomingCallContext?: string;
1268
- /**
1269
- * The communication identifier of the user on behalf of whom the call is made.
1270
- * NOTE: This property will not be serialized. It can only be populated by the server.
1271
- */
1272
- readonly onBehalfOfCallee?: CommunicationIdentifierModel;
1273
- /**
1274
- * Correlation ID for event to call correlation. Also called ChainId for skype chain ID.
1275
- * NOTE: This property will not be serialized. It can only be populated by the server.
1276
- */
1277
- readonly correlationId?: string;
1244
+ resultInformation?: ResultInformation;
1245
+ }
1246
+ /** Represents the options for WebSocket transport. */
1247
+ export interface WebSocketMediaStreamingOptions extends MediaStreamingOptionsInternal {
1248
+ /** Polymorphic discriminator, which specifies the different types this object can be */
1249
+ transportType: "websocket";
1250
+ /** The transport URL for media streaming. */
1251
+ transportUrl?: string;
1252
+ contentType?: MediaStreamingContentType;
1253
+ /** A value indicating whether the media streaming should start immediately after the call is answered. */
1254
+ startMediaStreaming?: boolean;
1255
+ /** A value indicating whether bidirectional streaming is enabled. */
1256
+ enableBidirectional?: boolean;
1257
+ /** The audio format used for encoding, including sample rate and channel type. The default is Pcm16KMono. */
1258
+ audioFormat?: AudioFormat;
1259
+ /** A value that indicates whether to stream the DTMF tones. */
1260
+ enableDtmfTones?: boolean;
1261
+ }
1262
+ /** Represents the options for WebSocket transport. */
1263
+ export interface WebSocketTranscriptionOptions extends TranscriptionOptionsInternal {
1264
+ /** Polymorphic discriminator, which specifies the different types this object can be */
1265
+ transportType: "websocket";
1266
+ /** The URL used for live transcription transport. */
1267
+ transportUrl?: string;
1268
+ /** The ID of the deployed custom model in GUID format. The GUID is generated by Azure Speech Studio, e.g., a259c255-1cdw-4ed7-a693-dd58563b6f6a. */
1269
+ speechModelEndpointId?: string;
1270
+ /** Indicates whether the transcription should start immediately after the call is answered. */
1271
+ startTranscription?: boolean;
1272
+ /** Enables intermediate results for the transcribed speech. */
1273
+ enableIntermediateResults?: boolean;
1278
1274
  }
1279
1275
  /** Known values of {@link CommunicationIdentifierModelKind} that the service accepts. */
1280
1276
  export declare enum KnownCommunicationIdentifierModelKind {
@@ -1323,32 +1319,19 @@ export declare enum KnownCommunicationCloudEnvironmentModel {
1323
1319
  * **gcch**
1324
1320
  */
1325
1321
  export type CommunicationCloudEnvironmentModel = string;
1326
- /** Known values of {@link MediaStreamingTransportType} that the service accepts. */
1327
- export declare enum KnownMediaStreamingTransportType {
1322
+ /** Known values of {@link StreamingTransportType} that the service accepts. */
1323
+ export declare enum KnownStreamingTransportType {
1328
1324
  /** Websocket */
1329
1325
  Websocket = "websocket"
1330
1326
  }
1331
1327
  /**
1332
- * Defines values for MediaStreamingTransportType. \
1333
- * {@link KnownMediaStreamingTransportType} can be used interchangeably with MediaStreamingTransportType,
1328
+ * Defines values for StreamingTransportType. \
1329
+ * {@link KnownStreamingTransportType} can be used interchangeably with StreamingTransportType,
1334
1330
  * this enum contains the known values that the service supports.
1335
1331
  * ### Known values supported by the service
1336
1332
  * **websocket**
1337
1333
  */
1338
- export type MediaStreamingTransportType = string;
1339
- /** Known values of {@link MediaStreamingContentType} that the service accepts. */
1340
- export declare enum KnownMediaStreamingContentType {
1341
- /** Audio */
1342
- Audio = "audio"
1343
- }
1344
- /**
1345
- * Defines values for MediaStreamingContentType. \
1346
- * {@link KnownMediaStreamingContentType} can be used interchangeably with MediaStreamingContentType,
1347
- * this enum contains the known values that the service supports.
1348
- * ### Known values supported by the service
1349
- * **audio**
1350
- */
1351
- export type MediaStreamingContentType = string;
1334
+ export type StreamingTransportType = string;
1352
1335
  /** Known values of {@link MediaStreamingAudioChannelType} that the service accepts. */
1353
1336
  export declare enum KnownMediaStreamingAudioChannelType {
1354
1337
  /** Mixed */
@@ -1365,35 +1348,6 @@ export declare enum KnownMediaStreamingAudioChannelType {
1365
1348
  * **unmixed**
1366
1349
  */
1367
1350
  export type MediaStreamingAudioChannelType = string;
1368
- /** Known values of {@link AudioFormat} that the service accepts. */
1369
- export declare enum KnownAudioFormat {
1370
- /** Pcm16KMono */
1371
- Pcm16KMono = "Pcm16KMono",
1372
- /** Pcm24KMono */
1373
- Pcm24KMono = "Pcm24KMono"
1374
- }
1375
- /**
1376
- * Defines values for AudioFormat. \
1377
- * {@link KnownAudioFormat} can be used interchangeably with AudioFormat,
1378
- * this enum contains the known values that the service supports.
1379
- * ### Known values supported by the service
1380
- * **Pcm16KMono**: Pcm16KMono \
1381
- * **Pcm24KMono**: Pcm24KMono
1382
- */
1383
- export type AudioFormat = string;
1384
- /** Known values of {@link TranscriptionTransportType} that the service accepts. */
1385
- export declare enum KnownTranscriptionTransportType {
1386
- /** Websocket */
1387
- Websocket = "websocket"
1388
- }
1389
- /**
1390
- * Defines values for TranscriptionTransportType. \
1391
- * {@link KnownTranscriptionTransportType} can be used interchangeably with TranscriptionTransportType,
1392
- * this enum contains the known values that the service supports.
1393
- * ### Known values supported by the service
1394
- * **websocket**
1395
- */
1396
- export type TranscriptionTransportType = string;
1397
1351
  /** Known values of {@link CallConnectionStateModel} that the service accepts. */
1398
1352
  export declare enum KnownCallConnectionStateModel {
1399
1353
  /** Unknown */
@@ -1444,6 +1398,19 @@ export declare enum KnownMediaStreamingSubscriptionState {
1444
1398
  * **active**
1445
1399
  */
1446
1400
  export type MediaStreamingSubscriptionState = string;
1401
+ /** Known values of {@link MediaStreamingContentType} that the service accepts. */
1402
+ export declare enum KnownMediaStreamingContentType {
1403
+ /** Audio */
1404
+ Audio = "audio"
1405
+ }
1406
+ /**
1407
+ * Defines values for MediaStreamingContentType. \
1408
+ * {@link KnownMediaStreamingContentType} can be used interchangeably with MediaStreamingContentType,
1409
+ * this enum contains the known values that the service supports.
1410
+ * ### Known values supported by the service
1411
+ * **audio**
1412
+ */
1413
+ export type MediaStreamingContentType = string;
1447
1414
  /** Known values of {@link TranscriptionSubscriptionState} that the service accepts. */
1448
1415
  export declare enum KnownTranscriptionSubscriptionState {
1449
1416
  /** Disabled */
@@ -1734,6 +1701,41 @@ export declare enum KnownRecordingKind {
1734
1701
  * **TeamsCompliance**: Recording initiated by Teams compliance policy
1735
1702
  */
1736
1703
  export type RecordingKind = string;
1704
+ /** Known values of {@link AudioFormat} that the service accepts. */
1705
+ export declare enum KnownAudioFormat {
1706
+ /** Pcm16KMono */
1707
+ Pcm16KMono = "pcm16KMono",
1708
+ /** Pcm24KMono */
1709
+ Pcm24KMono = "pcm24KMono"
1710
+ }
1711
+ /**
1712
+ * Defines values for AudioFormat. \
1713
+ * {@link KnownAudioFormat} can be used interchangeably with AudioFormat,
1714
+ * this enum contains the known values that the service supports.
1715
+ * ### Known values supported by the service
1716
+ * **pcm16KMono** \
1717
+ * **pcm24KMono**
1718
+ */
1719
+ export type AudioFormat = string;
1720
+ /** Known values of {@link RecognitionType} that the service accepts. */
1721
+ export declare enum KnownRecognitionType {
1722
+ /** Dtmf */
1723
+ Dtmf = "dtmf",
1724
+ /** Speech */
1725
+ Speech = "speech",
1726
+ /** Choices */
1727
+ Choices = "choices"
1728
+ }
1729
+ /**
1730
+ * Defines values for RecognitionType. \
1731
+ * {@link KnownRecognitionType} can be used interchangeably with RecognitionType,
1732
+ * this enum contains the known values that the service supports.
1733
+ * ### Known values supported by the service
1734
+ * **dtmf** \
1735
+ * **speech** \
1736
+ * **choices**
1737
+ */
1738
+ export type RecognitionType = string;
1737
1739
  /** Known values of {@link MediaStreamingStatus} that the service accepts. */
1738
1740
  export declare enum KnownMediaStreamingStatus {
1739
1741
  /** MediaStreamingStarted */
@@ -1894,25 +1896,6 @@ export declare enum KnownTranscriptionStatusDetails {
1894
1896
  * **transcriptionLocaleUpdated**
1895
1897
  */
1896
1898
  export type TranscriptionStatusDetails = string;
1897
- /** Known values of {@link RecognitionType} that the service accepts. */
1898
- export declare enum KnownRecognitionType {
1899
- /** Dtmf */
1900
- Dtmf = "dtmf",
1901
- /** Speech */
1902
- Speech = "speech",
1903
- /** Choices */
1904
- Choices = "choices"
1905
- }
1906
- /**
1907
- * Defines values for RecognitionType. \
1908
- * {@link KnownRecognitionType} can be used interchangeably with RecognitionType,
1909
- * this enum contains the known values that the service supports.
1910
- * ### Known values supported by the service
1911
- * **dtmf** \
1912
- * **speech** \
1913
- * **choices**
1914
- */
1915
- export type RecognitionType = string;
1916
1899
  /** Optional parameters. */
1917
1900
  export interface CreateCallOptionalParams extends coreClient.OperationOptions {
1918
1901
  /** 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. */