Marketing CampaignsSMS Campaigns

Returns the information for all your created SMS campaigns

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Query parameters

statusenumOptional
Status of campaign.
startDatestringOptional

Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either ‘status’ not passed and if passed is set to ‘sent’ )

endDatestringOptional

Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either ‘status’ not passed and if passed is set to ‘sent’ )

limitlongOptionalDefaults to 500
Number limitation for the result returned
offsetlongOptionalDefaults to 0
Beginning point in the list to retrieve from.
sortenumOptionalDefaults to desc

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Allowed values:

Response

SMS campaigns informations
campaignslist of objects or null
countlong or null
Number of SMS campaigns retrieved

Errors