Search Knowledge Base Articles

Manage Group

1) Get Group List

https://secure.xwireless.net/api/v2/Group?ApiKey={ApiKey}&ClientId={ClientId}
 


Parameters :
Parameter Name Description Type
ApiKey ApiKey used for authentication purpose and pass this parameter in URL encoded format. String
ClientId ClientId used for authentication purpose and pass this parameter in URL encoded format. String
HEADERS :
Content-Type: application/json or application/xml
Type: json or xml
Jquery Api Call : 
<script>
    $(function () {         
         $.ajax({
            type: "GET",
            url: "https://secure.xwireless.net/api/v2/Group?ApiKey={ApiKey}&ClientId={ClientId}",
            contentType: "application/json",
            dataType: 'json',
            success: function (response) {
                
            }
        });
    });
</script>
Json Response Xml Response 
{
    "ErrorCode": 0,
    "ErrorDescription": "Success",
    "Data": [
        {
            "GroupId": 33,
            "GroupName": "JGJ",
            "ContactCount": 21
        },
        {
            "GroupId": 50,
            "GroupName": "6Y5",
            "ContactCount": 0
        }        
    ]
}
 
<ResponseModelOfListOfGroup>
    <ErrorCode>0</ErrorCode>
    <ErrorDescription>Success</ErrorDescription>
    <Data>
        <Group>
            <GroupId>33</GroupId>
            <GroupName>JGJ</GroupName>
            <ContactCount>21</ContactCount>
        </Group>
        <Group>
            <GroupId>50</GroupId>
            <GroupName>6Y5</GroupName>
            <ContactCount>0</ContactCount>
        </Group>        
    </Data>
</ResponseModelOfListOfGroup>

2) Create New Group

https://secure.xwireless.net/api/v2/Group
 


Request Body :
JSON XML 
{
  "GroupName": "551",
  "ApiKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
  "ClientId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
}
 
<?xml version="1.0"?>
<GroupAPIModel>
  <GroupName>string</GroupName>
  <ApiKey>string</ApiKey>
  <ClientId>string</ClientId>
</GroupAPIModel>
Parameters :
Parameter Name Description Type
ApiKey ApiKey used for authentication purpose. String
ClientId ClientId used for authentication purpose. String
GroupName Name for new group . String
HEADERS :
Content-Type: application/json or application/xml
Type: json or xml
Jquery Api Call : 
<script>   
    $(function () {
        var Jsondata = {
            'GroupName': 'hello',
            'ApiKey': 'ApiKey',
            'ClientId': 'ClientId'
        };
        $.ajax({
            type: "POST",
            url: "https://secure.xwireless.net/api/v2/Group",
            contentType: "application/json",
            dataType: 'json',
            data: JSON.stringify(Jsondata),
            success: function (response) {                
            }
        });
    });

</script>
Json Response Xml Response 
{
  "ErrorCode": 0,
  "ErrorDescription": "Success",
  "Data": "success#New Group added successfully."
}
 
<ResponseModelOfString>
    <ErrorCode>0</ErrorCode>
    <ErrorDescription>Success</ErrorDescription>
    <Data>success#New Group added successfully.</Data>
</ResponseModelOfString>

3) Update Group

https://secure.xwireless.net/api/v2/Group?id={Id}
 


Request Body :
JSON XML 
{
  "GroupName": "string",
  "ApiKey": "string",
  "ClientId": "string"
}
 
<?xml version="1.0"?>
<GroupAPIModel>
  <GroupName>string</GroupName>
  <ApiKey>string</ApiKey>
  <ClientId>string</ClientId>
</GroupAPIModel>
Parameters :
Parameter Name Description Type
ApiKey ApiKey used for authentication purpose. String
ClientId ClientId used for authentication purpose. String
GroupName Name for new group . String
HEADERS :
Content-Type: application/json or application/xml
Type: json or xml
Jquery Api Call : 
<script>   
    $(function () {
       var Jsondata = {
            'GroupName': 'hello1',
            'ApiKey': '{ApiKey}',
            'ClientId': '{ClientId}'
        };
        $.ajax({
            type: "PUT",
            url: "https://secure.xwireless.net/api/v2/Group?id=215",
            contentType: "application/json",
            dataType: 'json',
            data: JSON.stringify(Jsondata),
            success: function (response) {                
            }
        });
    });

</script>
Json Response Xml Response 
{
    "ErrorCode": 0,
    "ErrorDescription": "Success",
    "Data": "Group updated Successfully."
}
 
<ResponseModelOfString>
    <ErrorCode>0</ErrorCode>
    <ErrorDescription>Success</ErrorDescription>
    <Data>Group updated Successfully.</Data>
</ResponseModelOfString>

4) Create Sub-Group Group

 https://secure.xwireless.net/api/v2/Group?{Id}/SubGroup
 


Request Body :
JSON XML 
{
  "GroupName": "string",
  "ApiKey": "string",
  "ClientId": "string"
}
 
<?xml version="1.0"?>
<GroupAPIModel>
  <GroupName>string</GroupName>
  <ApiKey>string</ApiKey>
  <ClientId>string</ClientId>
</GroupAPIModel>
Parameters :
Parameter Name Description Type
ApiKey ApiKey used for authentication purpose. String
ClientId ClientId used for authentication purpose. String
GroupName Name for new group . String
HEADERS :
Content-Type: application/json or application/xml
Type: json or xml
Jquery Api Call : 
<script>   
    $(function () {
       var Jsondata = {
            'GroupName': 'hello1',
            'ApiKey': '{ApiKey}',
            'ClientId': '{ClientId}'
        };
        $.ajax({
            type: "PUT",
            url: "https://secure.xwireless.net/api/v2/Group/215/SubGroup",
            contentType: "application/json",
            dataType: 'json',
            data: JSON.stringify(Jsondata),
            success: function (response) {                
            }
        });
    });

</script>
Json Response Xml Response 
{
    "ErrorCode": 0,
    "ErrorDescription": "Success",
    "Data": "success#New Group added successfully."
}
 
<ResponseModelOfString>
    <ErrorCode>0</ErrorCode>
    <ErrorDescription>Success</ErrorDescription>
    <Data>Group added Successfully.</Data>
</ResponseModelOfString>

5) Delete Group

https://secure.xwireless.net/api/v2/Group?ApiKey={ApiKey}&ClientId={ClientId}&id=215
 


Parameters :
Parameter Name Description Type
ApiKey ApiKey used for authentication purpose. String
ClientId ClientId used for authentication purpose. String
id group Id . integer
HEADERS :
Content-Type: application/json or application/xml
Type: json or xml
Jquery Api Call : 
<script>   
    $(function () {      
        $.ajax({
            type: "DELETE",
            url: "https://secure.xwireless.net/api/v2/Group?ApiKey={ApiKey}&ClientId={ClientId}&id=215'",
            contentType: "application/json",
            dataType: 'json',
            data: JSON.stringify(Jsondata),
            success: function (response) {                
            }
        });
    });

</script>

Did you find this article useful?


Related Articles

  • Getting Started

    Before you can start using the X-Wireless API, you need to do the following: Create an Account with X-Wireless if you do not already have one Gene...

  • Get Credit Balance

    https://secure.xwireless.net/api/v2/Balance?ApiKey={ApiKey}&ClientId={ClientId}Parameters : Parameter Name Description Type Api...

  • Campaign

    1) Get Campaign Message Status https://secure.xwireless.net/api/v2/Campaign/Statistics?ApiKey={ApiKey}&ClientId={ClientId}&campaignId={c...

  • Manage Sender ID

    1) Get Sender Id List  https://secure.xwireless.net/api/v2/SenderId?ApiKey={ApiKey}&ClientId={ClientId}   Parameters : Par...

  • Manage Templates

    1) Get Template List https://secure.xwireless.net/api/v2/Template?ApiKey={ApiKey}&ClientId={ClientId}   Parameters : Parameter...