A group of methods for working with SMS campaigns.

MethodDescription
deleteSmsCampaignByIdDELETE /sms/campaigns/smsCampaignId
Deletes an SMS campaign by its ID.

Requires authorization and access right sms_manage.

deleteSmsCampaignsDELETE /sms/campaigns
Deletes SMS Campaigns.

This method supports the semantics of search queries.

Requires authorization and access right sms_manage.

getSmsCampaignByIdGET /sms/campaigns/smsCampaignId
Returns SMS CampaignById.

Requires authorization and access right sms_view.

getSmsCampaignCountriesGET /sms/campaigns/smsCampaignId/countries
Returns country statistics for SMS campaigns by its ID.

Requires authorization and access right sms_view.

getSmsCampaignPartsGET /sms/campaigns/smsCampaignId/parts
Returns statistics on the number of message parts for SMS campaigns by its ID.

Requires authorization and access right sms_view.

getSmsCampaignStatesGET /sms/campaigns/smsCampaignId/errors
Returns statistics on message statuses and errors for SMS campaigns by its ID.

Requires authorization and access right sms_view.

querySmsCampaignCountHEAD /sms/campaigns
Returns the number of SMS messages matching the query.

This method supports the semantics of search queries.

Requires authorization and access right sms_view.

querySmsCampaignsGET /sms/campaigns
Returns SMS campaigns that match the query.

This method supports the semantics of search queries.

Requires authorization and access right sms_view.

sendSmsCampaignPOST /sms/campaigns
Sends Campaign SMS

Requires authorization and access right sms_send.

updateSmsCampaignByIdPATCH /sms/campaigns/smsCampaignId
Stops or starts sending SMS campaigns by campaign ID.

Requires authorization and access right sms_manage.

updateSmsCampaignsPATCH /sms/campaigns
Stops or starts sending SMS campaigns.

This method supports the semantics of search queries.

Requires authorization and access right sms_manage.