BSG utilizes HTTP cookies (and similar or complementary technologies) to 1) make this website safe, functional, and accessible (through the use of mandatory cookies) and 2) understand how you use our website (through the use of optional cookies) in order to improve your experience and to provide you with personalized content.

The information in the cookie text files may be related to your personal preferences or your device and is intended to make the site operate according to your expectations. The information contained in cookies does not usually identify your identity directly but is helpful in providing you with a more personalized user experience.

In accordance with the requirements of the General Data Protection Regulation (GDPR) privacy and security law that governs how the personal data of individuals in the EU may be processed and transferred, we provide you the possibility to prohibit the use of certain types of cookies when you use our website.

Read our Cookie Notice and the Privacy Policy for detailed information on how BGS collects and uses cookies. Please note that prohibiting the use of certain types of cookies may affect your interaction with the website and limit the accessibility of services we offer you. Choose the appropriate category below to learn more and to disable cookies.

Accept All cookies*

*Recommended for comfortable use of the site

Accept only necessary cookies

Accept only selected cookies

Necessary cookies

Social media

Analytics

Marketing

Cancel SMS Campaign

The method allows you to cancel the SMS campaign sent via the API.

Cancellation is possible only for a campaign that is in the creation / paused / sending / scheduled status.

To cancel campaign, make a request to this URL:

PATCH https://one-api.bsg.world/api/campaigns/{id}/stop

Request parameters:

Parameter	Required	Type	Default	Description
id	Yes	integer	No	The ID of the campaign created using: POST /api/campaigns/sms/send POST /api/campaigns/sms/send-groups POST /api/campaigns/sms/send- individual

Parameter

Required

Type

Default

Description

Yes

integer

The ID of the campaign created using:

POST /api/campaigns/sms/send

POST /api/campaigns/sms/send-groups

POST /api/campaigns/sms/send- individual

Response parameters:

Parameter		Type	Description
id		integer	ID of the task created for a bulk campaign
name		string	Campaign name
sender		string	SMS Sender name
status		string	Campaign status. Possible values: creation – created spam – campaign did not pass moderation scheduled – campaign is scheduled sending – campaign began to be sent paused – campaign is paused stopped – campaign is stopped done – campaign is completed
mesage_type		string	Campaign type: sms
start_at		string	Date and time of the campaign start (scheduled). Format ISO 8601: yyyy-mm-dd hh:mm:ss
real_start_at		string	Actual date and time the campaign started. Format ISO 8601: yyyy-mm-dd hh:mm:ss
finished_at		string	Date and time the campaign is completed. Format ISO 8601: yyyy-mm-dd hh:mm:ss
created_at		string	Date and time the campaign is created. Format ISO 8601: yyyy-mm-dd hh:mm:ss
statistics		array	Campaign statistics:
	delivered	integer	Total number of messages delivered within the campaign
	sent	integer	Total number of messages sent within the campaign

if the request is successful, you will receive a response::


{
  "data": {
    "id": 1,
    "name": "string",
    "sender": "string",
    "status": "creation",
    "message_type": "sms",
    "start_at": "2021-04-27 19:44:06",
    "real_start_at": "2021-04-27 19:44:06",
    "finished_at": "2021-04-27 19:44:06",
    "created_at": "2021-04-27 19:44:06",
    "statistics": {
      "delivered": 0,
      "sent": 0
    }
  }
}