Skip to content

Latest commit

 

History

History
401 lines (308 loc) · 11.4 KB

MmsCampaignApi.md

File metadata and controls

401 lines (308 loc) · 11.4 KB

IO.ClickSend.ClickSend.Api.MmsCampaignApi

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

Method HTTP request Description
MmsCampaignByMmsCampaignIdGet GET /mms-campaigns/{mms_campaign_id} Get specific mms campaign
MmsCampaignsByMmsCampaignIdPut PUT /mms-campaigns/{mms_campaign_id} Update mms campaign
MmsCampaignsCancelByMmsCampaignIdPut PUT /mms-campaigns/{mms_campaign_id}/cancel Cancel mms campaign
MmsCampaignsGet GET /mms-campaigns Get list of mms campaigns
MmsCampaignsPricePost POST /mms-campaigns/price Calculate price for mms campaign
MmsCampaignsSendPost POST /mms-campaigns/send Create mms campaign

MmsCampaignByMmsCampaignIdGet

string MmsCampaignByMmsCampaignIdGet (int? mmsCampaignId)

Get specific mms campaign

Get specific mms 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 MmsCampaignByMmsCampaignIdGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new MmsCampaignApi();
            var mmsCampaignId = 56;  // int? | ID of MMS campaign to retrieve

            try
            {
                // Get specific mms campaign
                string result = apiInstance.MmsCampaignByMmsCampaignIdGet(mmsCampaignId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MmsCampaignApi.MmsCampaignByMmsCampaignIdGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
mmsCampaignId int? ID of MMS 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]

MmsCampaignsByMmsCampaignIdPut

string MmsCampaignsByMmsCampaignIdPut (MmsCampaign body, int? mmsCampaignId)

Update mms campaign

Update mms 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 MmsCampaignsByMmsCampaignIdPutExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new MmsCampaignApi();
            var body = new MmsCampaign(); // MmsCampaign | MmsCampaign model
            var mmsCampaignId = 56;  // int? | ID of MMS campaign to update

            try
            {
                // Update mms campaign
                string result = apiInstance.MmsCampaignsByMmsCampaignIdPut(body, mmsCampaignId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MmsCampaignApi.MmsCampaignsByMmsCampaignIdPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body MmsCampaign MmsCampaign model
mmsCampaignId int? ID of MMS 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]

MmsCampaignsCancelByMmsCampaignIdPut

string MmsCampaignsCancelByMmsCampaignIdPut (int? mmsCampaignId)

Cancel mms 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 MmsCampaignsCancelByMmsCampaignIdPutExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new MmsCampaignApi();
            var mmsCampaignId = 56;  // int? | ID of MMS Campaign to cancel

            try
            {
                // Cancel mms campaign
                string result = apiInstance.MmsCampaignsCancelByMmsCampaignIdPut(mmsCampaignId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MmsCampaignApi.MmsCampaignsCancelByMmsCampaignIdPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
mmsCampaignId int? ID of MMS 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]

MmsCampaignsGet

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

Get list of mms campaigns

Get list of mms 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 MmsCampaignsGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new MmsCampaignApi();
            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 mms campaigns
                string result = apiInstance.MmsCampaignsGet(page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MmsCampaignApi.MmsCampaignsGet: " + 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]

MmsCampaignsPricePost

string MmsCampaignsPricePost (MmsCampaign body)

Calculate price for mms 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 MmsCampaignsPricePostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new MmsCampaignApi();
            var body = new MmsCampaign(); // MmsCampaign | MmsCampaign model

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

Parameters

Name Type Description Notes
body MmsCampaign MmsCampaign 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]

MmsCampaignsSendPost

string MmsCampaignsSendPost (MmsCampaign body)

Create mms campaign

Create mms 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 MmsCampaignsSendPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new MmsCampaignApi();
            var body = new MmsCampaign(); // MmsCampaign | MmsCampaign model

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

Parameters

Name Type Description Notes
body MmsCampaign MmsCampaign 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]