Skip to main content
GET
/
api
/
v2
/
Campaign
{
  "ErrorCode": 123,
  "ErrorDescription": "<string>",
  "Data": [
    {}
  ],
  "Data[].CampaignId": 123,
  "Data[].CampaignName": "<string>",
  "Data[].Message": "<string>",
  "Data[].CreatedDate": "<string>",
  "Data[].SenderId": "<string>",
  "Data[].MessageCount": 123
}

​
Get Campaigns

Retrieve a paginated list of SMS campaigns with optional date filtering. 
curl -X GET "https://accounts.netvox.ng/api/v2/Campaign?ApiKey=YOUR_API_KEY&ClientId=YOUR_CLIENT_ID&start=0&length=10&fromdate=2024-01-01&enddate=2024-12-31" \
  -H "Content-Type: application/json"

​
Parameters

​
ApiKey
string
required
Your API key for authentication
​
ClientId
string
required
Your client identifier for authentication
​
start
number
required
Starting index for pagination (0-based)
​
length
number
required
Number of campaigns to retrieve per page
​
fromdate
string
Start date filter in yyyy-mm-dd format
​
enddate
string
End date filter in yyyy-mm-dd format

​
Response

​
ErrorCode
number
Error code (0 for success)
​
ErrorDescription
string
Description of the result
​
Data
array
Array of campaign objects
​
Data[].CampaignId
number
Unique identifier for the campaign
​
Data[].CampaignName
string
Name of the campaign
​
Data[].Message
string
Campaign message content
​
Data[].CreatedDate
string
Campaign creation date
​
Data[].SenderId
string
Sender ID used for the campaign
​
Data[].MessageCount
number
Number of messages in the campaign

​
Success 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
    }
  ]
}

​
Use Cases

  • Campaign overview: View all your SMS campaigns
  • Analytics: Analyze campaign performance over time
  • Audit trail: Track campaign history and details
  • Integration: Sync campaign data with your CRM or analytics platform