Azure
[ACS - Call Automation] [Beta2] Api spec for 2023-06-15-preview
Data Plane API - Pull Request
Azure Communication Services Call Automation provides developers the ability to build server-based, intelligent call workflows, and call recording for voice and PSTN channels.
Following features are already exist in GA ACS's Call Automation:
API Info: The Basics
CreateCall: Allows you to create a new outbound call. Once given information (target of the call, such as their phone number), Call Automation service will call the target end try to establish a call.
AnswerCall: Answer incoming call. This is another way to establish a call. For example, you can purchase Direct Offering phone number from Azure Portal to answer incoming call with Call Automation for that phone number.
CallConnectionId: CallConnectionId is returned when you establish a call with either Create or Answer above. This Id is to be used to do subsequent actions for the call. For example, if I want to play a media file in the call, pass both CallConnectionId and media file endpoint. Call Automation service will play the media file in the call.
Callback Events: Because of nature of a phone call, during the call, Call Automation Service will send back asynchronous events to notify the state of the call. Such as CallConnected and ParticipantsUpdated event.
PlayCompleted Events: This is the event that being received when play audio file to participants is successful and completed.
RecognizeCompleted Events: This is the event that being received when the recognized dtmf tone is completed.
Callback Uri: Expanding above Callback events - here is an example. When you CreateCall, you will get response of 201 right after Call Automation service received the request. However, this does not mean the call is established. It is dialing. Once the target call receiver answers their phone, the call is established and CallConnected event is sent. This event is sent back as Webhook to CallbackURi provided in CreateCall/AnswerCall.
Play Audio File: Plays audio file to participants in the call.
Recognize Dtmf: Recognize Dtmf input tone from call.
Is this review for (select one):
- [ ] a private preview
- [x] a public preview
- [ ] GA release
Change Scope
This is Public Preview release. See previous GA Pull Request here: https://github.com/Azure/azure-rest-api-specs/pull/23091
- Design Document
- Hero Scenarios
- API Spec Document
- Previous Open API Doc
- Specs comparison of GA and Beta2
- Updated paths: BYO Cogsvc changes for Answer/CreateCall, Mute API, Recognize Choices, Recognize Speech/SpeechOrDtmf, Continuous Dtmf Subscription, SendDtmf, Play TTS(Text To Speech), Play SSML(Speech Synthesis Markup Language)
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
- 💬 Teams Channel
Click here for links to tools, specs, guidelines & other good stuff
Tooling
- Open API validation tools were run on this PR. Go here to see how to fix errors
- Spectral Linting
- Open API Hub
Guidelines & Specifications
Helpful Links
Hi, @fhaghbin-msft Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 162 Warnings warning [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| communicationservicescallautomation.json | 2023-06-15-preview(c88c6a0) | 2023-03-06(main) |
| communicationservicescallautomation.json | 2023-06-15-preview(c88c6a0) | 2022-04-07-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 2 Errors, 28 Warnings failed [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-2023-06-15-preview | package-2023-06-15-preview(c88c6a0) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger pipeline restarted successfully, please wait for status update in this comment.
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Swagger | communication-data-plane-CallAutomation | https://apiview.dev/Assemblies/Review/5d22f0b1fc2840ffb6313da4cc8fcdd0 |
Hi @fhaghbin-msft, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
Hi @fhaghbin-msft! Your PR has some issues. Please fix the CI issues, if present, in following order: Avocado, SemanticValidation, ModelValidation, Breaking Change, LintDiff.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic Validation | Fix-SemanticValidation-Error | High |
| Model Validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | High |
If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel.
No commit pushedDate could be found for PR 24482 in repo Azure/azure-rest-api-specs
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
No commit pushedDate could be found for PR 24482 in repo Azure/azure-rest-api-specs
@mikekistler I just had a meeting with this team, and they need another approver ASAP. Can you please approve this now?
