Datasheet

Acano X Series Server and Virtualized Deployments
Acano Solution R1.6: Support FAQs 76-1022-08-K
Page 24
For a full description of the API methods and the features that can be set for each profile see the
API Reference for R1.2.
How do I set up host and guest access?
An accessMethod is a way of adding additional ways for users to dial in to a coSpace with
associated callLegProfiles that apply a certain configuration to the participant. One classic
example of this is to set up a host/guest configuration so that depending on what URI &
passcode is used participants are either assigned the ‘host’ profile or the ‘guest’ profile which
might make them wait for a host to join the meeting before their own call leg is activated and
then they are disconnect when the host leaves (for example).
One way to implement this is to use the coSpace URI for the guest(s) and assign a ‘guest’
callLegProfile to the coSpace. Then use the API to add an accessMethod which defines the URI
for the host(s) to dial in to and associate a callLegProfile with it. For example:
Action
Method
URI
Body data
Result
Create host
callLegProfile
POST
https://acanoServer/api/
v1/callLegProfiles
defaultLayout=True
callLegProfile with
id 93e6ec12-44f6-
4a29-ad3b-
6eebe1cfd917 is
created
Create guest
callLegProfile
POST
https://acanoServer/api/
v1/callLegProfiles
needsActivation=true&
defaultLayout=speakerOnly&
rxAudioMute=true&
deactivationMode=deactivate
callLegProfile with
id 6eebbc8c-c69c-
43f0-8f5d-
2349837839a2 is
created
Associate guest
callLegProfile
with coSpace
PUT
https://acanoServer/api/
v1/coSpaces|/<coSpace
ID>
callLegProfile=6eebbc8c-c69c-43f0-
8f5d-2349837839a2
Guest profile is
used when
coSpace URI is
dialed
Create host
accessMethod
on coSpace
POST
https://acanoServer/api/
v1/coSpaces/<coSpace
ID>/accessMethods
uri=20991&callLegProfile=93e6ec12
-44f6-4a29-ad3b-
6eebe1cfd917&callID=20991
Users can dial
20991 to access
the coSpace with
host privileges
Because the guest callLegProfile has needsActivation=True, any guest’s call leg will not be
started until a participant who does not have needsActivation enabled joins the coSpace; in this
case a participant using the host callLegProfile.
How do I enforce encryption for a coSpace?
You need to use the API:
1. Create a calLegProfile and set the parameter sipMediaEncryption to required.
a. Use the POST method, e.g. to https://<server IP address>/api/v1/callLegProfiles, with
the body as sipMediaEncryption=required.
2. Find the ID of this new callLegProfile.
a. Use the GET method, e.g. to https://<server IP address>/api/v1/callLegProfiles.
3. Find the ID of the coSpace that you want to enforce encryption on.