sib_api_v3_sdk.Api.SMSCampaignsApi

All URIs are relative to https://api.sendinblue.com/v3

Method	HTTP request	Description
CreateSmsCampaign	POST /smsCampaigns	Creates an SMS campaign
DeleteSmsCampaign	DELETE /smsCampaigns/{campaignId}	Delete an SMS campaign
GetSmsCampaign	GET /smsCampaigns/{campaignId}	Get an SMS campaign
GetSmsCampaigns	GET /smsCampaigns	Returns the information for all your created SMS campaigns
RequestSmsRecipientExport	POST /smsCampaigns/{campaignId}/exportRecipients	Export an SMS campaign's recipients
SendSmsCampaignNow	POST /smsCampaigns/{campaignId}/sendNow	Send your SMS campaign immediately
SendSmsReport	POST /smsCampaigns/{campaignId}/sendReport	Send an SMS campaign's report
SendTestSms	POST /smsCampaigns/{campaignId}/sendTest	Send a test SMS campaign
UpdateSmsCampaign	PUT /smsCampaigns/{campaignId}	Update an SMS campaign
UpdateSmsCampaignStatus	PUT /smsCampaigns/{campaignId}/status	Update a campaign's status

CreateSmsCampaign

CreateModel CreateSmsCampaign (CreateSmsCampaign createSmsCampaign)

Creates an SMS campaign

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class CreateSmsCampaignExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new SMSCampaignsApi();
            var createSmsCampaign = new CreateSmsCampaign(); // CreateSmsCampaign | Values to create an SMS Campaign

            try
            {
                // Creates an SMS campaign
                CreateModel result = apiInstance.CreateSmsCampaign(createSmsCampaign);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMSCampaignsApi.CreateSmsCampaign: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
createSmsCampaign	CreateSmsCampaign	Values to create an SMS Campaign

Return type

CreateModel

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteSmsCampaign

void DeleteSmsCampaign (long? campaignId)

Delete an SMS campaign

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class DeleteSmsCampaignExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new SMSCampaignsApi();
            var campaignId = 789;  // long? | id of the SMS campaign

            try
            {
                // Delete an SMS campaign
                apiInstance.DeleteSmsCampaign(campaignId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMSCampaignsApi.DeleteSmsCampaign: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
campaignId	long?	id of the SMS campaign

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSmsCampaign

GetSmsCampaign GetSmsCampaign (long? campaignId)

Get an SMS campaign

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetSmsCampaignExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new SMSCampaignsApi();
            var campaignId = 789;  // long? | id of the SMS campaign

            try
            {
                // Get an SMS campaign
                GetSmsCampaign result = apiInstance.GetSmsCampaign(campaignId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMSCampaignsApi.GetSmsCampaign: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
campaignId	long?	id of the SMS campaign

Return type

GetSmsCampaign

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSmsCampaigns

GetSmsCampaigns GetSmsCampaigns (string status = null, string startDate = null, string endDate = null, long? limit = null, long? offset = null, string sort = null)

Returns the information for all your created SMS campaigns

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetSmsCampaignsExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new SMSCampaignsApi();
            var status = status_example;  // string | Status of campaign. (optional) 
            var startDate = startDate_example;  // string | 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' ) (optional) 
            var endDate = endDate_example;  // string | 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' ) (optional) 
            var limit = 789;  // long? | Number limitation for the result returned (optional)  (default to 500)
            var offset = 789;  // long? | Beginning point in the list to retrieve from. (optional)  (default to 0)
            var sort = sort_example;  // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional)  (default to desc)

            try
            {
                // Returns the information for all your created SMS campaigns
                GetSmsCampaigns result = apiInstance.GetSmsCampaigns(status, startDate, endDate, limit, offset, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMSCampaignsApi.GetSmsCampaigns: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
status	string	Status of campaign.	[optional]
startDate	string	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' )	[optional]
endDate	string	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' )	[optional]
limit	long?	Number limitation for the result returned	[optional] [default to 500]
offset	long?	Beginning point in the list to retrieve from.	[optional] [default to 0]
sort	string	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed	[optional] [default to desc]

Return type

GetSmsCampaigns

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RequestSmsRecipientExport

CreatedProcessId RequestSmsRecipientExport (long? campaignId, RequestSmsRecipientExport recipientExport = null)

Export an SMS campaign's recipients

It returns the background process ID which on completion calls the notify URL that you have set in the input.

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class RequestSmsRecipientExportExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new SMSCampaignsApi();
            var campaignId = 789;  // long? | id of the campaign
            var recipientExport = new RequestSmsRecipientExport(); // RequestSmsRecipientExport | Values to send for a recipient export request (optional) 

            try
            {
                // Export an SMS campaign's recipients
                CreatedProcessId result = apiInstance.RequestSmsRecipientExport(campaignId, recipientExport);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMSCampaignsApi.RequestSmsRecipientExport: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
campaignId	long?	id of the campaign
recipientExport	RequestSmsRecipientExport	Values to send for a recipient export request	[optional]

Return type

CreatedProcessId

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SendSmsCampaignNow

void SendSmsCampaignNow (long? campaignId)

Send your SMS campaign immediately

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class SendSmsCampaignNowExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new SMSCampaignsApi();
            var campaignId = 789;  // long? | id of the campaign

            try
            {
                // Send your SMS campaign immediately
                apiInstance.SendSmsCampaignNow(campaignId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMSCampaignsApi.SendSmsCampaignNow: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
campaignId	long?	id of the campaign

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SendSmsReport

void SendSmsReport (long? campaignId, SendReport sendReport)

Send an SMS campaign's report

Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class SendSmsReportExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new SMSCampaignsApi();
            var campaignId = 789;  // long? | id of the campaign
            var sendReport = new SendReport(); // SendReport | Values for send a report

            try
            {
                // Send an SMS campaign's report
                apiInstance.SendSmsReport(campaignId, sendReport);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMSCampaignsApi.SendSmsReport: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
campaignId	long?	id of the campaign
sendReport	SendReport	Values for send a report

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SendTestSms

void SendTestSms (long? campaignId, SendTestSms phoneNumber)

Send a test SMS campaign

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class SendTestSmsExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new SMSCampaignsApi();
            var campaignId = 789;  // long? | Id of the SMS campaign
            var phoneNumber = new SendTestSms(); // SendTestSms | Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted

            try
            {
                // Send a test SMS campaign
                apiInstance.SendTestSms(campaignId, phoneNumber);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMSCampaignsApi.SendTestSms: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
campaignId	long?	Id of the SMS campaign
phoneNumber	SendTestSms	Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateSmsCampaign

void UpdateSmsCampaign (long? campaignId, UpdateSmsCampaign updateSmsCampaign)

Update an SMS campaign

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class UpdateSmsCampaignExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new SMSCampaignsApi();
            var campaignId = 789;  // long? | id of the SMS campaign
            var updateSmsCampaign = new UpdateSmsCampaign(); // UpdateSmsCampaign | Values to update an SMS Campaign

            try
            {
                // Update an SMS campaign
                apiInstance.UpdateSmsCampaign(campaignId, updateSmsCampaign);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMSCampaignsApi.UpdateSmsCampaign: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
campaignId	long?	id of the SMS campaign
updateSmsCampaign	UpdateSmsCampaign	Values to update an SMS Campaign

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateSmsCampaignStatus

void UpdateSmsCampaignStatus (long? campaignId, UpdateCampaignStatus status)

Update a campaign's status

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class UpdateSmsCampaignStatusExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new SMSCampaignsApi();
            var campaignId = 789;  // long? | id of the campaign
            var status = new UpdateCampaignStatus(); // UpdateCampaignStatus | Status of the campaign.

            try
            {
                // Update a campaign's status
                apiInstance.UpdateSmsCampaignStatus(campaignId, status);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMSCampaignsApi.UpdateSmsCampaignStatus: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
campaignId	long?	id of the campaign
status	UpdateCampaignStatus	Status of the campaign.

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

SMSCampaignsApi.md

Latest commit

History

SMSCampaignsApi.md

File metadata and controls

sib_api_v3_sdk.Api.SMSCampaignsApi

CreateSmsCampaign

Example

Parameters

Return type

Authorization

HTTP request headers

DeleteSmsCampaign

Example

Parameters

Return type

Authorization

HTTP request headers

GetSmsCampaign

Example

Parameters

Return type

Authorization

HTTP request headers

GetSmsCampaigns

Example

Parameters

Return type

Authorization

HTTP request headers

RequestSmsRecipientExport

Example

Parameters

Return type

Authorization

HTTP request headers

SendSmsCampaignNow

Example

Parameters

Return type

Authorization

HTTP request headers

SendSmsReport

Example

Parameters

Return type

Authorization

HTTP request headers

SendTestSms

Example

Parameters

Return type

Authorization

HTTP request headers

UpdateSmsCampaign

Example

Parameters

Return type

Authorization

HTTP request headers

UpdateSmsCampaignStatus

Example

Parameters

Return type

Authorization

HTTP request headers