XIQS Create SIP Device Group

{{XIQS Command|XIQS Create SIP Device Group|SIP Device Group Management|
cmdname=createXIQSVoipDvcGroup|
cmdparams=''String'' name , [ ''Long'' id_device ] , ''Integer'' devicetype [, ''Long'' '''id_partition''' ]|
description=Create device group. This command will create empty group. Devices are added into group using [[ XIQS Add Device to SIP Device Group| addXIQSVoipDvcGroup ]] function<br>
}}

{{XIQS Parameters|
;''String'' name
:Group name
;[ ''Long'' id_device ]
:''Optional'': an ISC/ICM id to link this group. Not mandatory when group type is "ISC cluster" (9)
;''Integer'' devicetype
:Group type. Can be one of <ul><li>Gateway - 1</li><li>Endpoint - 3</li><li>Trunk - 5</li><li>ISC cluster - 9</li></ul>''Note'': when no ''id_device'' is specified, the ''devicetype'' can only be "ISC Cluster" (9).
;[ ''Long'' '''id_partition''' ]
:Partition Id - Mandatory when current user is administrator.
}}

{{XIQS Return|
:{{XIQS Return Param|Integer|ok (<nowiki>=1</nowiki>)|}}
|
*ERR_SRV_INTERNAL(500) [[XIQS ERROR MESSAGES|ERR_MSG_NO_DB]]
}}

{| class="wikitable collapsible" style="width: 100%;background-color:#EFEEFE;" border="1"    
! See Also    
|-     
|   
[[ XIQS Add Device to SIP Device Group| addXIQSVoipDvcGroup ]]<br>   
|}

{| class="wikitable collapsible" style="width: 100%;background-color:#EFEEFE;" border="1"    
! Example
|-     
|   
<font color="blue">Create GSM Device Group<br>
This command will create group of gsm devices (type=1), whose name is GsmDeviceGroupName which will use ISC with ID=21 on partition 3</font><br>
<?xml version="1.0" encoding="UTF-8"><br>
<command tid="0001" name="<b> createXIQSVoipDvcGroup </b>"><br>
&nbsp;&nbsp;<param type="string">GsmDeviceGroupName</param><br>
&nbsp;&nbsp;<param type="long">21</param><br>
&nbsp;&nbsp;<param type="integer">1</param><br>
&nbsp;&nbsp;<param type="long">3</param><br>
</command><br><br>
<font color="green">[ANSWER (OK)]<br>Group created with ID=25</font><br>
<?xml version="1.0" encoding="UTF-8"?><br>
<event type="return" tid="0001"><br>
&nbsp;&nbsp;<meta-data><br>
&nbsp;&nbsp;&nbsp;&nbsp;<meta-value><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<name>id</name><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<pos>1</pos><br>
&nbsp;&nbsp;&nbsp;&nbsp;</meta-value><br>
&nbsp;&nbsp;</meta-data><br>
&nbsp;&nbsp;<param type="long">25</param><br>
</event><br>
<br>
<font color="blue">Create Endpoint Group<br>
This command will create group of endpoints (type=3), whose name is EndpointGroupName. ISC ID is not important for this group type, so it is set to 0. Group is created on partition 3</font><br>
<?xml version="1.0" encoding="UTF-8"><br>
<command tid="0002" name="<b> createXIQSVoipDvcGroup </b>"><br>
&nbsp;&nbsp;<param type="string"> EndpointGroupName </param><br>
&nbsp;&nbsp;<param type="long">0</param><br>
&nbsp;&nbsp;<param type="integer">3</param><br>
&nbsp;&nbsp;<param type="long">3</param><br>
</command><br><br>
<font color="green">[ANSWER (OK)]<br>Endpoint Group created with ID=17</font><br>
<?xml version="1.0" encoding="UTF-8"?><br>
<event type="return" tid="0002"><br>
&nbsp;&nbsp;<meta-data><br>
&nbsp;&nbsp;&nbsp;&nbsp;<meta-value><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<name>id</name><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<pos>1</pos><br>
&nbsp;&nbsp;&nbsp;&nbsp;</meta-value><br>
&nbsp;&nbsp;</meta-data><br>
&nbsp;&nbsp;<param type="long">17</param><br>
</event><br>
<br>
<font color="blue">Create VoIP Trunk Group<br>
This command will create group of VoIP Trunks (type=5), whose name is VoIPTrunkGroupName. ISC ID is not important for this group type, so it is set to 0. Group is created on partition 3</font><br>
<?xml version="1.0" encoding="UTF-8"><br>
<command tid="0003" name="<b> createXIQSVoipDvcGroup </b>"><br>
&nbsp;&nbsp;<param type="string"> VoIPTrunkGroupName </param><br>
&nbsp;&nbsp;<param type="long">0</param><br>
&nbsp;&nbsp;<param type="integer">5</param><br>
&nbsp;&nbsp;<param type="long">3</param><br>
</command><br><br>
<font color="green">[ANSWER (OK)]<br>VoIP Trunk Group created with ID=7</font><br>
<?xml version="1.0" encoding="UTF-8"?><br>
<event type="return" tid="0003"><br>
&nbsp;&nbsp;<meta-data><br>
&nbsp;&nbsp;&nbsp;&nbsp;<meta-value><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<name>id</name><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<pos>1</pos><br>
&nbsp;&nbsp;&nbsp;&nbsp;</meta-value><br>
&nbsp;&nbsp;</meta-data><br>
&nbsp;&nbsp;<param type="long">7</param><br>
</event><br><br>
<font color="blue">Create ISC Cluster<br>
This command will create ISC Cluster (type=9), whose name is IscClusterName. ISC ID is not important can be set to 0 or this second parameter can be skipped. Group is created on partition 3<br>
Example with second parameter set to 0</font><br>
<?xml version="1.0" encoding="UTF-8"><br>
<command tid="0004" name="<b> createXIQSVoipDvcGroup </b>"><br>
&nbsp;&nbsp;<param type="string"> IscClusterName </param><br>
&nbsp;&nbsp;<param type="long">0</param><br>
&nbsp;&nbsp;<param type="integer">9</param><br>
&nbsp;&nbsp;<param type="long">3</param><br>
</command><br>
<font color="blue">Example without second parameter</font><br>
<?xml version="1.0" encoding="UTF-8"><br>
<command tid="0004" name="<b> createXIQSVoipDvcGroup </b>"><br>
&nbsp;&nbsp;<param type="string"> IscClusterName </param><br>
&nbsp;&nbsp;<param type="integer">9</param><br>
&nbsp;&nbsp;<param type="long">3</param><br>
</command><br><br>
<font color="green">[ANSWER (OK)]<br>ISC Cluster created with ID=22</font><br>
<?xml version="1.0" encoding="UTF-8"?><br>
<event type="return" tid="0004"><br>
&nbsp;&nbsp;<meta-data><br>
&nbsp;&nbsp;&nbsp;&nbsp;<meta-value><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<name>id</name><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<pos>1</pos><br>
&nbsp;&nbsp;&nbsp;&nbsp;</meta-value><br>
&nbsp;&nbsp;</meta-data><br>
&nbsp;&nbsp;<param type="long">22</param><br>
</event><br><br>
<br>
|}