Call handling API - Inline documentation expanded #68
Conversation
stroncoso-quobis
requested review from
sushanthmavenir and
pradeepachar-mavenir
as code owners
There was a problem hiding this comment.
Hi there - great updates on the documentation - I now understand enough to write an app with it.
I have suggested some wording changes for consistency, using "call" in gerneral, but "session" when actualyl referring to the API operations.
Also some questions on the mandatory parameters ,one of which seems to be overlapping with the CAMARA x-correlator.
if these parameters are imposed by the WebRTC standard, alternatively, an implementation of this CAMARA WebRTC APi could take care of putting them, rather than burdening the app developer.
with that, approve this PR so you can progress on the release - thanks a lot for all your effort :-)
| API to create 1-1 voice and video sessions. These, identified by a unique `vvoipSessionId` | ||
| can be recovered, updated and terminated via this API and its methods. | ||
| This API provides REST API for clients to manage live audio and video sessions | ||
| towards the operator's network (IMS network). |
There was a problem hiding this comment.
I would simplify and change
"towards the operator's network (IMS network)."
to
"over the network they are attached to."
|
|
||
| The first point, *identify the endpoints* is solved in CAMARA via direct API | ||
| parameters on the API request. The later, *negotiate how to connect* is solved | ||
| sharing SDP information between peers. |
There was a problem hiding this comment.
suggest to replace by
"sharing descriptive information about the session between the clients using a well-know protocol:. SDP (Session Description Protocol)
| This API provides REST API for clients to manage live audio and video sessions | ||
| towards the operator's network (IMS network). | ||
|
|
||
| To handle audio/video sessions, what we usually known as *calls*, the network |
There was a problem hiding this comment.
| To handle audio/video sessions, what we usually known as *calls*, the network | |
| To handle audio/video sessions, what we usually know as *calls*, the network |
| it is required to define *how* to send media from one endpoint to the other. | ||
|
|
||
| The first point, *identify the endpoints* is solved in CAMARA via direct API | ||
| parameters on the API request. The later, *negotiate how to connect* is solved |
There was a problem hiding this comment.
| parameters on the API request. The later, *negotiate how to connect* is solved | |
| parameters on the API request. The latter, *negotiate how to connect* is solved |
| - Functional: | ||
| - Ability to create audio and video sessions on the network, this grants | ||
| ability to reach any phone number on the public network using your telco | ||
| provider rights. |
|
|
||
| When you have a voice/video session in progress, you can decide to finish the | ||
| call, to do so, simply execute a DELETE command over the endpoint using the | ||
| `vvoipSessionId` obtained on call creation. |
There was a problem hiding this comment.
| `vvoipSessionId` obtained on call creation. | |
| `vvoipSessionId` obtained on session creation. |
| three-legged access tokens is mandatory. This ensures that the API remains | ||
| in compliance with privacy regulations, upholding the principles of | ||
| transparency and user-centric privacy-by-design. | ||
|
|
||
| contact: |
|
|
||
| CAMARA `webrtc-call-handling` API requires basic usage of the WebRTC API to create | ||
| calls. To put it simply, you need to obtain and create an `SDP`(Session Description | ||
| Protocol) body to use in the call creation. |
There was a problem hiding this comment.
| Protocol) body to use in the call creation. | |
| Protocol) body to use in the session creation. |
| That technology becomes responsible of most our common real-time communications on | ||
| the web nowadays, from broadcasting to video conference solutions. | ||
|
|
||
| The `RTCPeerConnection` interface, provides an `SDP`that is required by our CAMARA |
There was a problem hiding this comment.
| The `RTCPeerConnection` interface, provides an `SDP`that is required by our CAMARA | |
| The `RTCPeerConnection` interface, provides an `SDP` that is required by our CAMARA |
| ``` | ||
|
|
||
| Since there is a delay between the request and the creation of the peer connection | ||
| we can start the call creation using POST, and update the session using PUT and |
There was a problem hiding this comment.
| we can start the call creation using POST, and update the session using PUT and | |
| we can start the session creation using POST, and update the session using PUT and |
|
I guess it merged automatically, please do che my comments and in particular remove the "contact" field form the spec. |
Hi @tanjadegroot, sorry, yes we merged it automatically since we are really worried by the deadlines. I will take your suggestion to remove contact on #62 (release candidate PR) and cover the other documentation suggestions on a separate PR. Check commit cbb1e68 Thanks a lot for the feedback! |
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
Which issue(s) this PR fixes:
Part of #60 , #63 and #50
Special notes for reviewers:
Information included was aligned with PR#62 (release review) comments and working team discussions.
It was removed channelId as agreed at PR#65
Changelog input
Additional documentation