@azure/communication-call-automation 1.3.0 → 1.3.1

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 (562) hide show
  1. package/README.md +66 -57
  2. package/dist/browser/callAutomationClient.d.ts +98 -0
  3. package/dist/browser/callAutomationClient.d.ts.map +1 -0
  4. package/{dist-esm/src → dist/browser}/callAutomationClient.js +5 -5
  5. package/dist/browser/callAutomationClient.js.map +1 -0
  6. package/dist/browser/callAutomationEventParser.d.ts +6 -0
  7. package/dist/browser/callAutomationEventParser.d.ts.map +1 -0
  8. package/{dist-esm/src → dist/browser}/callAutomationEventParser.js +2 -2
  9. package/dist/browser/callAutomationEventParser.js.map +1 -0
  10. package/dist/browser/callConnection.d.ts +76 -0
  11. package/dist/browser/callConnection.d.ts.map +1 -0
  12. package/{dist-esm/src → dist/browser}/callConnection.js +4 -4
  13. package/dist/browser/callConnection.js.map +1 -0
  14. package/dist/browser/callMedia.d.ts +84 -0
  15. package/dist/browser/callMedia.d.ts.map +1 -0
  16. package/{dist-esm/src → dist/browser}/callMedia.js +2 -2
  17. package/dist/browser/callMedia.js.map +1 -0
  18. package/dist/browser/callRecording.d.ts +70 -0
  19. package/dist/browser/callRecording.d.ts.map +1 -0
  20. package/{dist-esm/src → dist/browser}/callRecording.js +5 -5
  21. package/dist/browser/callRecording.js.map +1 -0
  22. package/dist/browser/contentDownloader.d.ts +25 -0
  23. package/dist/browser/contentDownloader.d.ts.map +1 -0
  24. package/dist/browser/contentDownloader.js.map +1 -0
  25. package/dist/browser/credential/callAutomationAccessKeyCredentialPolicy.d.ts +10 -0
  26. package/dist/browser/credential/callAutomationAccessKeyCredentialPolicy.d.ts.map +1 -0
  27. package/{dist-esm/src → dist/browser}/credential/callAutomationAccessKeyCredentialPolicy.js +1 -1
  28. package/dist/browser/credential/callAutomationAccessKeyCredentialPolicy.js.map +1 -0
  29. package/dist/browser/credential/callAutomationAuthPolicy.d.ts +22 -0
  30. package/dist/browser/credential/callAutomationAuthPolicy.d.ts.map +1 -0
  31. package/{dist-esm/src → dist/browser}/credential/callAutomationAuthPolicy.js +2 -2
  32. package/dist/browser/credential/callAutomationAuthPolicy.js.map +1 -0
  33. package/dist/browser/credential/cryptoUtils-browser.d.mts.map +1 -0
  34. package/dist/browser/credential/cryptoUtils-browser.mjs.map +1 -0
  35. package/dist/browser/credential/cryptoUtils.d.ts +3 -0
  36. package/{dist-esm/src/credential/cryptoUtils.browser.js → dist/browser/credential/cryptoUtils.js} +2 -2
  37. package/dist/browser/credential/encodeUtils.browser.d.ts +4 -0
  38. package/dist/browser/credential/encodeUtils.browser.d.ts.map +1 -0
  39. package/dist/browser/generated/src/callAutomationApiClient.d.ts +49 -0
  40. package/dist/browser/generated/src/callAutomationApiClient.d.ts.map +1 -0
  41. package/{dist-esm/src → dist/browser}/generated/src/callAutomationApiClient.js +3 -3
  42. package/dist/browser/generated/src/callAutomationApiClient.js.map +1 -0
  43. package/dist/browser/generated/src/index.d.ts +5 -0
  44. package/dist/browser/generated/src/index.d.ts.map +1 -0
  45. package/{dist-esm/src → dist/browser}/generated/src/index.js +4 -4
  46. package/dist/browser/generated/src/index.js.map +1 -0
  47. package/dist/browser/generated/src/models/index.d.ts +1494 -0
  48. package/dist/browser/generated/src/models/index.d.ts.map +1 -0
  49. package/dist/browser/generated/src/models/mappers.d.ts +82 -0
  50. package/dist/browser/generated/src/models/mappers.d.ts.map +1 -0
  51. package/dist/browser/generated/src/models/parameters.d.ts +29 -0
  52. package/dist/browser/generated/src/models/parameters.d.ts.map +1 -0
  53. package/{dist-esm/src → dist/browser}/generated/src/models/parameters.js +1 -1
  54. package/{dist-esm/src → dist/browser}/generated/src/models/parameters.js.map +1 -1
  55. package/dist/browser/generated/src/operations/callConnection.d.ts +96 -0
  56. package/dist/browser/generated/src/operations/callConnection.d.ts.map +1 -0
  57. package/{dist-esm/src → dist/browser}/generated/src/operations/callConnection.js +3 -3
  58. package/dist/browser/generated/src/operations/callConnection.js.map +1 -0
  59. package/dist/browser/generated/src/operations/callMedia.d.ts +68 -0
  60. package/dist/browser/generated/src/operations/callMedia.d.ts.map +1 -0
  61. package/{dist-esm/src → dist/browser}/generated/src/operations/callMedia.js +2 -2
  62. package/dist/browser/generated/src/operations/callMedia.js.map +1 -0
  63. package/dist/browser/generated/src/operations/callRecording.d.ts +43 -0
  64. package/dist/browser/generated/src/operations/callRecording.d.ts.map +1 -0
  65. package/{dist-esm/src → dist/browser}/generated/src/operations/callRecording.js +2 -2
  66. package/dist/browser/generated/src/operations/callRecording.js.map +1 -0
  67. package/dist/browser/generated/src/operations/index.d.ts +4 -0
  68. package/dist/browser/generated/src/operations/index.d.ts.map +1 -0
  69. package/{dist-esm/src/generated/src/operationsInterfaces → dist/browser/generated/src/operations}/index.js +3 -3
  70. package/dist/browser/generated/src/operations/index.js.map +1 -0
  71. package/dist/browser/generated/src/operationsInterfaces/callConnection.d.ts +73 -0
  72. package/dist/browser/generated/src/operationsInterfaces/callConnection.d.ts.map +1 -0
  73. package/dist/browser/generated/src/operationsInterfaces/callConnection.js.map +1 -0
  74. package/dist/browser/generated/src/operationsInterfaces/callMedia.d.ts +60 -0
  75. package/dist/browser/generated/src/operationsInterfaces/callMedia.d.ts.map +1 -0
  76. package/dist/browser/generated/src/operationsInterfaces/callMedia.js.map +1 -0
  77. package/dist/browser/generated/src/operationsInterfaces/callRecording.d.ts +35 -0
  78. package/dist/browser/generated/src/operationsInterfaces/callRecording.d.ts.map +1 -0
  79. package/dist/browser/generated/src/operationsInterfaces/callRecording.js.map +1 -0
  80. package/dist/browser/generated/src/operationsInterfaces/index.d.ts +4 -0
  81. package/dist/browser/generated/src/operationsInterfaces/index.d.ts.map +1 -0
  82. package/dist/browser/generated/src/operationsInterfaces/index.js +11 -0
  83. package/dist/browser/generated/src/operationsInterfaces/index.js.map +1 -0
  84. package/dist/browser/generated/src/pagingHelper.d.ts +13 -0
  85. package/dist/browser/generated/src/pagingHelper.d.ts.map +1 -0
  86. package/dist/browser/index.d.ts +10 -0
  87. package/dist/browser/index.d.ts.map +1 -0
  88. package/dist/browser/index.js +12 -0
  89. package/dist/browser/index.js.map +1 -0
  90. package/dist/browser/models/constants.d.ts +2 -0
  91. package/dist/browser/models/constants.d.ts.map +1 -0
  92. package/dist/browser/models/events.d.ts +395 -0
  93. package/dist/browser/models/events.d.ts.map +1 -0
  94. package/dist/browser/models/events.js.map +1 -0
  95. package/dist/browser/models/logger.d.ts +5 -0
  96. package/dist/browser/models/logger.d.ts.map +1 -0
  97. package/dist/browser/models/mapper.d.ts +3 -0
  98. package/dist/browser/models/mapper.d.ts.map +1 -0
  99. package/dist/browser/models/models.d.ts +188 -0
  100. package/dist/browser/models/models.d.ts.map +1 -0
  101. package/{dist-esm/src → dist/browser}/models/models.js +1 -1
  102. package/dist/browser/models/models.js.map +1 -0
  103. package/dist/browser/models/options.d.ts +315 -0
  104. package/dist/browser/models/options.d.ts.map +1 -0
  105. package/dist/browser/models/options.js.map +1 -0
  106. package/dist/browser/models/responses.d.ts +73 -0
  107. package/dist/browser/models/responses.d.ts.map +1 -0
  108. package/dist/browser/models/responses.js.map +1 -0
  109. package/dist/browser/package.json +3 -0
  110. package/dist/browser/utli/converters.d.ts +22 -0
  111. package/dist/browser/utli/converters.d.ts.map +1 -0
  112. package/{dist-esm/src → dist/browser}/utli/converters.js +15 -1
  113. package/dist/browser/utli/converters.js.map +1 -0
  114. package/dist/commonjs/callAutomationClient.d.ts +98 -0
  115. package/dist/commonjs/callAutomationClient.d.ts.map +1 -0
  116. package/dist/commonjs/callAutomationClient.js +218 -0
  117. package/{dist-esm/src → dist/commonjs}/callAutomationClient.js.map +1 -1
  118. package/dist/commonjs/callAutomationEventParser.d.ts +6 -0
  119. package/dist/commonjs/callAutomationEventParser.d.ts.map +1 -0
  120. package/dist/commonjs/callAutomationEventParser.js +151 -0
  121. package/dist/commonjs/callAutomationEventParser.js.map +1 -0
  122. package/dist/commonjs/callConnection.d.ts +76 -0
  123. package/dist/commonjs/callConnection.d.ts.map +1 -0
  124. package/dist/commonjs/callConnection.js +215 -0
  125. package/dist/commonjs/callConnection.js.map +1 -0
  126. package/dist/commonjs/callMedia.d.ts +84 -0
  127. package/dist/commonjs/callMedia.d.ts.map +1 -0
  128. package/dist/commonjs/callMedia.js +326 -0
  129. package/{dist-esm/src → dist/commonjs}/callMedia.js.map +1 -1
  130. package/dist/commonjs/callRecording.d.ts +70 -0
  131. package/dist/commonjs/callRecording.d.ts.map +1 -0
  132. package/dist/commonjs/callRecording.js +184 -0
  133. package/dist/commonjs/callRecording.js.map +1 -0
  134. package/dist/commonjs/contentDownloader.d.ts +25 -0
  135. package/dist/commonjs/contentDownloader.d.ts.map +1 -0
  136. package/dist/commonjs/contentDownloader.js +108 -0
  137. package/dist/commonjs/contentDownloader.js.map +1 -0
  138. package/dist/commonjs/credential/callAutomationAccessKeyCredentialPolicy.d.ts +10 -0
  139. package/dist/commonjs/credential/callAutomationAccessKeyCredentialPolicy.d.ts.map +1 -0
  140. package/dist/commonjs/credential/callAutomationAccessKeyCredentialPolicy.js +42 -0
  141. package/dist/commonjs/credential/callAutomationAccessKeyCredentialPolicy.js.map +1 -0
  142. package/dist/commonjs/credential/callAutomationAuthPolicy.d.ts +22 -0
  143. package/dist/commonjs/credential/callAutomationAuthPolicy.d.ts.map +1 -0
  144. package/dist/commonjs/credential/callAutomationAuthPolicy.js +57 -0
  145. package/dist/commonjs/credential/callAutomationAuthPolicy.js.map +1 -0
  146. package/dist/commonjs/credential/cryptoUtils.d.ts +3 -0
  147. package/dist/commonjs/credential/cryptoUtils.d.ts.map +1 -0
  148. package/dist/commonjs/credential/cryptoUtils.js +14 -0
  149. package/dist/commonjs/credential/cryptoUtils.js.map +1 -0
  150. package/dist/commonjs/credential/encodeUtils.browser.d.ts +4 -0
  151. package/dist/commonjs/credential/encodeUtils.browser.d.ts.map +1 -0
  152. package/dist/commonjs/credential/encodeUtils.browser.js +32 -0
  153. package/dist/commonjs/credential/encodeUtils.browser.js.map +1 -0
  154. package/dist/commonjs/generated/src/callAutomationApiClient.d.ts +49 -0
  155. package/dist/commonjs/generated/src/callAutomationApiClient.d.ts.map +1 -0
  156. package/dist/commonjs/generated/src/callAutomationApiClient.js +231 -0
  157. package/dist/commonjs/generated/src/callAutomationApiClient.js.map +1 -0
  158. package/dist/commonjs/generated/src/index.d.ts +5 -0
  159. package/dist/commonjs/generated/src/index.d.ts.map +1 -0
  160. package/dist/commonjs/generated/src/index.js +19 -0
  161. package/dist/commonjs/generated/src/index.js.map +1 -0
  162. package/dist/commonjs/generated/src/models/index.d.ts +1494 -0
  163. package/dist/commonjs/generated/src/models/index.d.ts.map +1 -0
  164. package/dist/commonjs/generated/src/models/index.js +203 -0
  165. package/dist/commonjs/generated/src/models/index.js.map +1 -0
  166. package/dist/commonjs/generated/src/models/mappers.d.ts +82 -0
  167. package/dist/commonjs/generated/src/models/mappers.d.ts.map +1 -0
  168. package/dist/commonjs/generated/src/models/mappers.js +2857 -0
  169. package/dist/commonjs/generated/src/models/mappers.js.map +1 -0
  170. package/dist/commonjs/generated/src/models/parameters.d.ts +29 -0
  171. package/dist/commonjs/generated/src/models/parameters.d.ts.map +1 -0
  172. package/dist/commonjs/generated/src/models/parameters.js +183 -0
  173. package/dist/commonjs/generated/src/models/parameters.js.map +1 -0
  174. package/dist/commonjs/generated/src/operations/callConnection.d.ts +96 -0
  175. package/dist/commonjs/generated/src/operations/callConnection.d.ts.map +1 -0
  176. package/dist/commonjs/generated/src/operations/callConnection.js +406 -0
  177. package/dist/commonjs/generated/src/operations/callConnection.js.map +1 -0
  178. package/dist/commonjs/generated/src/operations/callMedia.d.ts +68 -0
  179. package/dist/commonjs/generated/src/operations/callMedia.d.ts.map +1 -0
  180. package/dist/commonjs/generated/src/operations/callMedia.js +232 -0
  181. package/dist/commonjs/generated/src/operations/callMedia.js.map +1 -0
  182. package/dist/commonjs/generated/src/operations/callRecording.d.ts +43 -0
  183. package/dist/commonjs/generated/src/operations/callRecording.d.ts.map +1 -0
  184. package/dist/commonjs/generated/src/operations/callRecording.js +149 -0
  185. package/dist/commonjs/generated/src/operations/callRecording.js.map +1 -0
  186. package/dist/commonjs/generated/src/operations/index.d.ts +4 -0
  187. package/dist/commonjs/generated/src/operations/index.d.ts.map +1 -0
  188. package/dist/commonjs/generated/src/operations/index.js +14 -0
  189. package/dist/commonjs/generated/src/operations/index.js.map +1 -0
  190. package/dist/commonjs/generated/src/operationsInterfaces/callConnection.d.ts +73 -0
  191. package/dist/commonjs/generated/src/operationsInterfaces/callConnection.d.ts.map +1 -0
  192. package/{dist-esm/src/generated/src/operations/index.js → dist/commonjs/generated/src/operationsInterfaces/callConnection.js} +3 -4
  193. package/dist/commonjs/generated/src/operationsInterfaces/callConnection.js.map +1 -0
  194. package/dist/commonjs/generated/src/operationsInterfaces/callMedia.d.ts +60 -0
  195. package/dist/commonjs/generated/src/operationsInterfaces/callMedia.d.ts.map +1 -0
  196. package/dist/commonjs/generated/src/operationsInterfaces/callMedia.js +10 -0
  197. package/dist/commonjs/generated/src/operationsInterfaces/callMedia.js.map +1 -0
  198. package/dist/commonjs/generated/src/operationsInterfaces/callRecording.d.ts +35 -0
  199. package/dist/commonjs/generated/src/operationsInterfaces/callRecording.d.ts.map +1 -0
  200. package/dist/commonjs/generated/src/operationsInterfaces/callRecording.js +10 -0
  201. package/dist/commonjs/generated/src/operationsInterfaces/callRecording.js.map +1 -0
  202. package/dist/commonjs/generated/src/operationsInterfaces/index.d.ts +4 -0
  203. package/dist/commonjs/generated/src/operationsInterfaces/index.d.ts.map +1 -0
  204. package/dist/commonjs/generated/src/operationsInterfaces/index.js +14 -0
  205. package/dist/commonjs/generated/src/operationsInterfaces/index.js.map +1 -0
  206. package/dist/commonjs/generated/src/pagingHelper.d.ts +13 -0
  207. package/dist/commonjs/generated/src/pagingHelper.d.ts.map +1 -0
  208. package/dist/commonjs/generated/src/pagingHelper.js +36 -0
  209. package/dist/commonjs/generated/src/pagingHelper.js.map +1 -0
  210. package/dist/commonjs/index.d.ts +10 -0
  211. package/dist/commonjs/index.d.ts.map +1 -0
  212. package/dist/commonjs/index.js +15 -0
  213. package/dist/commonjs/index.js.map +1 -0
  214. package/dist/commonjs/models/constants.d.ts +2 -0
  215. package/dist/commonjs/models/constants.d.ts.map +1 -0
  216. package/dist/commonjs/models/constants.js +7 -0
  217. package/dist/commonjs/models/constants.js.map +1 -0
  218. package/dist/commonjs/models/events.d.ts +395 -0
  219. package/dist/commonjs/models/events.d.ts.map +1 -0
  220. package/dist/commonjs/models/events.js +5 -0
  221. package/dist/commonjs/models/events.js.map +1 -0
  222. package/dist/commonjs/models/logger.d.ts +5 -0
  223. package/dist/commonjs/models/logger.d.ts.map +1 -0
  224. package/dist/commonjs/models/logger.js +11 -0
  225. package/dist/commonjs/models/logger.js.map +1 -0
  226. package/dist/commonjs/models/mapper.d.ts +3 -0
  227. package/dist/commonjs/models/mapper.d.ts.map +1 -0
  228. package/dist/commonjs/models/mapper.js +79 -0
  229. package/dist/commonjs/models/mapper.js.map +1 -0
  230. package/dist/commonjs/models/models.d.ts +188 -0
  231. package/dist/commonjs/models/models.d.ts.map +1 -0
  232. package/dist/commonjs/models/models.js +58 -0
  233. package/dist/commonjs/models/models.js.map +1 -0
  234. package/dist/commonjs/models/options.d.ts +315 -0
  235. package/dist/commonjs/models/options.d.ts.map +1 -0
  236. package/dist/commonjs/models/options.js +5 -0
  237. package/dist/commonjs/models/options.js.map +1 -0
  238. package/dist/commonjs/models/responses.d.ts +73 -0
  239. package/dist/commonjs/models/responses.d.ts.map +1 -0
  240. package/dist/commonjs/models/responses.js +5 -0
  241. package/dist/commonjs/models/responses.js.map +1 -0
  242. package/dist/commonjs/package.json +3 -0
  243. package/dist/commonjs/tsdoc-metadata.json +11 -0
  244. package/dist/commonjs/utli/converters.d.ts +22 -0
  245. package/dist/commonjs/utli/converters.d.ts.map +1 -0
  246. package/dist/commonjs/utli/converters.js +153 -0
  247. package/dist/commonjs/utli/converters.js.map +1 -0
  248. package/dist/esm/callAutomationClient.d.ts +98 -0
  249. package/dist/esm/callAutomationClient.d.ts.map +1 -0
  250. package/dist/esm/callAutomationClient.js +214 -0
  251. package/dist/esm/callAutomationClient.js.map +1 -0
  252. package/dist/esm/callAutomationEventParser.d.ts +6 -0
  253. package/dist/esm/callAutomationEventParser.d.ts.map +1 -0
  254. package/dist/esm/callAutomationEventParser.js +148 -0
  255. package/dist/esm/callAutomationEventParser.js.map +1 -0
  256. package/dist/esm/callConnection.d.ts +76 -0
  257. package/dist/esm/callConnection.d.ts.map +1 -0
  258. package/dist/esm/callConnection.js +211 -0
  259. package/dist/esm/callConnection.js.map +1 -0
  260. package/dist/esm/callMedia.d.ts +84 -0
  261. package/dist/esm/callMedia.d.ts.map +1 -0
  262. package/dist/esm/callMedia.js +322 -0
  263. package/dist/esm/callMedia.js.map +1 -0
  264. package/dist/esm/callRecording.d.ts +70 -0
  265. package/dist/esm/callRecording.d.ts.map +1 -0
  266. package/dist/esm/callRecording.js +179 -0
  267. package/dist/esm/callRecording.js.map +1 -0
  268. package/dist/esm/contentDownloader.d.ts +25 -0
  269. package/dist/esm/contentDownloader.d.ts.map +1 -0
  270. package/dist/esm/contentDownloader.js +104 -0
  271. package/dist/esm/contentDownloader.js.map +1 -0
  272. package/dist/esm/credential/callAutomationAccessKeyCredentialPolicy.d.ts +10 -0
  273. package/dist/esm/credential/callAutomationAccessKeyCredentialPolicy.d.ts.map +1 -0
  274. package/dist/esm/credential/callAutomationAccessKeyCredentialPolicy.js +39 -0
  275. package/dist/esm/credential/callAutomationAccessKeyCredentialPolicy.js.map +1 -0
  276. package/dist/esm/credential/callAutomationAuthPolicy.d.ts +22 -0
  277. package/dist/esm/credential/callAutomationAuthPolicy.d.ts.map +1 -0
  278. package/dist/esm/credential/callAutomationAuthPolicy.js +53 -0
  279. package/dist/esm/credential/callAutomationAuthPolicy.js.map +1 -0
  280. package/dist/esm/credential/cryptoUtils.d.ts +3 -0
  281. package/dist/esm/credential/cryptoUtils.d.ts.map +1 -0
  282. package/{dist-esm/src → dist/esm}/credential/cryptoUtils.js +1 -1
  283. package/{dist-esm/src → dist/esm}/credential/cryptoUtils.js.map +1 -1
  284. package/dist/esm/credential/encodeUtils.browser.d.ts +4 -0
  285. package/dist/esm/credential/encodeUtils.browser.d.ts.map +1 -0
  286. package/dist/esm/credential/encodeUtils.browser.js +26 -0
  287. package/dist/esm/credential/encodeUtils.browser.js.map +1 -0
  288. package/dist/esm/generated/src/callAutomationApiClient.d.ts +49 -0
  289. package/dist/esm/generated/src/callAutomationApiClient.d.ts.map +1 -0
  290. package/dist/esm/generated/src/callAutomationApiClient.js +226 -0
  291. package/dist/esm/generated/src/callAutomationApiClient.js.map +1 -0
  292. package/dist/esm/generated/src/index.d.ts +5 -0
  293. package/dist/esm/generated/src/index.d.ts.map +1 -0
  294. package/dist/esm/generated/src/index.js +13 -0
  295. package/dist/esm/generated/src/index.js.map +1 -0
  296. package/dist/esm/generated/src/models/index.d.ts +1494 -0
  297. package/dist/esm/generated/src/models/index.d.ts.map +1 -0
  298. package/dist/esm/generated/src/models/index.js +200 -0
  299. package/dist/esm/generated/src/models/index.js.map +1 -0
  300. package/dist/esm/generated/src/models/mappers.d.ts +82 -0
  301. package/dist/esm/generated/src/models/mappers.d.ts.map +1 -0
  302. package/dist/esm/generated/src/models/mappers.js +2853 -0
  303. package/dist/esm/generated/src/models/mappers.js.map +1 -0
  304. package/dist/esm/generated/src/models/parameters.d.ts +29 -0
  305. package/dist/esm/generated/src/models/parameters.d.ts.map +1 -0
  306. package/dist/esm/generated/src/models/parameters.js +180 -0
  307. package/dist/esm/generated/src/models/parameters.js.map +1 -0
  308. package/dist/esm/generated/src/operations/callConnection.d.ts +96 -0
  309. package/dist/esm/generated/src/operations/callConnection.d.ts.map +1 -0
  310. package/dist/esm/generated/src/operations/callConnection.js +402 -0
  311. package/dist/esm/generated/src/operations/callConnection.js.map +1 -0
  312. package/dist/esm/generated/src/operations/callMedia.d.ts +68 -0
  313. package/dist/esm/generated/src/operations/callMedia.d.ts.map +1 -0
  314. package/dist/esm/generated/src/operations/callMedia.js +227 -0
  315. package/dist/esm/generated/src/operations/callMedia.js.map +1 -0
  316. package/dist/esm/generated/src/operations/callRecording.d.ts +43 -0
  317. package/dist/esm/generated/src/operations/callRecording.d.ts.map +1 -0
  318. package/dist/esm/generated/src/operations/callRecording.js +144 -0
  319. package/dist/esm/generated/src/operations/callRecording.js.map +1 -0
  320. package/dist/esm/generated/src/operations/index.d.ts +4 -0
  321. package/dist/esm/generated/src/operations/index.d.ts.map +1 -0
  322. package/dist/esm/generated/src/operations/index.js +11 -0
  323. package/dist/esm/generated/src/operations/index.js.map +1 -0
  324. package/dist/esm/generated/src/operationsInterfaces/callConnection.d.ts +73 -0
  325. package/dist/esm/generated/src/operationsInterfaces/callConnection.d.ts.map +1 -0
  326. package/dist/esm/generated/src/operationsInterfaces/callConnection.js +9 -0
  327. package/dist/esm/generated/src/operationsInterfaces/callConnection.js.map +1 -0
  328. package/dist/esm/generated/src/operationsInterfaces/callMedia.d.ts +60 -0
  329. package/dist/esm/generated/src/operationsInterfaces/callMedia.d.ts.map +1 -0
  330. package/dist/esm/generated/src/operationsInterfaces/callMedia.js +9 -0
  331. package/dist/esm/generated/src/operationsInterfaces/callMedia.js.map +1 -0
  332. package/dist/esm/generated/src/operationsInterfaces/callRecording.d.ts +35 -0
  333. package/dist/esm/generated/src/operationsInterfaces/callRecording.d.ts.map +1 -0
  334. package/dist/esm/generated/src/operationsInterfaces/callRecording.js +9 -0
  335. package/dist/esm/generated/src/operationsInterfaces/callRecording.js.map +1 -0
  336. package/dist/esm/generated/src/operationsInterfaces/index.d.ts +4 -0
  337. package/dist/esm/generated/src/operationsInterfaces/index.d.ts.map +1 -0
  338. package/dist/esm/generated/src/operationsInterfaces/index.js +11 -0
  339. package/dist/esm/generated/src/operationsInterfaces/index.js.map +1 -0
  340. package/dist/esm/generated/src/pagingHelper.d.ts +13 -0
  341. package/dist/esm/generated/src/pagingHelper.d.ts.map +1 -0
  342. package/dist/esm/generated/src/pagingHelper.js +32 -0
  343. package/dist/esm/generated/src/pagingHelper.js.map +1 -0
  344. package/dist/esm/index.d.ts +10 -0
  345. package/dist/esm/index.d.ts.map +1 -0
  346. package/dist/esm/index.js +12 -0
  347. package/dist/esm/index.js.map +1 -0
  348. package/dist/esm/models/constants.d.ts +2 -0
  349. package/dist/esm/models/constants.d.ts.map +1 -0
  350. package/dist/esm/models/constants.js +4 -0
  351. package/dist/esm/models/constants.js.map +1 -0
  352. package/dist/esm/models/events.d.ts +395 -0
  353. package/dist/esm/models/events.d.ts.map +1 -0
  354. package/dist/esm/models/events.js +4 -0
  355. package/dist/esm/models/events.js.map +1 -0
  356. package/dist/esm/models/logger.d.ts +5 -0
  357. package/dist/esm/models/logger.d.ts.map +1 -0
  358. package/dist/esm/models/logger.js +8 -0
  359. package/dist/esm/models/logger.js.map +1 -0
  360. package/dist/esm/models/mapper.d.ts +3 -0
  361. package/dist/esm/models/mapper.d.ts.map +1 -0
  362. package/dist/esm/models/mapper.js +76 -0
  363. package/dist/esm/models/mapper.js.map +1 -0
  364. package/dist/esm/models/models.d.ts +188 -0
  365. package/dist/esm/models/models.d.ts.map +1 -0
  366. package/dist/esm/models/models.js +54 -0
  367. package/dist/esm/models/models.js.map +1 -0
  368. package/dist/esm/models/options.d.ts +315 -0
  369. package/dist/esm/models/options.d.ts.map +1 -0
  370. package/dist/esm/models/options.js +4 -0
  371. package/dist/esm/models/options.js.map +1 -0
  372. package/dist/esm/models/responses.d.ts +73 -0
  373. package/dist/esm/models/responses.d.ts.map +1 -0
  374. package/dist/esm/models/responses.js +4 -0
  375. package/dist/esm/models/responses.js.map +1 -0
  376. package/dist/esm/package.json +3 -0
  377. package/dist/esm/utli/converters.d.ts +22 -0
  378. package/dist/esm/utli/converters.d.ts.map +1 -0
  379. package/dist/esm/utli/converters.js +142 -0
  380. package/dist/esm/utli/converters.js.map +1 -0
  381. package/dist/react-native/callAutomationClient.d.ts +98 -0
  382. package/dist/react-native/callAutomationClient.d.ts.map +1 -0
  383. package/dist/react-native/callAutomationClient.js +214 -0
  384. package/dist/react-native/callAutomationClient.js.map +1 -0
  385. package/dist/react-native/callAutomationEventParser.d.ts +6 -0
  386. package/dist/react-native/callAutomationEventParser.d.ts.map +1 -0
  387. package/dist/react-native/callAutomationEventParser.js +148 -0
  388. package/dist/react-native/callAutomationEventParser.js.map +1 -0
  389. package/dist/react-native/callConnection.d.ts +76 -0
  390. package/dist/react-native/callConnection.d.ts.map +1 -0
  391. package/dist/react-native/callConnection.js +211 -0
  392. package/dist/react-native/callConnection.js.map +1 -0
  393. package/dist/react-native/callMedia.d.ts +84 -0
  394. package/dist/react-native/callMedia.d.ts.map +1 -0
  395. package/dist/react-native/callMedia.js +322 -0
  396. package/dist/react-native/callMedia.js.map +1 -0
  397. package/dist/react-native/callRecording.d.ts +70 -0
  398. package/dist/react-native/callRecording.d.ts.map +1 -0
  399. package/dist/react-native/callRecording.js +179 -0
  400. package/dist/react-native/callRecording.js.map +1 -0
  401. package/dist/react-native/contentDownloader.d.ts +25 -0
  402. package/dist/react-native/contentDownloader.d.ts.map +1 -0
  403. package/dist/react-native/contentDownloader.js +104 -0
  404. package/dist/react-native/contentDownloader.js.map +1 -0
  405. package/dist/react-native/credential/callAutomationAccessKeyCredentialPolicy.d.ts +10 -0
  406. package/dist/react-native/credential/callAutomationAccessKeyCredentialPolicy.d.ts.map +1 -0
  407. package/dist/react-native/credential/callAutomationAccessKeyCredentialPolicy.js +39 -0
  408. package/dist/react-native/credential/callAutomationAccessKeyCredentialPolicy.js.map +1 -0
  409. package/dist/react-native/credential/callAutomationAuthPolicy.d.ts +22 -0
  410. package/dist/react-native/credential/callAutomationAuthPolicy.d.ts.map +1 -0
  411. package/dist/react-native/credential/callAutomationAuthPolicy.js +53 -0
  412. package/dist/react-native/credential/callAutomationAuthPolicy.js.map +1 -0
  413. package/dist/react-native/credential/cryptoUtils.d.ts +3 -0
  414. package/dist/react-native/credential/cryptoUtils.d.ts.map +1 -0
  415. package/dist/react-native/credential/cryptoUtils.js +9 -0
  416. package/dist/react-native/credential/cryptoUtils.js.map +1 -0
  417. package/dist/react-native/credential/encodeUtils.browser.d.ts +4 -0
  418. package/dist/react-native/credential/encodeUtils.browser.d.ts.map +1 -0
  419. package/dist/react-native/credential/encodeUtils.browser.js +26 -0
  420. package/dist/react-native/credential/encodeUtils.browser.js.map +1 -0
  421. package/dist/react-native/generated/src/callAutomationApiClient.d.ts +49 -0
  422. package/dist/react-native/generated/src/callAutomationApiClient.d.ts.map +1 -0
  423. package/dist/react-native/generated/src/callAutomationApiClient.js +226 -0
  424. package/dist/react-native/generated/src/callAutomationApiClient.js.map +1 -0
  425. package/dist/react-native/generated/src/index.d.ts +5 -0
  426. package/dist/react-native/generated/src/index.d.ts.map +1 -0
  427. package/dist/react-native/generated/src/index.js +13 -0
  428. package/dist/react-native/generated/src/index.js.map +1 -0
  429. package/dist/react-native/generated/src/models/index.d.ts +1494 -0
  430. package/dist/react-native/generated/src/models/index.d.ts.map +1 -0
  431. package/dist/react-native/generated/src/models/index.js +200 -0
  432. package/dist/react-native/generated/src/models/index.js.map +1 -0
  433. package/dist/react-native/generated/src/models/mappers.d.ts +82 -0
  434. package/dist/react-native/generated/src/models/mappers.d.ts.map +1 -0
  435. package/dist/react-native/generated/src/models/mappers.js +2853 -0
  436. package/dist/react-native/generated/src/models/mappers.js.map +1 -0
  437. package/dist/react-native/generated/src/models/parameters.d.ts +29 -0
  438. package/dist/react-native/generated/src/models/parameters.d.ts.map +1 -0
  439. package/dist/react-native/generated/src/models/parameters.js +180 -0
  440. package/dist/react-native/generated/src/models/parameters.js.map +1 -0
  441. package/dist/react-native/generated/src/operations/callConnection.d.ts +96 -0
  442. package/dist/react-native/generated/src/operations/callConnection.d.ts.map +1 -0
  443. package/dist/react-native/generated/src/operations/callConnection.js +402 -0
  444. package/dist/react-native/generated/src/operations/callConnection.js.map +1 -0
  445. package/dist/react-native/generated/src/operations/callMedia.d.ts +68 -0
  446. package/dist/react-native/generated/src/operations/callMedia.d.ts.map +1 -0
  447. package/dist/react-native/generated/src/operations/callMedia.js +227 -0
  448. package/dist/react-native/generated/src/operations/callMedia.js.map +1 -0
  449. package/dist/react-native/generated/src/operations/callRecording.d.ts +43 -0
  450. package/dist/react-native/generated/src/operations/callRecording.d.ts.map +1 -0
  451. package/dist/react-native/generated/src/operations/callRecording.js +144 -0
  452. package/dist/react-native/generated/src/operations/callRecording.js.map +1 -0
  453. package/dist/react-native/generated/src/operations/index.d.ts +4 -0
  454. package/dist/react-native/generated/src/operations/index.d.ts.map +1 -0
  455. package/dist/react-native/generated/src/operations/index.js +11 -0
  456. package/dist/react-native/generated/src/operations/index.js.map +1 -0
  457. package/dist/react-native/generated/src/operationsInterfaces/callConnection.d.ts +73 -0
  458. package/dist/react-native/generated/src/operationsInterfaces/callConnection.d.ts.map +1 -0
  459. package/dist/react-native/generated/src/operationsInterfaces/callConnection.js +9 -0
  460. package/dist/react-native/generated/src/operationsInterfaces/callConnection.js.map +1 -0
  461. package/dist/react-native/generated/src/operationsInterfaces/callMedia.d.ts +60 -0
  462. package/dist/react-native/generated/src/operationsInterfaces/callMedia.d.ts.map +1 -0
  463. package/dist/react-native/generated/src/operationsInterfaces/callMedia.js +9 -0
  464. package/dist/react-native/generated/src/operationsInterfaces/callMedia.js.map +1 -0
  465. package/dist/react-native/generated/src/operationsInterfaces/callRecording.d.ts +35 -0
  466. package/dist/react-native/generated/src/operationsInterfaces/callRecording.d.ts.map +1 -0
  467. package/dist/react-native/generated/src/operationsInterfaces/callRecording.js +9 -0
  468. package/dist/react-native/generated/src/operationsInterfaces/callRecording.js.map +1 -0
  469. package/dist/react-native/generated/src/operationsInterfaces/index.d.ts +4 -0
  470. package/dist/react-native/generated/src/operationsInterfaces/index.d.ts.map +1 -0
  471. package/dist/react-native/generated/src/operationsInterfaces/index.js +11 -0
  472. package/dist/react-native/generated/src/operationsInterfaces/index.js.map +1 -0
  473. package/dist/react-native/generated/src/pagingHelper.d.ts +13 -0
  474. package/dist/react-native/generated/src/pagingHelper.d.ts.map +1 -0
  475. package/dist/react-native/generated/src/pagingHelper.js +32 -0
  476. package/dist/react-native/generated/src/pagingHelper.js.map +1 -0
  477. package/dist/react-native/index.d.ts +10 -0
  478. package/dist/react-native/index.d.ts.map +1 -0
  479. package/dist/react-native/index.js +12 -0
  480. package/dist/react-native/index.js.map +1 -0
  481. package/dist/react-native/models/constants.d.ts +2 -0
  482. package/dist/react-native/models/constants.d.ts.map +1 -0
  483. package/dist/react-native/models/constants.js +4 -0
  484. package/dist/react-native/models/constants.js.map +1 -0
  485. package/dist/react-native/models/events.d.ts +395 -0
  486. package/dist/react-native/models/events.d.ts.map +1 -0
  487. package/dist/react-native/models/events.js +4 -0
  488. package/dist/react-native/models/events.js.map +1 -0
  489. package/dist/react-native/models/logger.d.ts +5 -0
  490. package/dist/react-native/models/logger.d.ts.map +1 -0
  491. package/dist/react-native/models/logger.js +8 -0
  492. package/dist/react-native/models/logger.js.map +1 -0
  493. package/dist/react-native/models/mapper.d.ts +3 -0
  494. package/dist/react-native/models/mapper.d.ts.map +1 -0
  495. package/dist/react-native/models/mapper.js +76 -0
  496. package/dist/react-native/models/mapper.js.map +1 -0
  497. package/dist/react-native/models/models.d.ts +188 -0
  498. package/dist/react-native/models/models.d.ts.map +1 -0
  499. package/dist/react-native/models/models.js +54 -0
  500. package/dist/react-native/models/models.js.map +1 -0
  501. package/dist/react-native/models/options.d.ts +315 -0
  502. package/dist/react-native/models/options.d.ts.map +1 -0
  503. package/dist/react-native/models/options.js +4 -0
  504. package/dist/react-native/models/options.js.map +1 -0
  505. package/dist/react-native/models/responses.d.ts +73 -0
  506. package/dist/react-native/models/responses.d.ts.map +1 -0
  507. package/dist/react-native/models/responses.js +4 -0
  508. package/dist/react-native/models/responses.js.map +1 -0
  509. package/dist/react-native/package.json +3 -0
  510. package/dist/react-native/utli/converters.d.ts +22 -0
  511. package/dist/react-native/utli/converters.d.ts.map +1 -0
  512. package/dist/react-native/utli/converters.js +142 -0
  513. package/dist/react-native/utli/converters.js.map +1 -0
  514. package/package.json +91 -53
  515. package/dist/index.js +0 -5763
  516. package/dist/index.js.map +0 -1
  517. package/dist-esm/src/callAutomationEventParser.js.map +0 -1
  518. package/dist-esm/src/callConnection.js.map +0 -1
  519. package/dist-esm/src/callRecording.js.map +0 -1
  520. package/dist-esm/src/contentDownloader.js.map +0 -1
  521. package/dist-esm/src/credential/callAutomationAccessKeyCredentialPolicy.js.map +0 -1
  522. package/dist-esm/src/credential/callAutomationAuthPolicy.js.map +0 -1
  523. package/dist-esm/src/credential/cryptoUtils.browser.js.map +0 -1
  524. package/dist-esm/src/generated/src/callAutomationApiClient.js.map +0 -1
  525. package/dist-esm/src/generated/src/index.js.map +0 -1
  526. package/dist-esm/src/generated/src/operations/callConnection.js.map +0 -1
  527. package/dist-esm/src/generated/src/operations/callMedia.js.map +0 -1
  528. package/dist-esm/src/generated/src/operations/callRecording.js.map +0 -1
  529. package/dist-esm/src/generated/src/operations/index.js.map +0 -1
  530. package/dist-esm/src/generated/src/operationsInterfaces/callConnection.js.map +0 -1
  531. package/dist-esm/src/generated/src/operationsInterfaces/callMedia.js.map +0 -1
  532. package/dist-esm/src/generated/src/operationsInterfaces/callRecording.js.map +0 -1
  533. package/dist-esm/src/generated/src/operationsInterfaces/index.js.map +0 -1
  534. package/dist-esm/src/index.js +0 -12
  535. package/dist-esm/src/index.js.map +0 -1
  536. package/dist-esm/src/models/events.js.map +0 -1
  537. package/dist-esm/src/models/models.js.map +0 -1
  538. package/dist-esm/src/models/options.js.map +0 -1
  539. package/dist-esm/src/models/responses.js.map +0 -1
  540. package/dist-esm/src/utli/converters.js.map +0 -1
  541. package/types/communication-call-automation.d.ts +0 -2014
  542. /package/{dist-esm/src → dist/browser}/contentDownloader.js +0 -0
  543. /package/{dist-esm/src → dist/browser}/credential/encodeUtils.browser.js +0 -0
  544. /package/{dist-esm/src → dist/browser}/credential/encodeUtils.browser.js.map +0 -0
  545. /package/{dist-esm/src → dist/browser}/generated/src/models/index.js +0 -0
  546. /package/{dist-esm/src → dist/browser}/generated/src/models/index.js.map +0 -0
  547. /package/{dist-esm/src → dist/browser}/generated/src/models/mappers.js +0 -0
  548. /package/{dist-esm/src → dist/browser}/generated/src/models/mappers.js.map +0 -0
  549. /package/{dist-esm/src → dist/browser}/generated/src/operationsInterfaces/callConnection.js +0 -0
  550. /package/{dist-esm/src → dist/browser}/generated/src/operationsInterfaces/callMedia.js +0 -0
  551. /package/{dist-esm/src → dist/browser}/generated/src/operationsInterfaces/callRecording.js +0 -0
  552. /package/{dist-esm/src → dist/browser}/generated/src/pagingHelper.js +0 -0
  553. /package/{dist-esm/src → dist/browser}/generated/src/pagingHelper.js.map +0 -0
  554. /package/{dist-esm/src → dist/browser}/models/constants.js +0 -0
  555. /package/{dist-esm/src → dist/browser}/models/constants.js.map +0 -0
  556. /package/{dist-esm/src → dist/browser}/models/events.js +0 -0
  557. /package/{dist-esm/src → dist/browser}/models/logger.js +0 -0
  558. /package/{dist-esm/src → dist/browser}/models/logger.js.map +0 -0
  559. /package/{dist-esm/src → dist/browser}/models/mapper.js +0 -0
  560. /package/{dist-esm/src → dist/browser}/models/mapper.js.map +0 -0
  561. /package/{dist-esm/src → dist/browser}/models/options.js +0 -0
  562. /package/{dist-esm/src → dist/browser}/models/responses.js +0 -0
@@ -1,2014 +0,0 @@
1
- import { CommonClientOptions } from '@azure/core-client';
2
- import { CommunicationIdentifier } from '@azure/communication-common';
3
- import { CommunicationUserIdentifier } from '@azure/communication-common';
4
- import * as coreClient from '@azure/core-client';
5
- import { KeyCredential } from '@azure/core-auth';
6
- import { MicrosoftTeamsAppIdentifier } from '@azure/communication-common';
7
- import { MicrosoftTeamsUserIdentifier } from '@azure/communication-common';
8
- import { OperationOptions } from '@azure/core-client';
9
- import { PhoneNumberIdentifier } from '@azure/communication-common';
10
- import { TokenCredential } from '@azure/core-auth';
11
-
12
- /** The failed to add participant event. */
13
- export declare interface AddParticipantFailed extends Omit<RestAddParticipantFailed, "callConnectionId" | "serverCallId" | "correlationId" | "participant" | "resultInformation"> {
14
- /** Call connection ID. */
15
- callConnectionId: string;
16
- /** Server call ID. */
17
- serverCallId: string;
18
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
19
- correlationId: string;
20
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
21
- resultInformation?: ResultInformation;
22
- /** The participant in the call. */
23
- participant?: CommunicationIdentifier;
24
- /** kind of this event. */
25
- kind: "AddParticipantFailed";
26
- }
27
-
28
- /** Options to add participants. */
29
- export declare interface AddParticipantOptions extends OperationOptions {
30
- /**
31
- * Gets or sets the timeout to wait for the invited participant to pickup.
32
- * The maximum value of this is 180 seconds
33
- */
34
- invitationTimeoutInSeconds?: number;
35
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
36
- operationContext?: string;
37
- /**
38
- * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.
39
- * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
40
- */
41
- operationCallbackUrl?: string;
42
- }
43
-
44
- /** The response payload for adding participants to the call. */
45
- export declare interface AddParticipantResult {
46
- /** invitation ID used to add the participant. */
47
- invitationId?: string;
48
- /** List of current participants in the call. */
49
- participant?: CallParticipant;
50
- /** The operation context provided by client. */
51
- operationContext?: string;
52
- }
53
-
54
- /** The participant successfully added event. */
55
- export declare interface AddParticipantSucceeded extends Omit<RestAddParticipantSucceeded, "callConnectionId" | "serverCallId" | "correlationId" | "participant" | "resultInformation"> {
56
- /** Call connection ID. */
57
- callConnectionId: string;
58
- /** Server call ID. */
59
- serverCallId: string;
60
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
61
- correlationId: string;
62
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
63
- resultInformation?: ResultInformation;
64
- /** The participant in the call. */
65
- participant?: CommunicationIdentifier;
66
- /** kind of this event. */
67
- kind: "AddParticipantSucceeded";
68
- }
69
-
70
- /**
71
- * Options to answer a call.
72
- */
73
- export declare interface AnswerCallOptions extends OperationOptions {
74
- /** AI options for the call. */
75
- callIntelligenceOptions?: CallIntelligenceOptions;
76
- /** The operation context. */
77
- operationContext?: string;
78
- }
79
-
80
- /**
81
- * AnswerCall result
82
- */
83
- export declare type AnswerCallResult = CallResult;
84
-
85
- export declare interface AnswerFailed extends Omit<RestAnswerFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
86
- /** Call connection ID. */
87
- callConnectionId: string;
88
- /** Server call ID. */
89
- serverCallId: string;
90
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
91
- correlationId: string;
92
- /** Contains the resulting SIP code, sub-code and message. */
93
- resultInformation?: ResultInformation;
94
- /** kind of this event. */
95
- kind: "AnswerFailed";
96
- }
97
-
98
- /** Optional parameters. */
99
- declare interface CallAutomationApiClientOptionalParams extends coreClient.ServiceClientOptions {
100
- /** Api Version */
101
- apiVersion?: string;
102
- /** Overrides client endpoint. */
103
- endpoint?: string;
104
- }
105
-
106
- /**
107
- * A CallAutomationClient represents a Client to the Azure Communication CallAutomation service.
108
- */
109
- export declare class CallAutomationClient {
110
- private readonly callAutomationApiClient;
111
- private readonly sourceIdentity?;
112
- private readonly credential;
113
- private readonly internalPipelineOptions;
114
- /**
115
- * Initializes a new instance of the CallAutomationClient class.
116
- * @param connectionString - Connection string to connect to an Azure Communication Service resource.
117
- * Example: "endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret";
118
- * @param options - Optional. Options to configure the HTTP pipeline.
119
- */
120
- constructor(connectionString: string, options?: CallAutomationClientOptions);
121
- /**
122
- * Initializes a new instance of the CallAutomationClient class using a TokenCredential or KeyCredential.
123
- * @param endpoint - The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).
124
- * @param credential - TokenCredential or KeyCredential that is used to authenticate requests to the service.
125
- * @param options - Optional. Options to configure the HTTP pipeline.
126
- */
127
- constructor(endpoint: string, credential: TokenCredential | KeyCredential, options?: CallAutomationClientOptions);
128
- /**
129
- * Initializes a new instance of CallConnection.
130
- * @param callConnectionId - The CallConnection id for the CallConnection instance. (ex: 421CONTOSO-cRD6-4RDc-a078-99dRANDOMf).
131
- */
132
- getCallConnection(callConnectionId: string): CallConnection;
133
- /**
134
- * Initializes a new instance of CallRecording.
135
- */
136
- getCallRecording(): CallRecording;
137
- /**
138
- * Get Source Identity that is used for create and answer call
139
- */
140
- getSourceIdentity(): CommunicationUserIdentifier | undefined;
141
- private createCallInternal;
142
- /**
143
- * Create an outgoing call from source to a target identity.
144
- * @param targetParticipant - A single target.
145
- * @param callbackUrl - The callback url.
146
- * @param options - Additional request options contains createCallConnection api options.
147
- */
148
- createCall(targetParticipant: CallInvite, callbackUrl: string, options?: CreateCallOptions): Promise<CreateCallResult>;
149
- /**
150
- * Create an outgoing call from source to a group of targets identities.
151
- * @param targetParticipants - A group of targets identities.
152
- * @param callbackUrl - The callback url.
153
- * @param options - Additional request options contains createCallConnection api options.
154
- */
155
- createGroupCall(targetParticipants: CommunicationIdentifier[], callbackUrl: string, options?: CreateCallOptions): Promise<CreateCallResult>;
156
- /**
157
- * Answer the call.
158
- * @param incomingCallContext - The context associated with the call.
159
- * @param callbackUrl - The callback url.
160
- * @param options - Additional request options contains answerCall api options.
161
- */
162
- answerCall(incomingCallContext: string, callbackUrl: string, options?: AnswerCallOptions): Promise<AnswerCallResult>;
163
- /**
164
- * Redirect the call.
165
- *
166
- * @param incomingCallContext - The context associated with the call.
167
- * @param targetParticipant - The target identity to redirect the call to.
168
- * @param options - Additional request options contains redirectCall api options.
169
- */
170
- redirectCall(incomingCallContext: string, targetParticipant: CallInvite, options?: RedirectCallOptions): Promise<void>;
171
- /**
172
- * Reject the call.
173
- *
174
- * @param incomingCallContext - The context associated with the call.
175
- * @param options - Additional request options contains rejectCall api options.
176
- */
177
- rejectCall(incomingCallContext: string, options?: RejectCallOptions): Promise<void>;
178
- /**
179
- * Create connection to room call.
180
- * @param callLocator - Call locator to create connection.
181
- * @param callbackUrl - The callback url
182
- * @param options - Additional request options contains connect api options.
183
- */
184
- connectCall(callLocator: CallLocator, callbackUrl: string, options?: ConnectCallOptions): Promise<ConnectCallResult>;
185
- }
186
-
187
- /**
188
- * Client options used to configure CallAutomation Client API requests.
189
- */
190
- export declare interface CallAutomationClientOptions extends CommonClientOptions {
191
- /**
192
- * The identifier of the source of the call for call creating/answering/inviting operation.
193
- */
194
- sourceIdentity?: CommunicationUserIdentifier;
195
- }
196
-
197
- /** Callback events for Call Automation */
198
- export declare type CallAutomationEvent = AddParticipantSucceeded | AddParticipantFailed | RemoveParticipantSucceeded | RemoveParticipantFailed | CallConnected | CallDisconnected | CallTransferAccepted | CallTransferFailed | ParticipantsUpdated | RecordingStateChanged | PlayStarted | PlayCompleted | PlayFailed | PlayCanceled | RecognizeCompleted | RecognizeCanceled | RecognizeFailed | ContinuousDtmfRecognitionToneReceived | ContinuousDtmfRecognitionToneFailed | ContinuousDtmfRecognitionStopped | SendDtmfTonesCompleted | SendDtmfTonesFailed | CancelAddParticipantSucceeded | CancelAddParticipantFailed | ConnectFailed | HoldFailed | AnswerFailed | CreateCallFailed;
199
-
200
- /** Event when call was established. */
201
- export declare interface CallConnected extends Omit<RestCallConnected, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
202
- /** Call connection ID. */
203
- callConnectionId: string;
204
- /** Server call ID. */
205
- serverCallId: string;
206
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
207
- correlationId: string;
208
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
209
- resultInformation?: ResultInformation;
210
- /** kind of this event. */
211
- kind: "CallConnected";
212
- }
213
-
214
- /**
215
- * CallConnection class represents call connection based APIs.
216
- */
217
- export declare class CallConnection {
218
- private readonly callConnectionId;
219
- private readonly callConnection;
220
- private readonly callAutomationApiClient;
221
- private readonly endpoint;
222
- private readonly credential;
223
- private readonly callAutomationApiClientOptions?;
224
- constructor(callConnectionId: string, endpoint: string, credential: KeyCredential | TokenCredential, options?: CallAutomationApiClientOptionalParams);
225
- /**
226
- * Initializes a new instance of CallMedia.
227
- */
228
- getCallMedia(): CallMedia;
229
- /**
230
- * Get call connection properties of the call
231
- */
232
- getCallConnectionProperties(options?: GetCallConnectionPropertiesOptions): Promise<CallConnectionProperties>;
233
- /**
234
- * Hang up the call for itself or terminate the whole call.
235
- *
236
- * @param isForEveryOne - Determine if every one in the call would be hung up or not.
237
- */
238
- hangUp(isForEveryone: boolean, options?: HangUpOptions): Promise<void>;
239
- /**
240
- * Get a participant from the call
241
- *
242
- * @param targetParticipant - The communication identifier of requested participant.
243
- */
244
- getParticipant(targetParticipant: CommunicationIdentifier, options?: GetParticipantOptions): Promise<CallParticipant>;
245
- /**
246
- * Get all participants from the call
247
- */
248
- listParticipants(options?: GetParticipantOptions): Promise<ListParticipantsResult>;
249
- private createCustomCallingContextInternal;
250
- /**
251
- * Add a participant to the call
252
- *
253
- * @param participant - The participant is going to be added.
254
- */
255
- addParticipant(targetParticipant: CallInvite, options?: AddParticipantOptions): Promise<AddParticipantResult>;
256
- /**
257
- * Transfer the call to a target participant
258
- *
259
- * @param targetParticipant - The target to be transferred to.
260
- */
261
- transferCallToParticipant(targetParticipant: CommunicationIdentifier, options?: TransferCallToParticipantOptions): Promise<TransferCallResult>;
262
- /**
263
- * Remove a participant from the call
264
- *
265
- * @param participant - The participant is going to be removed from the call.
266
- */
267
- removeParticipant(participant: CommunicationIdentifier, options?: RemoveParticipantsOption): Promise<RemoveParticipantResult>;
268
- /**
269
- * Mute participant from the call.
270
- *
271
- * @param participant - Participant to be muted from the call.
272
- * @param options - Additional attributes for mute participant.
273
- */
274
- muteParticipant(participant: CommunicationIdentifier, options?: MuteParticipantOption): Promise<MuteParticipantResult>;
275
- /** Cancel add participant operation.
276
- *
277
- * @param invitationId - Invitation ID used to cancel the add participant request.
278
- * @param options - Additional attributes for cancel add participant operation.
279
- */
280
- cancelAddParticipantOperation(invitationId: string, options?: CancelAddParticipantOperationOptions): Promise<CancelAddParticipantOperationResult>;
281
- }
282
-
283
- /** Properties of a call connection */
284
- export declare interface CallConnectionProperties {
285
- /** The call connection id. */
286
- callConnectionId?: string;
287
- /** The server call id. */
288
- serverCallId?: string;
289
- /**
290
- * The source caller Id, a phone number, that's shown to the PSTN participant being invited.
291
- * Required only when calling a PSTN callee.
292
- */
293
- sourceCallerIdNumber?: PhoneNumberIdentifier;
294
- /** Display name of the call if dialing out to a pstn number. */
295
- sourceDisplayName?: string;
296
- /** Source identity. */
297
- source?: CommunicationIdentifier;
298
- /** The targets of the call. */
299
- targetParticipants?: CommunicationIdentifier[];
300
- /** The state of the call connection. */
301
- callConnectionState?: CallConnectionStateModel;
302
- /** The callback URL. */
303
- callbackUrl?: string;
304
- /** The correlation ID. */
305
- correlationId?: string;
306
- /** Identity of the answering entity. Only populated when identity is provided in the request. */
307
- answeredby?: CommunicationUserIdentifier;
308
- /** Identity of the original Pstn target of an incoming Call. Only populated when the original target is a Pstn number. */
309
- answeredFor?: PhoneNumberIdentifier;
310
- }
311
-
312
- /**
313
- * Defines values for CallConnectionStateModel. \
314
- * {@link KnownCallConnectionStateModel} can be used interchangeably with CallConnectionStateModel,
315
- * this enum contains the known values that the service supports.
316
- * ### Known values supported by the service
317
- * **unknown** \
318
- * **connecting** \
319
- * **connected** \
320
- * **transferring** \
321
- * **transferAccepted** \
322
- * **disconnecting** \
323
- * **disconnected**
324
- */
325
- export declare type CallConnectionStateModel = string;
326
-
327
- /** Event when all participants left and call was terminated. */
328
- export declare interface CallDisconnected extends Omit<RestCallDisconnected, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
329
- /** Call connection ID. */
330
- callConnectionId: string;
331
- /** Server call ID. */
332
- serverCallId: string;
333
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
334
- correlationId: string;
335
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
336
- resultInformation?: ResultInformation;
337
- /** kind of this event. */
338
- kind: "CallDisconnected";
339
- }
340
-
341
- /** AI options for the call. */
342
- export declare interface CallIntelligenceOptions {
343
- /** The identifier of the Cognitive Service resource assigned to this call. */
344
- cognitiveServicesEndpoint?: string;
345
- }
346
-
347
- /** Call invitee details. */
348
- export declare interface CallInvite {
349
- /** The Target's PhoneNumberIdentifier, CommunicationUserIdentifier, MicrosoftTeamsUserIdentifier or MicrosoftTeamsAppIdentifier. */
350
- readonly targetParticipant: PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier;
351
- /** Caller's phone number identifier. */
352
- readonly sourceCallIdNumber?: PhoneNumberIdentifier;
353
- sourceDisplayName?: string;
354
- /** Used by customer to send custom context to targets. */
355
- customCallingContext?: CustomCallingContext;
356
- }
357
-
358
- /** The locator used for joining or taking action on a call. */
359
- export declare interface CallLocator {
360
- id: string;
361
- kind: CallLocatorType;
362
- }
363
-
364
- /** The locator type of a call. */
365
- export declare type CallLocatorType = "serverCallLocator" | "groupCallLocator" | "roomCallLocator";
366
-
367
- /**
368
- * CallMedia class represents call media related APIs.
369
- */
370
- export declare class CallMedia {
371
- private readonly callConnectionId;
372
- private readonly callMedia;
373
- private readonly callAutomationApiClient;
374
- constructor(callConnectionId: string, endpoint: string, credential: KeyCredential | TokenCredential, options?: CallAutomationApiClientOptionalParams);
375
- private createPlaySourceInternal;
376
- /**
377
- * Play audio to a specific participant.
378
- *
379
- * @param playSources - A PlaySource representing the sources to play. Currently only single play source per request is supported.
380
- * @param playTo - The targets to play to.
381
- * @param options - Additional attributes for play.
382
- */
383
- play(playSources: (FileSource | TextSource | SsmlSource)[], playTo: CommunicationIdentifier[], options?: PlayOptions): Promise<void>;
384
- /**
385
- * Play to all participants.
386
- *
387
- * @param playSources - A PlaySource representing the sources to play. Currently only single play source per request is supported.
388
- * @param options - Additional attributes for play.
389
- */
390
- playToAll(playSources: (FileSource | TextSource | SsmlSource)[], options?: PlayToAllOptions): Promise<void>;
391
- private createRecognizeRequest;
392
- /**
393
- * Recognize participant input.
394
- * @deprecated This method signature is deprecated. Please use the new signature with targetParticipant and options params instead, and set maxTonesToCollect in options.
395
- * @param targetParticipant - Target participant.
396
- * @param maxTonesToCollect - Maximum number of DTMF tones to be collected.
397
- * @param options - Different attributes for recognize.
398
- * */
399
- startRecognizing(targetParticipant: CommunicationIdentifier, maxTonesToCollect: number, options: CallMediaRecognizeDtmfOptions): Promise<void>;
400
- /**
401
- * Recognize participant input.
402
- * @param targetParticipant - Target participant.
403
- * @param options - Different attributes for recognize.
404
- * */
405
- startRecognizing(targetParticipant: CommunicationIdentifier, options: CallMediaRecognizeDtmfOptions | CallMediaRecognizeChoiceOptions | CallMediaRecognizeSpeechOptions | CallMediaRecognizeSpeechOrDtmfOptions): Promise<void>;
406
- /**
407
- * Cancels all the queued media operations.
408
- */
409
- cancelAllOperations(): Promise<void>;
410
- /**
411
- * Start continuous Dtmf recognition by subscribing to tones.
412
- * @param targetParticipant - Target participant.
413
- * @param options - Additional attributes for continuous Dtmf recognition.
414
- * */
415
- startContinuousDtmfRecognition(targetParticipant: CommunicationIdentifier, options?: ContinuousDtmfRecognitionOptions): Promise<void>;
416
- /**
417
- * Stop continuous Dtmf recognition by unsubscribing to tones.
418
- * @param targetParticipant - Target participant.
419
- * @param options - Additional attributes for continuous Dtmf recognition.
420
- * */
421
- stopContinuousDtmfRecognition(targetParticipant: CommunicationIdentifier, options?: ContinuousDtmfRecognitionOptions): Promise<void>;
422
- /**
423
- * Send Dtmf tones.
424
- * @param tones - List of tones to be sent to target participant.
425
- * @param targetParticipant - Target participant.
426
- * @param options - Additional attributes for send Dtmf tones.
427
- * */
428
- sendDtmfTones(tones: Tone[] | DtmfTone[], targetParticipant: CommunicationIdentifier, options?: SendDtmfTonesOptions): Promise<SendDtmfTonesResult>;
429
- /**
430
- * Put participant on hold while playing audio.
431
- *
432
- * @param targetParticipant - The targets to play to.
433
- * @param options - Additional attributes for hold participant.
434
- */
435
- hold(targetParticipant: CommunicationIdentifier, options?: HoldOptions): Promise<void>;
436
- /**
437
- * Remove participant from hold.
438
- *
439
- * @param targetParticipant - The targets to play to.
440
- * @param options - Additional attributes for unhold participant.
441
- */
442
- unhold(targetParticipant: CommunicationIdentifier, options?: UnholdOptions): Promise<void>;
443
- }
444
-
445
- /** The recognize configuration specific to Choices. */
446
- export declare interface CallMediaRecognizeChoiceOptions extends CallMediaRecognizeOptions {
447
- /** The IvR choices for recognize. */
448
- choices: RecognitionChoice[];
449
- /** Speech language to be recognized, If not set default is en-US */
450
- speechLanguage?: string;
451
- /** Endpoint where the custom model was deployed. */
452
- speechRecognitionModelEndpointId?: string;
453
- readonly kind: "callMediaRecognizeChoiceOptions";
454
- }
455
-
456
- /** The recognize configuration specific to Dtmf. */
457
- export declare interface CallMediaRecognizeDtmfOptions extends CallMediaRecognizeOptions {
458
- /** Time to wait between DTMF inputs to stop recognizing. */
459
- interToneTimeoutInSeconds?: number;
460
- /** List of tones that will stop recognizing. */
461
- stopDtmfTones?: DtmfTone[];
462
- /** Maximum number of DTMF tones to be collected. */
463
- maxTonesToCollect?: number;
464
- readonly kind: "callMediaRecognizeDtmfOptions";
465
- }
466
-
467
- /** Options to configure the recognize operation. */
468
- export declare interface CallMediaRecognizeOptions extends OperationOptions {
469
- /** The source of the audio to be played for recognition. */
470
- playPrompt?: FileSource | TextSource | SsmlSource;
471
- /** The list source of the audio to be played for recognition. */
472
- playPrompts?: (FileSource | TextSource | SsmlSource)[];
473
- /** If set recognize can barge into other existing queued-up/currently-processing requests. */
474
- interruptCallMediaOperation?: boolean;
475
- /** @deprecated Not in use, instead use interruptCallMediaOperation for similar functionality*/
476
- stopCurrentOperations?: boolean;
477
- /** The value to identify context of the operation. */
478
- operationContext?: string;
479
- /** Determines if we interrupt the prompt and start recognizing. */
480
- interruptPrompt?: boolean;
481
- /** Time to wait for first input after prompt. */
482
- initialSilenceTimeoutInSeconds?: number;
483
- /**
484
- * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.
485
- * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
486
- */
487
- operationCallbackUrl?: string;
488
- }
489
-
490
- /** The recognize configuration specific to Speech. */
491
- export declare interface CallMediaRecognizeSpeechOptions extends CallMediaRecognizeOptions {
492
- /** The length of end silence when user stops speaking and cogservice send response. */
493
- endSilenceTimeoutInSeconds?: number;
494
- /** Speech language to be recognized, If not set default is en-US */
495
- speechLanguage?: string;
496
- /** Endpoint where the custom model was deployed. */
497
- speechRecognitionModelEndpointId?: string;
498
- readonly kind: "callMediaRecognizeSpeechOptions";
499
- }
500
-
501
- /** The recognize configuration for Speech or Dtmf */
502
- export declare interface CallMediaRecognizeSpeechOrDtmfOptions extends CallMediaRecognizeOptions {
503
- /** The length of end silence when user stops speaking and cogservice send response. */
504
- endSilenceTimeoutInSeconds?: number;
505
- /** Time to wait between DTMF inputs to stop recognizing. */
506
- interToneTimeoutInSeconds?: number;
507
- /** List of tones that will stop recognizing. */
508
- stopDtmfTones?: DtmfTone[];
509
- /** Maximum number of DTMF tones to be collected. */
510
- maxTonesToCollect?: number;
511
- /** Speech language to be recognized, If not set default is en-US */
512
- speechLanguage?: string;
513
- /** Endpoint where the custom model was deployed. */
514
- speechRecognitionModelEndpointId?: string;
515
- readonly kind: "callMediaRecognizeSpeechOrDtmfOptions";
516
- }
517
-
518
- /** Contract model of an ACS call participant */
519
- export declare interface CallParticipant {
520
- /** Communication identifier of the participant */
521
- identifier?: CommunicationIdentifier;
522
- /** Is participant muted */
523
- isMuted?: boolean;
524
- /** Is participant on hold. */
525
- isOnHold?: boolean;
526
- }
527
-
528
- /** A call participant. */
529
- declare interface CallParticipantInternal {
530
- /** Communication identifier of the participant */
531
- identifier?: CommunicationIdentifierModel;
532
- /** Is participant muted */
533
- isMuted?: boolean;
534
- /** Is participant on hold. */
535
- isOnHold?: boolean;
536
- }
537
-
538
- /**
539
- * CallRecording class represents call recording related APIs.
540
- */
541
- export declare class CallRecording {
542
- private readonly callRecordingImpl;
543
- private readonly contentDownloader;
544
- private readonly callAutomationApiClient;
545
- constructor(endpoint: string, credential: KeyCredential | TokenCredential, options?: CallAutomationApiClientOptionalParams);
546
- /**
547
- * Starts a call recording with the specified options.
548
- * @param startCallRecordingRequest - options to start the call recording
549
- * @param options - Operation options.
550
- */
551
- start(options: StartRecordingOptions): Promise<RecordingStateResult>;
552
- /**
553
- * Returns call recording properties.
554
- * @param recordingId - The recordingId associated with the recording.
555
- * @param options - Additional request options contains getRecordingProperties api options.
556
- */
557
- getState(recordingId: string, options?: GetRecordingPropertiesOptions): Promise<RecordingStateResult>;
558
- /**
559
- * Stops a call recording.
560
- * @param recordingId - The recordingId associated with the recording.
561
- * @param options - Additional request options contains stopRecording api options.
562
- */
563
- stop(recordingId: string, options?: StopRecordingOptions): Promise<void>;
564
- /**
565
- * Pauses a call recording.
566
- * @param recordingId - The recordingId associated with the recording.
567
- * @param options - Additional request options contains pauseRecording api options.
568
- */
569
- pause(recordingId: string, options?: PauseRecordingOptions): Promise<void>;
570
- /**
571
- * Resumes a call recording.
572
- * @param recordingId - The recordingId associated with the recording.
573
- * @param options - Additional request options contains resumeRecording api options.
574
- */
575
- resume(recordingId: string, options?: ResumeRecordingOptions): Promise<void>;
576
- /**
577
- * Deletes a recording.
578
- * @param recordingLocationUrl - The recording location url. Required.
579
- * @param options - Additional request options contains deleteRecording api options.
580
- */
581
- delete(recordingLocationUrl: string, options?: DeleteRecordingOptions): Promise<void>;
582
- /**
583
- * Returns a stream with a call recording.
584
- * @param sourceLocationUrl - The source location url. Required.
585
- * @param options - Additional request options contains downloadRecording api options.
586
- */
587
- downloadStreaming(sourceLocationUrl: string, options?: DownloadRecordingOptions): Promise<NodeJS.ReadableStream>;
588
- /**
589
- * Downloads a call recording file to the specified stream.
590
- * @param sourceLocationUrl - The source location url. Required.
591
- * @param destinationStream - The destination stream. Required.
592
- * @param options - Additional request options contains downloadRecording api options.
593
- */
594
- downloadToStream(sourceLocationUrl: string, destinationStream: NodeJS.WritableStream, options?: DownloadRecordingOptions): Promise<void>;
595
- /**
596
- * Downloads a call recording file to the specified path.
597
- * @param sourceLocationUrl - The source location url. Required.
598
- * @param destinationPath - The destination path. Required.
599
- * @param options - Additional request options contains downloadRecording api options.
600
- */
601
- downloadToPath(sourceLocationUrl: string, destinationPath: string, options?: DownloadRecordingOptions): Promise<void>;
602
- }
603
-
604
- /**
605
- * Defines values for CallRejectReason. \
606
- * {@link KnownCallRejectReason} can be used interchangeably with CallRejectReason,
607
- * this enum contains the known values that the service supports.
608
- * ### Known values supported by the service
609
- * **none** \
610
- * **busy** \
611
- * **forbidden**
612
- */
613
- export declare type CallRejectReason = string;
614
-
615
- /**
616
- * The interface used as parent of [action]CallResult
617
- */
618
- declare interface CallResult {
619
- callConnectionProperties: CallConnectionProperties;
620
- callConnection: CallConnection;
621
- }
622
-
623
- /** Event when transfer request was successful. */
624
- export declare interface CallTransferAccepted extends Omit<RestCallTransferAccepted, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation" | "transferee" | "transferTarget"> {
625
- /** Call connection ID. */
626
- callConnectionId: string;
627
- /** Server call ID. */
628
- serverCallId: string;
629
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
630
- correlationId: string;
631
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
632
- resultInformation?: ResultInformation;
633
- /** Participant that was transferred away */
634
- transferee: CommunicationIdentifier;
635
- /** Target that transferee is transferred to */
636
- transferTarget: CommunicationIdentifier;
637
- /** kind of this event. */
638
- kind: "CallTransferAccepted";
639
- }
640
-
641
- /** Event when transfer request was failed. */
642
- export declare interface CallTransferFailed extends Omit<RestCallTransferFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
643
- /** Call connection ID. */
644
- callConnectionId: string;
645
- /** Server call ID. */
646
- serverCallId: string;
647
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
648
- correlationId: string;
649
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
650
- resultInformation?: ResultInformation;
651
- /** kind of this event. */
652
- kind: "CallTransferFailed";
653
- }
654
-
655
- /** The failed to cancel add participant event. */
656
- export declare interface CancelAddParticipantFailed extends Omit<RestCancelAddParticipantFailed, "callConnectionId" | "serverCallId" | "correlationId" | "invitationId" | "resultInformation"> {
657
- /** Call connection ID. */
658
- callConnectionId: string;
659
- /** Server call ID. */
660
- serverCallId: string;
661
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
662
- correlationId: string;
663
- /** Invitation ID used to cancel the add participant request. */
664
- invitationId: string;
665
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
666
- resultInformation?: ResultInformation;
667
- /** kind of this event. */
668
- kind: "CancelAddParticipantFailed";
669
- }
670
-
671
- /** Options for cancelling add participant request. */
672
- export declare interface CancelAddParticipantOperationOptions extends OperationOptions {
673
- /** The value to identify context of the operation. */
674
- operationContext?: string;
675
- /**
676
- * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.
677
- * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
678
- */
679
- operationCallbackUrl?: string;
680
- }
681
-
682
- /** The response payload for cancelling add participant request. */
683
- export declare interface CancelAddParticipantOperationResult {
684
- /** the invitation ID used to cancel the add participant request. */
685
- invitationId?: string;
686
- /** The operation context provided by client. */
687
- operationContext?: string;
688
- }
689
-
690
- /** Successful cancel add participant event. */
691
- export declare interface CancelAddParticipantSucceeded extends Omit<RestCancelAddParticipantSucceeded, "callConnectionId" | "serverCallId" | "correlationId" | "invitationId" | "resultInformation"> {
692
- /** Call connection ID. */
693
- callConnectionId: string;
694
- /** Server call ID. */
695
- serverCallId: string;
696
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
697
- correlationId: string;
698
- /** Invitation ID used to cancel the add participant request. */
699
- invitationId: string;
700
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
701
- resultInformation?: ResultInformation;
702
- /** kind of this event. */
703
- kind: "CancelAddParticipantSucceeded";
704
- }
705
-
706
- /** Channel affinity for a participant */
707
- export declare interface ChannelAffinity {
708
- /** Channel number to which bitstream from a particular participant will be written. */
709
- channel?: number;
710
- /**
711
- * The identifier for the participant whose bitstream will be written to the channel
712
- * represented by the channel number.
713
- */
714
- targetParticipant: CommunicationIdentifier;
715
- }
716
-
717
- export declare interface ChoiceResult {
718
- /** Label is the primary identifier for the choice detected */
719
- label?: string;
720
- /**
721
- * Phrases are set to the value if choice is selected via phrase detection.
722
- * If Dtmf input is recognized, then Label will be the identifier for the choice detected and phrases will be set to null
723
- */
724
- recognizedPhrase?: string;
725
- }
726
-
727
- /**
728
- * Defines values for CommunicationCloudEnvironmentModel. \
729
- * {@link KnownCommunicationCloudEnvironmentModel} can be used interchangeably with CommunicationCloudEnvironmentModel,
730
- * this enum contains the known values that the service supports.
731
- * ### Known values supported by the service
732
- * **public** \
733
- * **dod** \
734
- * **gcch**
735
- */
736
- declare type CommunicationCloudEnvironmentModel = string;
737
-
738
- /** Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. */
739
- declare interface CommunicationIdentifierModel {
740
- /** The identifier kind. Only required in responses. */
741
- kind?: CommunicationIdentifierModelKind;
742
- /** Raw Id of the identifier. Optional in requests, required in responses. */
743
- rawId?: string;
744
- /** The communication user. */
745
- communicationUser?: CommunicationUserIdentifierModel;
746
- /** The phone number. */
747
- phoneNumber?: PhoneNumberIdentifierModel;
748
- /** The Microsoft Teams user. */
749
- microsoftTeamsUser?: MicrosoftTeamsUserIdentifierModel;
750
- /** The Microsoft Teams application. */
751
- microsoftTeamsApp?: MicrosoftTeamsAppIdentifierModel;
752
- }
753
-
754
- /**
755
- * Defines values for CommunicationIdentifierModelKind. \
756
- * {@link KnownCommunicationIdentifierModelKind} can be used interchangeably with CommunicationIdentifierModelKind,
757
- * this enum contains the known values that the service supports.
758
- * ### Known values supported by the service
759
- * **unknown** \
760
- * **communicationUser** \
761
- * **phoneNumber** \
762
- * **microsoftTeamsUser** \
763
- * **microsoftTeamsApp**
764
- */
765
- declare type CommunicationIdentifierModelKind = string;
766
-
767
- /** A user that got created with an Azure Communication Services resource. */
768
- declare interface CommunicationUserIdentifierModel {
769
- /** The Id of the communication user. */
770
- id: string;
771
- }
772
-
773
- /**
774
- * Options to Connect request.
775
- */
776
- export declare interface ConnectCallOptions extends OperationOptions {
777
- /** Used by customers to correlate the request to the response event. */
778
- operationContext?: string;
779
- /** AI options for the call. */
780
- callIntelligenceOptions?: CallIntelligenceOptions;
781
- }
782
-
783
- /**
784
- * Connect call result
785
- */
786
- export declare type ConnectCallResult = CallResult;
787
-
788
- export declare interface ConnectFailed extends Omit<RestConnectFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
789
- /** Call connection ID. */
790
- callConnectionId: string;
791
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
792
- correlationId: string;
793
- /** Contains the resulting SIP code, sub-code and message. */
794
- resultInformation?: ResultInformation;
795
- /** kind of this event. */
796
- kind: "ConnectFailed";
797
- }
798
-
799
- /**
800
- * Options to continuous Dtmf recognition.
801
- */
802
- export declare interface ContinuousDtmfRecognitionOptions extends OperationOptions {
803
- /** The value to identify context of the operation. */
804
- operationContext?: string;
805
- /**
806
- * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.
807
- * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
808
- */
809
- operationCallbackUrl?: string;
810
- }
811
-
812
- /** Event sent when continuous Dtmf recognition stopped. */
813
- export declare interface ContinuousDtmfRecognitionStopped extends Omit<RestContinuousDtmfRecognitionStopped, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
814
- /** Call connection ID. */
815
- callConnectionId: string;
816
- /** Server call ID. */
817
- serverCallId: string;
818
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
819
- correlationId: string;
820
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
821
- resultInformation?: ResultInformation;
822
- /** kind of this event. */
823
- kind: "ContinuousDtmfRecognitionStopped";
824
- }
825
-
826
- /** Event sent when failed to recognize continuous Dtmf tone. */
827
- export declare interface ContinuousDtmfRecognitionToneFailed extends Omit<RestContinuousDtmfRecognitionToneFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
828
- /** Call connection ID. */
829
- callConnectionId: string;
830
- /** Server call ID. */
831
- serverCallId: string;
832
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
833
- correlationId: string;
834
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
835
- resultInformation?: ResultInformation;
836
- /** kind of this event. */
837
- kind: "ContinuousDtmfRecognitionToneFailed";
838
- }
839
-
840
- /** Event sent when Dtmf tone received from targeted participant in call. */
841
- export declare interface ContinuousDtmfRecognitionToneReceived extends Omit<RestContinuousDtmfRecognitionToneReceived, "sequenceId" | "tone" | "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
842
- /** The sequence id which can be used to determine if the same tone was played multiple times or if any tones were missed. */
843
- sequenceId: number;
844
- /** Defines values for Tone. */
845
- tone: Tone;
846
- /** Call connection ID. */
847
- callConnectionId: string;
848
- /** Server call ID. */
849
- serverCallId: string;
850
- /** Correlation ID for event to call correlation. Also called ChainId or skype chain ID. */
851
- correlationId: string;
852
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
853
- resultInformation?: ResultInformation;
854
- /** kind of this event. */
855
- kind: "ContinuousDtmfRecognitionToneReceived";
856
- }
857
-
858
- export declare interface CreateCallFailed extends Omit<RestCreateCallFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
859
- /** Call connection ID. */
860
- callConnectionId: string;
861
- /** Server call ID. */
862
- serverCallId: string;
863
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
864
- correlationId: string;
865
- /** Contains the resulting SIP code, sub-code and message. */
866
- resultInformation?: ResultInformation;
867
- /** kind of this event. */
868
- kind: "CreateCallFailed";
869
- }
870
-
871
- /**
872
- * Options to create a call.
873
- */
874
- export declare interface CreateCallOptions extends OperationOptions {
875
- /**
876
- * The source caller Id, a phone number, that's shown to the PSTN participant being invited.
877
- * Required only when calling a PSTN callee.
878
- */
879
- sourceCallIdNumber?: PhoneNumberIdentifier;
880
- /** Display name of the call if dialing out to a pstn number */
881
- sourceDisplayName?: string;
882
- /** The operation context. */
883
- operationContext?: string;
884
- /** AI options for the call. */
885
- callIntelligenceOptions?: CallIntelligenceOptions;
886
- }
887
-
888
- /**
889
- * CreateCall result
890
- */
891
- export declare type CreateCallResult = CallResult;
892
-
893
- /** Custom Calling Context */
894
- export declare type CustomCallingContext = (VoipHeader | SipUserToUserHeader | SipCustomHeader)[];
895
-
896
- declare interface CustomCallingContextHeader {
897
- key: string;
898
- value: string;
899
- }
900
-
901
- /**
902
- * Options to delete recording.
903
- */
904
- export declare type DeleteRecordingOptions = OperationOptions;
905
-
906
- /**
907
- * Options to download recording.
908
- */
909
- export declare interface DownloadRecordingOptions extends OperationOptions {
910
- /** Offset byte to start download from. */
911
- offset?: number;
912
- /** Max content length in bytes. */
913
- length?: number;
914
- }
915
-
916
- export declare interface DtmfResult {
917
- /** NOTE: This property will not be serialized. It can only be populated by the server. */
918
- readonly tones?: Tone[];
919
- }
920
-
921
- /** A Dtmf Tone. */
922
- export declare enum DtmfTone {
923
- /** Zero */
924
- Zero = "zero",
925
- /** One */
926
- One = "one",
927
- /** Two */
928
- Two = "two",
929
- /** Three */
930
- Three = "three",
931
- /** Four */
932
- Four = "four",
933
- /** Five */
934
- Five = "five",
935
- /** Six */
936
- Six = "six",
937
- /** Seven */
938
- Seven = "seven",
939
- /** Eight */
940
- Eight = "eight",
941
- /** Nine */
942
- Nine = "nine",
943
- /** A */
944
- A = "a",
945
- /** B */
946
- B = "b",
947
- /** C */
948
- C = "c",
949
- /** D */
950
- D = "d",
951
- /** Pound */
952
- Pound = "pound",
953
- /** Asterisk */
954
- Asterisk = "asterisk"
955
- }
956
-
957
- /** The FileSource model. */
958
- export declare interface FileSource extends PlaySource {
959
- url: string;
960
- readonly kind: "fileSource";
961
- }
962
-
963
- /**
964
- * Options to get call connection properties.
965
- */
966
- export declare type GetCallConnectionPropertiesOptions = OperationOptions;
967
-
968
- /**
969
- * Options to get a participant.
970
- */
971
- export declare type GetParticipantOptions = OperationOptions;
972
-
973
- /**
974
- * Options to get recording properties.
975
- */
976
- export declare type GetRecordingPropertiesOptions = OperationOptions;
977
-
978
- /**
979
- * Options to hang up the call
980
- */
981
- export declare type HangUpOptions = OperationOptions;
982
-
983
- export declare interface HoldFailed extends Omit<RestHoldFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
984
- /** Call connection ID. */
985
- callConnectionId: string;
986
- /** Server call ID. */
987
- serverCallId: string;
988
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
989
- correlationId: string;
990
- /** Contains the resulting SIP code, sub-code and message. */
991
- resultInformation?: ResultInformation;
992
- /** kind of this event. */
993
- kind: "HoldFailed";
994
- }
995
-
996
- /**
997
- * Options to hold participant.
998
- */
999
- export declare interface HoldOptions extends OperationOptions {
1000
- /** A PlaySource representing the source to play. */
1001
- playSource?: FileSource | TextSource | SsmlSource;
1002
- /** Operation Context. */
1003
- operationContext?: string;
1004
- /** Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation. */
1005
- operationCallbackUrl?: string;
1006
- }
1007
-
1008
- /** Known values of {@link CallRejectReason} that the service accepts. */
1009
- export declare enum KnownCallRejectReason {
1010
- /** None */
1011
- None = "none",
1012
- /** Busy */
1013
- Busy = "busy",
1014
- /** Forbidden */
1015
- Forbidden = "forbidden"
1016
- }
1017
-
1018
- /** The response payload for getting participants of the call. */
1019
- export declare interface ListParticipantsResult {
1020
- /** List of the current participants in the call. */
1021
- values?: CallParticipant[];
1022
- /** Continue of the list of participants */
1023
- nextLink?: string;
1024
- }
1025
-
1026
- /** A Microsoft Teams application. */
1027
- declare interface MicrosoftTeamsAppIdentifierModel {
1028
- /** The Id of the Microsoft Teams application. */
1029
- appId: string;
1030
- /** The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. */
1031
- cloud?: CommunicationCloudEnvironmentModel;
1032
- }
1033
-
1034
- /** A Microsoft Teams user. */
1035
- declare interface MicrosoftTeamsUserIdentifierModel {
1036
- /** The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. */
1037
- userId: string;
1038
- /** True if the Microsoft Teams user is anonymous. By default false if missing. */
1039
- isAnonymous?: boolean;
1040
- /** The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. */
1041
- cloud?: CommunicationCloudEnvironmentModel;
1042
- }
1043
-
1044
- /**
1045
- * Options to mute participant.
1046
- */
1047
- export declare interface MuteParticipantOption extends OperationOptions {
1048
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1049
- operationContext?: string;
1050
- }
1051
-
1052
- /** The response payload for muting participant from the call. */
1053
- export declare interface MuteParticipantResult {
1054
- /** The operation context provided by client. */
1055
- operationContext?: string;
1056
- }
1057
-
1058
- /**
1059
- * Helper function for parsing Acs callback events.
1060
- */
1061
- export declare function parseCallAutomationEvent(encodedEvents: string | Record<string, unknown>): CallAutomationEvent;
1062
-
1063
- /** Event when there was an update to participant(s). */
1064
- export declare interface ParticipantsUpdated extends Omit<RestParticipantsUpdated, "callConnectionId" | "serverCallId" | "correlationId" | "participants" | "resultInformation"> {
1065
- /** Call connection ID. */
1066
- callConnectionId: string;
1067
- /** Server call ID. */
1068
- serverCallId: string;
1069
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1070
- correlationId: string;
1071
- /** The list of participants in the call. */
1072
- participants: CallParticipant[];
1073
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
1074
- resultInformation?: ResultInformation;
1075
- /** kind of this event. */
1076
- kind: "ParticipantsUpdated";
1077
- }
1078
-
1079
- /**
1080
- * Options to get a pause a recording.
1081
- */
1082
- export declare type PauseRecordingOptions = OperationOptions;
1083
-
1084
- /** A phone number. */
1085
- declare interface PhoneNumberIdentifierModel {
1086
- /** The phone number in E.164 format. */
1087
- value: string;
1088
- }
1089
-
1090
- /** Event when Media play was canceled by Cancel operation. */
1091
- export declare interface PlayCanceled extends Omit<RestPlayCanceled, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
1092
- /** Call connection ID. */
1093
- callConnectionId: string;
1094
- /** Server call ID. */
1095
- serverCallId: string;
1096
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1097
- correlationId: string;
1098
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
1099
- resultInformation?: ResultInformation;
1100
- /** kind of this event. */
1101
- kind: "PlayCanceled";
1102
- }
1103
-
1104
- /** Event when Media play was successfully completed. */
1105
- export declare interface PlayCompleted extends Omit<RestPlayCompleted, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
1106
- /** Call connection ID. */
1107
- callConnectionId: string;
1108
- /** Server call ID. */
1109
- serverCallId: string;
1110
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
1111
- resultInformation?: ResultInformation;
1112
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1113
- correlationId: string;
1114
- /** kind of this event. */
1115
- kind: "PlayCompleted";
1116
- }
1117
-
1118
- /** Event when Media play was failed. */
1119
- export declare interface PlayFailed extends Omit<RestPlayFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
1120
- /** Call connection ID. */
1121
- callConnectionId: string;
1122
- /** Server call ID. */
1123
- serverCallId: string;
1124
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
1125
- resultInformation?: ResultInformation;
1126
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1127
- correlationId: string;
1128
- /** kind of this event. */
1129
- kind: "PlayFailed";
1130
- }
1131
-
1132
- /**
1133
- * Options to play audio.
1134
- */
1135
- export declare interface PlayOptions extends OperationOptions {
1136
- /** Determine if it is looping */
1137
- loop?: boolean;
1138
- /** The value to identify context of the operation. */
1139
- operationContext?: string;
1140
- /**
1141
- * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.
1142
- * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
1143
- */
1144
- operationCallbackUrl?: string;
1145
- }
1146
-
1147
- /** The PlaySource model. */
1148
- export declare interface PlaySource {
1149
- /** @deprecated Not in use, instead use playsourcecacheid for similar functionality*/
1150
- playsourcacheid?: string;
1151
- }
1152
-
1153
- /** Event when Media play was successfully started. */
1154
- export declare interface PlayStarted extends Omit<RestPlayStarted, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
1155
- /** Call connection ID. */
1156
- callConnectionId: string;
1157
- /** Server call ID. */
1158
- serverCallId: string;
1159
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1160
- correlationId: string;
1161
- /** Contains the resulting SIP code, sub-code and message. */
1162
- resultInformation?: ResultInformation;
1163
- /** kind of this event. */
1164
- kind: "PlayStarted";
1165
- }
1166
-
1167
- /**
1168
- * Options to playToAll audio.
1169
- */
1170
- export declare interface PlayToAllOptions extends PlayOptions {
1171
- /** If set play can barge into other existing queued-up/currently-processing requests. */
1172
- interruptCallMediaOperation?: boolean;
1173
- }
1174
-
1175
- /** A Recognition Choice */
1176
- export declare interface RecognitionChoice {
1177
- /** Identifier for a given choice */
1178
- label: string;
1179
- /** List of phrases to recognize */
1180
- phrases: string[];
1181
- tone?: DtmfTone;
1182
- }
1183
-
1184
- /**
1185
- * Defines values for RecognitionType. \
1186
- * {@link KnownRecognitionType} can be used interchangeably with RecognitionType,
1187
- * this enum contains the known values that the service supports.
1188
- * ### Known values supported by the service
1189
- * **dtmf** \
1190
- * **speech** \
1191
- * **choices**
1192
- */
1193
- export declare type RecognitionType = string;
1194
-
1195
- /** Event when Media recognize was canceled by Cancel operation. */
1196
- export declare interface RecognizeCanceled extends Omit<RestRecognizeCanceled, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
1197
- /** Call connection ID. */
1198
- callConnectionId: string;
1199
- /** Server call ID. */
1200
- serverCallId: string;
1201
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1202
- correlationId: string;
1203
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
1204
- resultInformation?: ResultInformation;
1205
- /** kind of this event. */
1206
- kind: "RecognizeCanceled";
1207
- }
1208
-
1209
- /** Event when Media recognize was successfully completed. */
1210
- export declare interface RecognizeCompleted extends Omit<RestRecognizeCompleted, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
1211
- /** Call connection ID. */
1212
- callConnectionId: string;
1213
- /** Server call ID. */
1214
- serverCallId: string;
1215
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
1216
- resultInformation?: ResultInformation;
1217
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1218
- correlationId: string;
1219
- /** kind of this event. */
1220
- kind: "RecognizeCompleted";
1221
- }
1222
-
1223
- /** Event when Media recognize was failed. */
1224
- export declare interface RecognizeFailed extends Omit<RestRecognizeFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
1225
- /** Call connection ID. */
1226
- callConnectionId: string;
1227
- /** Server call ID. */
1228
- serverCallId: string;
1229
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
1230
- resultInformation?: ResultInformation;
1231
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1232
- correlationId: string;
1233
- /** kind of this event. */
1234
- kind: "RecognizeFailed";
1235
- }
1236
-
1237
- /** The type of the recognition that the service accepts. */
1238
- export declare enum RecognizeInputType {
1239
- /** Dtmf */
1240
- Dtmf = "dtmf"
1241
- }
1242
-
1243
- /** The channel type of a call recording. */
1244
- export declare type RecordingChannel = "mixed" | "unmixed";
1245
-
1246
- /** The content type of a call recording. */
1247
- export declare type RecordingContent = "audio" | "audioVideo";
1248
-
1249
- /** The format type of a call recording. */
1250
- export declare type RecordingFormat = "mp3" | "mp4" | "wav";
1251
-
1252
- /** The format type of a call recording. */
1253
- export declare type RecordingKind = "azureCommunicationServices" | "teams" | "teamsCompliance";
1254
-
1255
- /**
1256
- * Defines values for RecordingKind. \
1257
- * {@link KnownRecordingKind} can be used interchangeably with RecordingKind,
1258
- * this enum contains the known values that the service supports.
1259
- * ### Known values supported by the service
1260
- * **AzureCommunicationServices**: Recording initiated by Azure Communication Services \
1261
- * **Teams**: Recording initiated by Teams user \
1262
- * **TeamsCompliance**: Recording initiated by Teams compliance policy
1263
- */
1264
- declare type RecordingKind_2 = string;
1265
-
1266
- /**
1267
- * Defines values for RecordingState. \
1268
- * {@link KnownRecordingState} can be used interchangeably with RecordingState,
1269
- * this enum contains the known values that the service supports.
1270
- * ### Known values supported by the service
1271
- * **active** \
1272
- * **inactive**
1273
- */
1274
- export declare type RecordingState = string;
1275
-
1276
- /** Event when Recording state has been changed. */
1277
- export declare interface RecordingStateChanged extends Omit<RestRecordingStateChanged, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
1278
- /** Call connection ID. */
1279
- callConnectionId: string;
1280
- /** Server call ID. */
1281
- serverCallId: string;
1282
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1283
- correlationId: string;
1284
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
1285
- resultInformation?: ResultInformation;
1286
- /** kind of this event. */
1287
- kind: "RecordingStateChanged";
1288
- }
1289
-
1290
- /** The response payload for starting a call recording or getting call recording state. */
1291
- export declare interface RecordingStateResult {
1292
- recordingId: string;
1293
- recordingKind: RecordingKind_2;
1294
- recordingState: RecordingState;
1295
- }
1296
-
1297
- /** The recording storage */
1298
- export declare interface RecordingStorage {
1299
- /** Defines the kind of recording storage */
1300
- recordingStorageKind: RecordingStorageKind;
1301
- /** Uri of a container or a location within a container */
1302
- recordingDestinationContainerUrl?: string;
1303
- }
1304
-
1305
- /** The storage type of a call recording. */
1306
- export declare type RecordingStorageKind = "azureCommunicationServices" | "azureBlobStorage";
1307
-
1308
- /**
1309
- * Options to redirect call.
1310
- */
1311
- export declare type RedirectCallOptions = OperationOptions;
1312
-
1313
- /**
1314
- * Options to reject call.
1315
- */
1316
- export declare interface RejectCallOptions extends OperationOptions {
1317
- /** The rejection reason. */
1318
- callRejectReason?: CallRejectReason;
1319
- }
1320
-
1321
- /** The failed to remove participant event. */
1322
- export declare interface RemoveParticipantFailed extends Omit<RestRemoveParticipantFailed, "callConnectionId" | "serverCallId" | "correlationId" | "participant" | "resultInformation"> {
1323
- /** Call connection ID. */
1324
- callConnectionId: string;
1325
- /** Server call ID. */
1326
- serverCallId: string;
1327
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1328
- correlationId: string;
1329
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
1330
- resultInformation?: ResultInformation;
1331
- /** The participant in the call. */
1332
- participant?: CommunicationIdentifier;
1333
- /** kind of this event. */
1334
- kind: "RemoveParticipantFailed";
1335
- }
1336
-
1337
- /** The response payload for removing participants from the call. */
1338
- export declare interface RemoveParticipantResult {
1339
- /** The operation context provided by client. */
1340
- operationContext?: string;
1341
- }
1342
-
1343
- /**
1344
- * Options to remove participants.
1345
- */
1346
- export declare interface RemoveParticipantsOption extends OperationOptions {
1347
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1348
- operationContext?: string;
1349
- /**
1350
- * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.
1351
- * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
1352
- */
1353
- operationCallbackUrl?: string;
1354
- }
1355
-
1356
- /** The participant successfully removed event. */
1357
- export declare interface RemoveParticipantSucceeded extends Omit<RestRemoveParticipantSucceeded, "callConnectionId" | "serverCallId" | "correlationId" | "participant" | "resultInformation"> {
1358
- /** Call connection ID. */
1359
- callConnectionId: string;
1360
- /** Server call ID. */
1361
- serverCallId: string;
1362
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1363
- correlationId: string;
1364
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
1365
- resultInformation?: ResultInformation;
1366
- /** The participant in the call. */
1367
- participant?: CommunicationIdentifier;
1368
- /** kind of this event. */
1369
- kind: "RemoveParticipantSucceeded";
1370
- }
1371
-
1372
- /** The failed to add participants event. */
1373
- export declare interface RestAddParticipantFailed {
1374
- /** Call connection ID. */
1375
- callConnectionId?: string;
1376
- /** Server call ID. */
1377
- serverCallId?: string;
1378
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1379
- correlationId?: string;
1380
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1381
- operationContext?: string;
1382
- /** Contains the resulting SIP code, sub-code and message. */
1383
- resultInformation?: RestResultInformation;
1384
- /** Participant */
1385
- participant?: CommunicationIdentifierModel;
1386
- }
1387
-
1388
- /** The participants successfully added event. */
1389
- export declare interface RestAddParticipantSucceeded {
1390
- /** Call connection ID. */
1391
- callConnectionId?: string;
1392
- /** Server call ID. */
1393
- serverCallId?: string;
1394
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1395
- correlationId?: string;
1396
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1397
- operationContext?: string;
1398
- /** Contains the resulting SIP code, sub-code and message. */
1399
- resultInformation?: RestResultInformation;
1400
- /** Participant */
1401
- participant?: CommunicationIdentifierModel;
1402
- }
1403
-
1404
- /** The failed to answer call event. */
1405
- export declare interface RestAnswerFailed {
1406
- /** Call connection ID. */
1407
- callConnectionId?: string;
1408
- /** Server call ID. */
1409
- serverCallId?: string;
1410
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1411
- correlationId?: string;
1412
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1413
- operationContext?: string;
1414
- /** Contains the resulting SIP code, sub-code and message. */
1415
- resultInformation?: RestResultInformation;
1416
- }
1417
-
1418
- /** The call connected event. */
1419
- export declare interface RestCallConnected {
1420
- /** Call connection ID. */
1421
- callConnectionId?: string;
1422
- /** Server call ID. */
1423
- serverCallId?: string;
1424
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1425
- correlationId?: string;
1426
- /** Used by customers to set the context for creating a new call. This property will be null for answering a call. */
1427
- operationContext?: string;
1428
- /** Contains the resulting SIP code, sub-code and message. */
1429
- resultInformation?: RestResultInformation;
1430
- }
1431
-
1432
- /** The call disconnected event. */
1433
- export declare interface RestCallDisconnected {
1434
- /** Call connection ID. */
1435
- callConnectionId?: string;
1436
- /** Server call ID. */
1437
- serverCallId?: string;
1438
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1439
- correlationId?: string;
1440
- /** Used by customers to set the context for creating a new call. This property will be null for answering a call. */
1441
- operationContext?: string;
1442
- /** Contains the resulting SIP code, sub-code and message. */
1443
- resultInformation?: RestResultInformation;
1444
- }
1445
-
1446
- /** The call transfer accepted event. */
1447
- export declare interface RestCallTransferAccepted {
1448
- /** Call connection ID. */
1449
- callConnectionId?: string;
1450
- /** Server call ID. */
1451
- serverCallId?: string;
1452
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1453
- correlationId?: string;
1454
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1455
- operationContext?: string;
1456
- /** Contains the resulting SIP code, sub-code and message. */
1457
- resultInformation?: RestResultInformation;
1458
- /** Target who the call is transferred to. */
1459
- transferTarget?: CommunicationIdentifierModel;
1460
- /** the participant who is being transferred away. */
1461
- transferee?: CommunicationIdentifierModel;
1462
- }
1463
-
1464
- /** The call transfer failed event. */
1465
- export declare interface RestCallTransferFailed {
1466
- /** Call connection ID. */
1467
- callConnectionId?: string;
1468
- /** Server call ID. */
1469
- serverCallId?: string;
1470
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1471
- correlationId?: string;
1472
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1473
- operationContext?: string;
1474
- /** Contains the resulting SIP code, sub-code and message. */
1475
- resultInformation?: RestResultInformation;
1476
- }
1477
-
1478
- /** Failed cancel add participant event. */
1479
- export declare interface RestCancelAddParticipantFailed {
1480
- /** Call connection ID. */
1481
- callConnectionId?: string;
1482
- /** Server call ID. */
1483
- serverCallId?: string;
1484
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1485
- correlationId?: string;
1486
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1487
- operationContext?: string;
1488
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
1489
- resultInformation?: RestResultInformation;
1490
- /** Invitation ID used to cancel the request. */
1491
- invitationId?: string;
1492
- }
1493
-
1494
- /** Successful cancel add participant event. */
1495
- export declare interface RestCancelAddParticipantSucceeded {
1496
- /** Call connection ID. */
1497
- callConnectionId?: string;
1498
- /** Server call ID. */
1499
- serverCallId?: string;
1500
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1501
- correlationId?: string;
1502
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1503
- operationContext?: string;
1504
- /** Invitation ID used to cancel the request. */
1505
- invitationId?: string;
1506
- /** Contains the resulting SIP code, sub-code and message. */
1507
- resultInformation?: RestResultInformation;
1508
- }
1509
-
1510
- /** The ConnectFailed event. */
1511
- export declare interface RestConnectFailed {
1512
- /** Call connection ID. */
1513
- callConnectionId?: string;
1514
- /** Server call ID. */
1515
- serverCallId?: string;
1516
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1517
- correlationId?: string;
1518
- /** Used by customers to correlate the request to the response event. */
1519
- operationContext?: string;
1520
- /** Contains the resulting SIP code, sub-code and message. */
1521
- resultInformation?: RestResultInformation;
1522
- }
1523
-
1524
- export declare interface RestContinuousDtmfRecognitionStopped {
1525
- /** Call connection ID. */
1526
- callConnectionId?: string;
1527
- /** Server call ID. */
1528
- serverCallId?: string;
1529
- /** Correlation ID for event to call correlation. */
1530
- correlationId?: string;
1531
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1532
- operationContext?: string;
1533
- /** Contains the resulting SIP code, sub-code and message. */
1534
- resultInformation?: RestResultInformation;
1535
- }
1536
-
1537
- export declare interface RestContinuousDtmfRecognitionToneFailed {
1538
- /** Call connection ID. */
1539
- callConnectionId?: string;
1540
- /** Server call ID. */
1541
- serverCallId?: string;
1542
- /** Correlation ID for event to call correlation. */
1543
- correlationId?: string;
1544
- /** Contains the resulting SIP code, sub-code and message. */
1545
- resultInformation?: RestResultInformation;
1546
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1547
- operationContext?: string;
1548
- }
1549
-
1550
- export declare interface RestContinuousDtmfRecognitionToneReceived {
1551
- /**
1552
- * The sequence id which can be used to determine if the same tone was played multiple times or if any tones were missed.
1553
- * NOTE: This property will not be serialized. It can only be populated by the server.
1554
- */
1555
- readonly sequenceId?: number;
1556
- tone?: Tone;
1557
- /** Call connection ID. */
1558
- callConnectionId?: string;
1559
- /** Server call ID. */
1560
- serverCallId?: string;
1561
- /** Correlation ID for event to call correlation. Also called ChainId or skype chain ID. */
1562
- correlationId?: string;
1563
- /** Contains the resulting SIP code, sub-code and message. */
1564
- resultInformation?: RestResultInformation;
1565
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1566
- operationContext?: string;
1567
- }
1568
-
1569
- /** The create call failed event. */
1570
- export declare interface RestCreateCallFailed {
1571
- /** Call connection ID. */
1572
- callConnectionId?: string;
1573
- /** Server call ID. */
1574
- serverCallId?: string;
1575
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1576
- correlationId?: string;
1577
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1578
- operationContext?: string;
1579
- /** Contains the resulting SIP code, sub-code and message. */
1580
- resultInformation?: RestResultInformation;
1581
- }
1582
-
1583
- export declare interface RestHoldFailed {
1584
- /** Call connection ID. */
1585
- callConnectionId?: string;
1586
- /** Server call ID. */
1587
- serverCallId?: string;
1588
- /** Correlation ID for event to call correlation. */
1589
- correlationId?: string;
1590
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1591
- operationContext?: string;
1592
- /** Contains the resulting SIP code, sub-code and message. */
1593
- resultInformation?: RestResultInformation;
1594
- }
1595
-
1596
- /** The participants updated in a call event. */
1597
- export declare interface RestParticipantsUpdated {
1598
- /** Call connection ID. */
1599
- callConnectionId?: string;
1600
- /** Server call ID. */
1601
- serverCallId?: string;
1602
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1603
- correlationId?: string;
1604
- /** The Sequence Number of the event */
1605
- sequenceNumber?: number;
1606
- /** The list of participants in the call. */
1607
- participants?: CallParticipantInternal[];
1608
- /** Contains the resulting SIP code, sub-code and message. */
1609
- resultInformation?: RestResultInformation;
1610
- }
1611
-
1612
- export declare interface RestPlayCanceled {
1613
- /** Call connection ID. */
1614
- callConnectionId?: string;
1615
- /** Server call ID. */
1616
- serverCallId?: string;
1617
- /** Correlation ID for event to call correlation. */
1618
- correlationId?: string;
1619
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1620
- operationContext?: string;
1621
- /** Contains the resulting SIP code, sub-code and message. */
1622
- resultInformation?: RestResultInformation;
1623
- }
1624
-
1625
- export declare interface RestPlayCompleted {
1626
- /** Call connection ID. */
1627
- callConnectionId?: string;
1628
- /** Server call ID. */
1629
- serverCallId?: string;
1630
- /** Correlation ID for event to call correlation. */
1631
- correlationId?: string;
1632
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1633
- operationContext?: string;
1634
- /** Contains the resulting SIP code, sub-code and message. */
1635
- resultInformation?: RestResultInformation;
1636
- }
1637
-
1638
- export declare interface RestPlayFailed {
1639
- /** Call connection ID. */
1640
- callConnectionId?: string;
1641
- /** Server call ID. */
1642
- serverCallId?: string;
1643
- /** Correlation ID for event to call correlation. */
1644
- correlationId?: string;
1645
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1646
- operationContext?: string;
1647
- /** Contains the resulting SIP code, sub-code and message. */
1648
- resultInformation?: RestResultInformation;
1649
- /** Contains the index of the failed play source. */
1650
- failedPlaySourceIndex?: number;
1651
- }
1652
-
1653
- /** Play started event. */
1654
- export declare interface RestPlayStarted {
1655
- /** Gets or sets call connection ID. */
1656
- callConnectionId?: string;
1657
- /** Gets or sets server call ID. */
1658
- serverCallId?: string;
1659
- /** Gets or sets correlation ID for event to call correlation. */
1660
- correlationId?: string;
1661
- /** Gets or sets used by customers when calling mid-call actions to correlate the request to the response event. */
1662
- operationContext?: string;
1663
- /** Gets or sets contains the resulting SIP code, sub-code and message. */
1664
- resultInformation?: RestResultInformation;
1665
- }
1666
-
1667
- export declare interface RestRecognizeCanceled {
1668
- /** Call connection ID. */
1669
- callConnectionId?: string;
1670
- /** Server call ID. */
1671
- serverCallId?: string;
1672
- /** Correlation ID for event to call correlation. */
1673
- correlationId?: string;
1674
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1675
- operationContext?: string;
1676
- /** Contains the resulting SIP code, sub-code and message. */
1677
- resultInformation?: RestResultInformation;
1678
- }
1679
-
1680
- export declare interface RestRecognizeCompleted {
1681
- /** Call connection ID. */
1682
- callConnectionId?: string;
1683
- /** Server call ID. */
1684
- serverCallId?: string;
1685
- /** Correlation ID for event to call correlation. */
1686
- correlationId?: string;
1687
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1688
- operationContext?: string;
1689
- /** Contains the resulting SIP code, sub-code and message. */
1690
- resultInformation?: RestResultInformation;
1691
- /**
1692
- * Determines the sub-type of the recognize operation.
1693
- * In case of cancel operation the this field is not set and is returned empty
1694
- */
1695
- recognitionType?: RecognitionType;
1696
- /** Defines the result for RecognitionType = Dtmf */
1697
- dtmfResult?: DtmfResult;
1698
- /** Defines the result for RecognitionType = Choices */
1699
- choiceResult?: ChoiceResult;
1700
- /**
1701
- * Defines the result for RecognitionType = Speech and SpeechOrDtmf
1702
- * NOTE: This property will not be serialized. It can only be populated by the server.
1703
- */
1704
- readonly speechResult?: SpeechResult;
1705
- }
1706
-
1707
- export declare interface RestRecognizeFailed {
1708
- /** Call connection ID. */
1709
- callConnectionId?: string;
1710
- /** Server call ID. */
1711
- serverCallId?: string;
1712
- /** Correlation ID for event to call correlation. */
1713
- correlationId?: string;
1714
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1715
- operationContext?: string;
1716
- /** Contains the resulting SIP code, sub-code and message. */
1717
- resultInformation?: RestResultInformation;
1718
- /** Contains the index of the failed play source. */
1719
- failedPlaySourceIndex?: number;
1720
- }
1721
-
1722
- export declare interface RestRecordingStateChanged {
1723
- /** Call connection ID. */
1724
- callConnectionId?: string;
1725
- /** Server call ID. */
1726
- serverCallId?: string;
1727
- /** Correlation ID for event to call correlation. */
1728
- correlationId?: string;
1729
- /**
1730
- * The call recording id
1731
- * NOTE: This property will not be serialized. It can only be populated by the server.
1732
- */
1733
- readonly recordingId?: string;
1734
- state?: RecordingState;
1735
- /**
1736
- * The time of the recording started
1737
- * NOTE: This property will not be serialized. It can only be populated by the server.
1738
- */
1739
- readonly startDateTime?: Date;
1740
- recordingKind?: RecordingKind_2;
1741
- /** Contains the resulting SIP code, sub-code and message. */
1742
- resultInformation?: RestResultInformation;
1743
- }
1744
-
1745
- /** The failed to remove participant event. */
1746
- export declare interface RestRemoveParticipantFailed {
1747
- /** Call connection ID. */
1748
- callConnectionId?: string;
1749
- /** Server call ID. */
1750
- serverCallId?: string;
1751
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1752
- correlationId?: string;
1753
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1754
- operationContext?: string;
1755
- /** Contains the resulting SIP code, sub-code and message. */
1756
- resultInformation?: RestResultInformation;
1757
- /** Participant */
1758
- participant?: CommunicationIdentifierModel;
1759
- }
1760
-
1761
- /** The participant removed event. */
1762
- export declare interface RestRemoveParticipantSucceeded {
1763
- /** Call connection ID. */
1764
- callConnectionId?: string;
1765
- /** Server call ID. */
1766
- serverCallId?: string;
1767
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1768
- correlationId?: string;
1769
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1770
- operationContext?: string;
1771
- /** Contains the resulting SIP code, sub-code and message. */
1772
- resultInformation?: RestResultInformation;
1773
- /** Participant */
1774
- participant?: CommunicationIdentifierModel;
1775
- }
1776
-
1777
- export declare interface RestResultInformation {
1778
- /** Code of the current result. This can be helpful to Call Automation team to troubleshoot the issue if this result was unexpected. */
1779
- code?: number;
1780
- /** Subcode of the current result. This can be helpful to Call Automation team to troubleshoot the issue if this result was unexpected. */
1781
- subCode?: number;
1782
- /** Detail message that describes the current result. */
1783
- message?: string;
1784
- }
1785
-
1786
- export declare interface RestSendDtmfTonesCompleted {
1787
- /** Call connection ID. */
1788
- callConnectionId?: string;
1789
- /** Server call ID. */
1790
- serverCallId?: string;
1791
- /** Correlation ID for event to call correlation. */
1792
- correlationId?: string;
1793
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1794
- operationContext?: string;
1795
- /** Contains the resulting SIP code, sub-code and message. */
1796
- resultInformation?: RestResultInformation;
1797
- }
1798
-
1799
- export declare interface RestSendDtmfTonesFailed {
1800
- /** Call connection ID. */
1801
- callConnectionId?: string;
1802
- /** Server call ID. */
1803
- serverCallId?: string;
1804
- /** Correlation ID for event to call correlation. */
1805
- correlationId?: string;
1806
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1807
- operationContext?: string;
1808
- /** Contains the resulting SIP code, sub-code and message. */
1809
- resultInformation?: RestResultInformation;
1810
- }
1811
-
1812
- export declare interface ResultInformation extends Omit<RestResultInformation, "code" | "subCode" | "message"> {
1813
- /** The error code. */
1814
- code: number;
1815
- /** The sub code of error. */
1816
- subCode: number;
1817
- /** The detailed message of the error. */
1818
- message: string;
1819
- }
1820
-
1821
- /**
1822
- * Options to resume recording.
1823
- */
1824
- export declare type ResumeRecordingOptions = OperationOptions;
1825
-
1826
- /** Event sent when Dtmf tones send successfully. */
1827
- export declare interface SendDtmfTonesCompleted extends Omit<RestSendDtmfTonesCompleted, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
1828
- /** Call connection ID. */
1829
- callConnectionId: string;
1830
- /** Server call ID. */
1831
- serverCallId: string;
1832
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1833
- correlationId: string;
1834
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
1835
- resultInformation?: ResultInformation;
1836
- /** kind of this event. */
1837
- kind: "SendDtmfTonesCompleted";
1838
- }
1839
-
1840
- /** Event sent when Dtmf tones send failed. */
1841
- export declare interface SendDtmfTonesFailed extends Omit<RestSendDtmfTonesFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
1842
- /** Call connection ID. */
1843
- callConnectionId: string;
1844
- /** Server call ID. */
1845
- serverCallId: string;
1846
- /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
1847
- correlationId: string;
1848
- /** Contains the resulting SIP code/sub-code and message from NGC services. */
1849
- resultInformation?: ResultInformation;
1850
- /** kind of this event. */
1851
- kind: "SendDtmfTonesFailed";
1852
- }
1853
-
1854
- /**
1855
- * Options to send Dtmf tones.
1856
- */
1857
- export declare interface SendDtmfTonesOptions extends OperationOptions {
1858
- /** The value to identify context of the operation. */
1859
- operationContext?: string;
1860
- /**
1861
- * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.
1862
- * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
1863
- */
1864
- operationCallbackUrl?: string;
1865
- }
1866
-
1867
- /** The response payload for sending DTMF tones. */
1868
- export declare interface SendDtmfTonesResult {
1869
- /** The operation context provided by client. */
1870
- operationContext?: string;
1871
- }
1872
-
1873
- /** SIP Custom header. */
1874
- export declare interface SipCustomHeader extends CustomCallingContextHeader {
1875
- kind: "sipx";
1876
- }
1877
-
1878
- /** SIP User To User header. */
1879
- export declare interface SipUserToUserHeader extends CustomCallingContextHeader {
1880
- kind: "sipuui";
1881
- }
1882
-
1883
- /** The speech status as a result. */
1884
- export declare interface SpeechResult {
1885
- /** The recognized speech in string. */
1886
- speech?: string;
1887
- }
1888
-
1889
- /** The SsmlSource model. */
1890
- export declare interface SsmlSource extends PlaySource {
1891
- ssmlText: string;
1892
- customVoiceEndpointId?: string;
1893
- readonly kind: "ssmlSource";
1894
- }
1895
-
1896
- /**
1897
- * Options to get a start a recording.
1898
- */
1899
- export declare interface StartRecordingOptions extends OperationOptions {
1900
- /** The call locator. */
1901
- callLocator: CallLocator;
1902
- /** The url to send notifications to. */
1903
- recordingStateCallbackEndpointUrl?: string;
1904
- /** The content type of call recording. */
1905
- recordingContent?: RecordingContent;
1906
- /** The channel type of call recording. */
1907
- recordingChannel?: RecordingChannel;
1908
- /** The format type of call recording. */
1909
- recordingFormat?: RecordingFormat;
1910
- /** Recording storage option. */
1911
- recordingStorage?: RecordingStorage;
1912
- /** Pause on start call recording option. */
1913
- pauseOnStart?: boolean;
1914
- /**
1915
- * The sequential order in which audio channels are assigned to participants in the unmixed recording.
1916
- * When 'recordingChannelType' is set to 'unmixed' and `audioChannelParticipantOrdering` is not specified,
1917
- * the audio channel to participant mapping will be automatically assigned based on the order in which participant
1918
- * first audio was detected. Channel to participant mapping details can be found in the metadata of the recording.
1919
- */
1920
- audioChannelParticipantOrdering?: CommunicationIdentifier[];
1921
- /**
1922
- * The channel affinity of call recording
1923
- * When 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified, 'channel' will be automatically assigned.
1924
- * Channel-Participant mapping details can be found in the metadata of the recording.
1925
- */
1926
- channelAffinity?: ChannelAffinity[];
1927
- }
1928
-
1929
- /**
1930
- * Options to get a stop a recording.
1931
- */
1932
- export declare type StopRecordingOptions = OperationOptions;
1933
-
1934
- /** The TextSource model. */
1935
- export declare interface TextSource extends PlaySource {
1936
- text: string;
1937
- sourceLocale?: string;
1938
- voiceKind?: VoiceKind;
1939
- voiceName?: string;
1940
- customVoiceEndpointId?: string;
1941
- readonly kind: "textSource";
1942
- }
1943
-
1944
- /**
1945
- * Defines values for Tone. \
1946
- * {@link KnownTone} can be used interchangeably with Tone,
1947
- * this enum contains the known values that the service supports.
1948
- * ### Known values supported by the service
1949
- * **zero** \
1950
- * **one** \
1951
- * **two** \
1952
- * **three** \
1953
- * **four** \
1954
- * **five** \
1955
- * **six** \
1956
- * **seven** \
1957
- * **eight** \
1958
- * **nine** \
1959
- * **a** \
1960
- * **b** \
1961
- * **c** \
1962
- * **d** \
1963
- * **pound** \
1964
- * **asterisk**
1965
- */
1966
- export declare type Tone = string;
1967
-
1968
- /** The response payload for transferring the call. */
1969
- export declare interface TransferCallResult {
1970
- /** The operation context provided by client. */
1971
- operationContext?: string;
1972
- }
1973
-
1974
- /**
1975
- * Options to transfer participants.
1976
- */
1977
- export declare interface TransferCallToParticipantOptions extends OperationOptions {
1978
- /** Used by customers when calling mid-call actions to correlate the request to the response event. */
1979
- operationContext?: string;
1980
- /**
1981
- * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.
1982
- * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
1983
- */
1984
- operationCallbackUrl?: string;
1985
- /** Transferee is the participant who is transferred away. */
1986
- transferee?: CommunicationIdentifier;
1987
- /** Used by customer to send custom context to targets. */
1988
- customCallingContext?: CustomCallingContext;
1989
- /** The source caller Id, a phone number, that's will be used as the transferor's(Contoso) caller id when transfering a call a pstn target. */
1990
- sourceCallIdNumber?: PhoneNumberIdentifier;
1991
- }
1992
-
1993
- /**
1994
- * Options to Unhold participant.
1995
- */
1996
- export declare interface UnholdOptions extends OperationOptions {
1997
- /** Operation Context. */
1998
- operationContext?: string;
1999
- }
2000
-
2001
- /** Defines values for VoiceKind that the service accepts. */
2002
- export declare enum VoiceKind {
2003
- /** Male */
2004
- Male = "male",
2005
- /** Female */
2006
- Female = "female"
2007
- }
2008
-
2009
- /** VOIP header. */
2010
- export declare interface VoipHeader extends CustomCallingContextHeader {
2011
- kind: "voip";
2012
- }
2013
-
2014
- export { }