1) Get Campaign Message Status
https://secure.xwireless.net/api/v2/Campaign/Statistics?ApiKey={ApiKey}&ClientId={ClientId}&campaignId={campaignId}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 |
| campaignId | First user have to call Get Campaigns api for CampaignId |
Number |
| 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/Campaign/Statistics?ApiKey={ApiKey}&ClientId={ClientId}&campaignId=2372",
contentType: "application/json",
dataType: 'json',
success: function (response) {
}
});
});
</script>
|
| Json Response | Xml Response |
|---|---|
{
"ErrorCode": 0,
"ErrorDescription": "Success",
"Data": {
"DeliveredCount": 1,
"DNDCount": 0,
"SuccessCount": 0,
"SubmittedCount": 0,
"UnDeliveredCount": 0,
"RejectedCount": 0,
"TempSubmittedCount": 0,
"OthersCount": 0,
"DroppedCount": 0,
"TotalCount": 1,
"NotProcessedCount": 0
}
}
|
<ResponseModelOfMessageStatistics>
<ErrorCode>0 </ErrorCode>
<ErrorDescription>Success </ErrorDescription>
<Data>
<DeliveredCount>1 </DeliveredCount>
<DNDCount>0 </DNDCount>
<SuccessCount>0 </SuccessCount>
<UnDeliveredCount>0 </UnDeliveredCount>
<RejectedCount>0 </RejectedCount>
<TempSubmittedCount>0 </TempSubmittedCount>
<OthersCount>0 </OthersCount>
<DroppedCount>0 </DroppedCount>
<CreateDate>0001-01-01T00:00:00 </CreateDate>
<TotalCount>1 </TotalCount>
<NotProcessedCount>0 </NotProcessedCount>
</Data>
</ResponseModelOfMessageStatistics>
|
2) Get Campaigns
https://secure.xwireless.net/api/v2/Campaign?ApiKey={ApiKey}&ClientId={ClientId}&start={campaignId}&length={length}&fromdate={fromdate}&enddate={enddate}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 |
| start | Starting index value to fetch the campaign detail. | Number |
| length | Ending index value to fetch the campaign detail. | Number |
| fromdate | Date format must be in yyyy-mm-dd |
String |
| enddate | Date format must be in yyyy-mm-dd |
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/Campaign?ApiKey={ApiKey}&ClientId={ClientId}start=0&length=100
&fromdate=2018-03-17&enddate=2018-03-17",
contentType: "application/json",
dataType: 'json',
success: function (response) {
}
});
});
</script>
|
| Json Response | Xml Response |
|---|---|
{
"ErrorCode": 0,
"ErrorDescription": "Success",
"Data": [
{
"CampaignId": 2272,
"CampaignName": "Camp_07-Mar-2018 14:34",
"Message": "zxczxc",
"CreatedDate": "Jan 01,0001 12:00:00",
"SenderId": "WEBSMS",
"MessageCount": 1
}
]
}
|
<ResponseModelOfListOfCampaign>
<ErrorCode>0</ErrorCode>
<ErrorDescription>Success</ErrorDescription>
<Data>
<Campaign>
<CampaignId>2272</CampaignId>
<CampaignName>Camp_07-Mar-2018 14:34</CampaignName>
<Message>zxczxc</Message>
<CreateDate>0001-01-01T00:00:00</CreateDate>
<SenderId>WEBSMS</SenderId>
<MessageCount>1</MessageCount>
</Campaign>
</Data>
</ResponseModelOfListOfCampaign>
|