This command returns the group name given the alias name.

API Parameter Table

Parameter Name Type Mandatory Default Value Description
aliasName string true null The alias alternative to the group name

API Call Template

getGroupNameByAlias aliasName=<groupAliasName>

Sample API Call

getGroupNameByAlias aliasName=testGroupAlias

Success Response in JSON

	"edges":[ ],
"description":"Group name",

JSON Response

The JSON response contains the following details:

  • data – The data to parse.
    • aliasName – The alias alternative to the localStreamName
    • groupName – The assigned groupName where alias is applied
  • description – Describes the result of parsing/executing the command
  • status – SUCCESS if the command was parsed and executed successfully, FAIL if not.


  • hasStreamAliases in config.lua should be TRUE