GuidesRecipesAPI Reference
API Reference
Log inHelp centre

GetSMSCampaigns

Returns existing SMS campaigns

This operation is used to return a collection of existing SMS campaigns that exists on your account. The page size (maximum 1,000) must be specified and denotes the number of records you wish to return in your collection per API call. The skip parameter is used in the event you want the next page.

Example: If you wanted to return page 3 for page size 1,000, you would set the query parameter to be baseurl?select=1000&skip=2000. This would return records 2001-3000.

If you specify an invalid page size (valid: 1-1000), you will be returned an appropriate error message.

Campaigns that are deleted will not be returned in your collection(s). No campaign message will be returned, this will be null within the returned object.

SOAP action: http://apiconnector.com/v2/sms/campaigns

❗️

API call in beta

Please note that this API call is in beta and is subject to change.

📘

Input and output parameters

The input and output parameters for this method are:

Input parameters

  • select - integer
  • skip - integer

Output parameters
No output

Example

using (var client = new ApiServiceClient())
{
    client.ClientCredentials.UserName.UserName = "username";
    client.ClientCredentials.UserName.Password = "password";

    var result = client.GetSmsCampaigns(account, {select}, {skip});
}