Skip to content

Latest commit

 

History

History
401 lines (308 loc) · 11.4 KB

SmsCampaignApi.md

File metadata and controls

401 lines (308 loc) · 11.4 KB

IO.ClickSend.ClickSend.Api.SmsCampaignApi

All URIs are relative to https://rest.clicksend.com/v3

Method HTTP request Description
SmsCampaignBySmsCampaignIdGet GET /sms-campaigns/{sms_campaign_id} Get specific sms campaign
SmsCampaignsBySmsCampaignIdPut PUT /sms-campaigns/{sms_campaign_id} Update sms campaign
SmsCampaignsCancelBySmsCampaignIdPut PUT /sms-campaigns/{sms_campaign_id}/cancel Cancel sms campaign
SmsCampaignsGet GET /sms-campaigns Get list of sms campaigns
SmsCampaignsPricePost POST /sms-campaigns/price Calculate price for sms campaign
SmsCampaignsSendPost POST /sms-campaigns/send Create sms campaign

SmsCampaignBySmsCampaignIdGet

string SmsCampaignBySmsCampaignIdGet (int? smsCampaignId)

Get specific sms campaign

Get specific sms campaign

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

namespace Example
{
    public class SmsCampaignBySmsCampaignIdGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SmsCampaignApi();
            var smsCampaignId = 56;  // int? | ID of SMS campaign to retrieve

            try
            {
                // Get specific sms campaign
                string result = apiInstance.SmsCampaignBySmsCampaignIdGet(smsCampaignId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SmsCampaignApi.SmsCampaignBySmsCampaignIdGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
smsCampaignId int? ID of SMS campaign to retrieve

Return type

string

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

SmsCampaignsBySmsCampaignIdPut

string SmsCampaignsBySmsCampaignIdPut (SmsCampaign body, int? smsCampaignId)

Update sms campaign

Update sms campaign

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

namespace Example
{
    public class SmsCampaignsBySmsCampaignIdPutExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SmsCampaignApi();
            var body = new SmsCampaign(); // SmsCampaign | SmsCampaign model
            var smsCampaignId = 56;  // int? | ID of SMS campaign to update

            try
            {
                // Update sms campaign
                string result = apiInstance.SmsCampaignsBySmsCampaignIdPut(body, smsCampaignId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SmsCampaignApi.SmsCampaignsBySmsCampaignIdPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body SmsCampaign SmsCampaign model
smsCampaignId int? ID of SMS campaign to update

Return type

string

Authorization

BasicAuth

HTTP request headers

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

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

SmsCampaignsCancelBySmsCampaignIdPut

string SmsCampaignsCancelBySmsCampaignIdPut (int? smsCampaignId)

Cancel sms campaign

Cancel sms campaign

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

namespace Example
{
    public class SmsCampaignsCancelBySmsCampaignIdPutExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SmsCampaignApi();
            var smsCampaignId = 56;  // int? | ID of SMS Campaign to cancel

            try
            {
                // Cancel sms campaign
                string result = apiInstance.SmsCampaignsCancelBySmsCampaignIdPut(smsCampaignId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SmsCampaignApi.SmsCampaignsCancelBySmsCampaignIdPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
smsCampaignId int? ID of SMS Campaign to cancel

Return type

string

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

SmsCampaignsGet

string SmsCampaignsGet (int? page = null, int? limit = null)

Get list of sms campaigns

Get list of sms campaigns

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

namespace Example
{
    public class SmsCampaignsGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SmsCampaignApi();
            var page = 56;  // int? | Page number (optional)  (default to 1)
            var limit = 56;  // int? | Number of records per page (optional)  (default to 10)

            try
            {
                // Get list of sms campaigns
                string result = apiInstance.SmsCampaignsGet(page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SmsCampaignApi.SmsCampaignsGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
page int? Page number [optional] [default to 1]
limit int? Number of records per page [optional] [default to 10]

Return type

string

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

SmsCampaignsPricePost

string SmsCampaignsPricePost (SmsCampaign body)

Calculate price for sms campaign

Calculate price for sms campaign

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

namespace Example
{
    public class SmsCampaignsPricePostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SmsCampaignApi();
            var body = new SmsCampaign(); // SmsCampaign | SmsCampaign model

            try
            {
                // Calculate price for sms campaign
                string result = apiInstance.SmsCampaignsPricePost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SmsCampaignApi.SmsCampaignsPricePost: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body SmsCampaign SmsCampaign model

Return type

string

Authorization

BasicAuth

HTTP request headers

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

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

SmsCampaignsSendPost

string SmsCampaignsSendPost (SmsCampaign body)

Create sms campaign

Create sms campaign

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

namespace Example
{
    public class SmsCampaignsSendPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SmsCampaignApi();
            var body = new SmsCampaign(); // SmsCampaign | SmsCampaign model

            try
            {
                // Create sms campaign
                string result = apiInstance.SmsCampaignsSendPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SmsCampaignApi.SmsCampaignsSendPost: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body SmsCampaign SmsCampaign model

Return type

string

Authorization

BasicAuth

HTTP request headers

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

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