Search Knowledge Base Articles

Manage Sender ID

1) Get Sender Id List

 https://secure.xwireless.net/api/v2/SenderId?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/SenderId?ApiKey={ApiKey}&ClientId={ClientId}",
            contentType: "application/json",
            dataType: 'json',
            success: function (response) {
                
            }
        });
    });
</script>
Json Response Xml Response 
{
  "ErrorCode": 0,
  "ErrorDescription": "Success",
  "Data": [
    {
      "Id": 94,
      "CompanyId": 47,
      "Sender-Id": "SMS123",
      "Purpose": "TEST ",
      "IsActive": true,
      "CreatedDate": "Nov 20, 2018",
      "ApproveStatus": "Approved",
      "ApprovedDate": "Nov 21, 2018"
    }       
    ]
}
 
<ResponseModelOfListOfSenderId>
  <ErrorCode>0</ErrorCode>
  <ErrorDescription>Success</ErrorDescription>
  <Data>
    <SenderId>
      <Id>94</Id>
      <CompanyId>47</CompanyId>
      <senderId>SMS123</senderId>
      <purpose>Test</purpose>
      <IsActive>True</IsActive>
      <CreateDate>Nov 20, 2018</CreateDate>
      <ApproveStatus>Test</ApprovedStatus>
      <ApprovedDate>Nov 21, 2018</ApprovedDate>
    </SenderId>
  </Data>
</ResponseModelOfListOfSenderId>

2) Create New Sender Id

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


Request Body :
JSON XML 
{
  "SenderId": "string",
  "Purpose": "string",
  "ApiKey": "string",
  "ClientId": "string"
}
 
<?xml version="1.0"?>
<SenderIdAPIModel>
  <SenderId>string</SenderId>
  <Purpose>string</Purpose>
  <ApiKey>string</ApiKey>
  <ClientId>string</ClientId>
</SenderIdAPIModel>
Parameters :
Parameter Name Description Type
ApiKey ApiKey used for authentication purpose. String
ClientId ClientId used for authentication purpose. String
SenderId Valid sender-id string
Purpose pupose of sender-id String
HEADERS :
Content-Type: application/json or application/xml
Type: json or xml
Jquery Api Call : 
<script>   
    $(function () {
        var Jsondata = {
            'SenderId': 'hello',
            'Purpose': '',
            'ApiKey': 'ApiKey',
            'ClientId': 'ClientId'
        };
        $.ajax({
            type: "POST",
            url: "https://secure.xwireless.net/api/v2/SenderId",
            contentType: "application/json",
            dataType: 'json',
            data: JSON.stringify(Jsondata),
            success: function (response) {                
            }
        });
    });

</script>
Json Response Xml Response 
{
  "ErrorCode": 0,
  "ErrorDescription": "Success",
  "Data": "Senderid Added successfully."
}
 
<ResponseModelOfString>
    <ErrorCode>0</ErrorCode>
    <ErrorDescription>Success</ErrorDescription>
    <Data>Senderid Added successfully.</Data>
</ResponseModelOfString>

3) Update Sender Id

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


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

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

4) Delete Sender Id

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


Parameters :
Parameter Name Description Type
ApiKey ApiKey used for authentication purpose. String
ClientId ClientId used for authentication purpose. String
id Id of sender 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/SenderId?ApiKey={ApiKey}&ClientId={ClientId}&id={id}'",
            contentType: "application/json",
            dataType: 'json',
            data: JSON.stringify(Jsondata),
            success: function (response) {                
            }
        });
    });
</script>
Json Response Xml Response 
{
    "ErrorCode": 0,
    "ErrorDescription": "Success",
    "Data": "SenderId deleted Successfully."
}
 
<ResponseModelOfString>
    <ErrorCode>0</ErrorCode>
    <ErrorDescription>Success</ErrorDescription>
    <Data>SenderId deleted Successfully.</Data>
</ResponseModelOfString>

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 Group

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

  • Manage Templates

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