An accessMethod is a way of adding additional ways for users to dial in to a space with associated callLegProfiles that apply a certain configuration to the participant. One typical example of this is to set up a host/guest configuration so that depending on what URI and passcode are used, participants are either assigned the ‘host’ profile or the ‘guest’ profile. For example, a participant assigned a 'guest' profile might have to wait for a host to join the meeting before their own call leg is activated and then be disconnected when the host leaves.
One way to implement this is to use the space URI for the guest(s) and assign a ‘guest’ callLegProfile to the space. 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. The following example assumes host and guest access is setup on a space with id ccccc-ccccc. (Note that the API object for spaces is coSpaces.)
Action | Method | URI | Body data | Result |
Create host callLegProfile | POST | https://ciscoServer/api/ v1/callLegProfiles |
needsActivation=false& |
callLegProfile with id aaaaa-aaaaa is created |
Create guest callLegProfile | POST | https://ciscoServer/api/ v1/callLegProfiles |
needsActivation=true& defaultLayout=speakerOnly& |
callLegProfile with id bbbbb-bbbbb is created |
Associate guest callLegProfile with coSpace | PUT | https://ciscoServer/api/ v1/coSpaces/ccccc-ccccc |
callLegProfile=bbbbb-bbbbb | Guest profile is used when coSpace URI is dialed |
Create host accessMethod on coSpace | POST | https://ciscoServer/api/ v1/coSpaces/ccccc-ccccc/accessMethods |
uri=10100&callLegProfile=aaaa-aaaaa&callID=10100 |
Users can dial 10100 to access the coSpace with host privileges |
Setting the guest callLegProfile to needsActivation=true
, means any guest’s call leg will not be started until a participant joins the coSpace who does not have needsActivation enabled; in this case a participant using the host callLegProfile.
- Last update:
- 09-Sep-2020
- FAQ ID:
- 1068