Call Automation Api spec for 2023-10-15 (GA2) #25624
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| communicationservicescallautomation.json | 2023-10-15(1fe6a37) | 2023-03-06(main) |
| communicationservicescallautomation.json | 2023-10-15(1fe6a37) | 2023-06-15-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 2 Errors, 32 Warnings failed [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2023-10-15 | package-2023-10-15(1fe6a37) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 30 items are listed, please refer to log for more details.
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.
️️✔️SwaggerAPIView 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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
vivekmore-msft
changed the title
vivekmore-msft
requested review from
tg-msft and
weidongxu-microsoft
and removed request for
a team
abhishesingh-msft
approved these changes
Sep 21, 2023
* API review fixes and added custom context * Fixed Json error * Updated CustomContext description
...ication/data-plane/CallAutomation/stable/2023-10-15/communicationservicescallautomation.json
Show resolved
Hide resolved
weidongxu-microsoft
approved these changes
Oct 30, 2023
...ication/data-plane/CallAutomation/stable/2023-10-15/communicationservicescallautomation.json
Show resolved
Hide resolved
vivekmore-msft
removed request for
circy9,
kjeur,
Sandido,
dkulkarni-ms,
haagha,
MS-syh2qs,
grizzlytheodore,
yangyuan,
jorinmejia,
yunheMsft,
jessicl-ms,
t-bzhan,
wilcobmsft,
asarkar84,
wiboris,
dpwatrous,
skapur12,
cRui861,
wanghoppe,
orieldar and
jingjlii
|
Hi @anuchandy , can you the Approved-LintDiff label to this PR please? Existing Call Automation API methods did not use "x-ms-long-running-operation" so it was not added either to the new method. |
weidongxu-microsoft
added
the
APIStewardshipBoard-SignedOff
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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):
Change Scope
This is GA release. See previous Beta Pull Request here: #24482
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
❔Got questions? Need additional info?? We are here to help!
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.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links
fix #25626
fix #25626