The screen layout on SIP endpoints can be changed using DTMF. Note that this feature only applies to SIP endpoints and not to the participant layout on the Cisco Meeting App. 

To enable changing screen layouts on SIP endpoints using DTMF, you need to configure the following using the API:

• Create  a DTMF profile or edit a profile that you already have. This is done on the node: https://<webadmin>/api/v1/dtmfprofiles . Configure DTMF tones for ‘next layout’ and ‘previous layout’. For example, configure ‘8’ in ‘next layout’ and ‘2’ for ‘previous layout’.
• Create or modify the Call Leg Profile. This is done on the node: https://<webadmin>/api/v1/callLegProfiles . To add permissions to use DTMF in the callLegProfile, modify the parameter ‘changeLayoutAllowed’ and set it to true.
• Also modify the callLegProfile and configure a ‘defaultLayout’ from the following available options:
• allEqual
• stacked
• telepresence
• speaker only
• allEqualQuarters
• allEqualNinths
• allEqualSixteenths
• allEqualTwentyFifths
• onePlusFive
• onePlusSeven
• onePlusNine
• automatic
• onePlusN

For information on these screen layouts, see this FAQ.

•  Apply the dtmfProfile on the /system/profile global node or to a particular tenant on /tenant/<tenant id> node.
• Similarly, apply the callLegProfile on global system, or tenant, or space, or access method.

Changing layouts using DTMF:

• Use 2 or 8 (or whichever number you configured in the DTMF profile)  to move between the layouts from your SIP endpoint’s keypad.  
• The layouts scroll through in order: 'allEqual', 'stacked', 'telepresence','speaker only', 'onePlusN', defaultLayout.

• If defaultLayout='allEqualNinths' then the order is 'allEqual', 'stacked', 'telepresence', 'speaker only', 'onePlusN', 'allEqualNinths'.
• If the defaultLayout is set to one of the other layouts then only 5 layouts will be in the cycle. For example: if defaultLayout='allEqual' then the order is 'allEqual', 'stacked ', 'telepresence', ' speakerOnly', 'onePlusN'.

How to check which layout is in use:

• You can easily check which layout is currently applied to a particular call leg using the API.
• First, find out the callLeg id by doing a GET call on: https://<webadmin>/api/v1/callLegs
• Once you have found out the callLeg id from the previous call, do a second GET call on the specific id: https://<webadmin>/api/v1/callLegs/<callLegID>
• In the output of this call, you should find the following information. The ‘chosenlayout’ is the layout that has been requested by the participant via DTMF tones and the ‘defaultLayout’ is what is configured on the callLegProfile:

<configuration>       
       <chosenLayout> allEqual</chosenLayout>
       <defaultLayout>allEqualQuarters</defaultLayout>
       <changeLayoutAllowed>true</changeLayoutAllowed>   
</configuration>

• If you now press 8 or 2, and resend another GET call on the above node, you should see the chosenLayout change to the next layout. For example:

                <configuration>
                   <chosenLayout>stacked</chosenLayout>
                   <defaultLayout>allEqualQuarters</defaultLayout>
                   <changeLayoutAllowed>true</changeLayoutAllowed>
                </configuration> 

Last update:

04-Apr-2018

FAQ ID:

1256