IO.ClickSend.ClickSend.Api.EmailToSmsApi

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

Method	HTTP request	Description
SmsEmailSmsGet	GET /sms/email-sms	Get list of email to sms allowed addresses
SmsEmailSmsPost	POST /sms/email-sms	Create email to sms allowed address
SmsEmailSmsStrippedStringDelete	DELETE /sms/email-sms-stripped-strings/{rule_id}	Delete email to sms stripped string rule
SmsEmailSmsStrippedStringGet	GET /sms/email-sms-stripped-strings/{rule_id}	Get email to sms stripped string rule
SmsEmailSmsStrippedStringPost	POST /sms/email-sms-stripped-strings	Create email to sms stripped string rule
SmsEmailSmsStrippedStringPut	PUT /sms/email-sms-stripped-strings/{rule_id}	Update email to sms stripped string rule
SmsEmailSmsStrippedStringsGet	GET /sms/email-sms-stripped-strings	Get list of email to sms stripped string rules

SmsEmailSmsGet

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

Get list of email to sms allowed addresses

Example

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

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

            var apiInstance = new EmailToSmsApi();
            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 email to sms allowed addresses
                string result = apiInstance.SmsEmailSmsGet(page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailToSmsApi.SmsEmailSmsGet: " + 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]

SmsEmailSmsPost

string SmsEmailSmsPost (EmailSMSAddress body)

Create email to sms allowed address

Example

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

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

            var apiInstance = new EmailToSmsApi();
            var body = new EmailSMSAddress(); // EmailSMSAddress | EmailSMSAddress model

            try
            {
                // Create email to sms allowed address
                string result = apiInstance.SmsEmailSmsPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailToSmsApi.SmsEmailSmsPost: " + e.Message );
            }
        }
    }
}

Parameters

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

SmsEmailSmsStrippedStringDelete

string SmsEmailSmsStrippedStringDelete (int? ruleId)

Delete email to sms stripped string rule

Example

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

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

            var apiInstance = new EmailToSmsApi();
            var ruleId = 56;  // int? | Your rule id

            try
            {
                // Delete email to sms stripped string rule
                string result = apiInstance.SmsEmailSmsStrippedStringDelete(ruleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailToSmsApi.SmsEmailSmsStrippedStringDelete: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
ruleId	int?	Your rule id

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]

SmsEmailSmsStrippedStringGet

string SmsEmailSmsStrippedStringGet (int? ruleId)

Get email to sms stripped string rule

Example

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

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

            var apiInstance = new EmailToSmsApi();
            var ruleId = 56;  // int? | Your rule id

            try
            {
                // Get email to sms stripped string rule
                string result = apiInstance.SmsEmailSmsStrippedStringGet(ruleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailToSmsApi.SmsEmailSmsStrippedStringGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
ruleId	int?	Your rule id

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]

SmsEmailSmsStrippedStringPost

string SmsEmailSmsStrippedStringPost (StrippedString body)

Create email to sms stripped string rule

Create email to sms stripped string rules

Example

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

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

            var apiInstance = new EmailToSmsApi();
            var body = new StrippedString(); // StrippedString | StrippedString model

            try
            {
                // Create email to sms stripped string rule
                string result = apiInstance.SmsEmailSmsStrippedStringPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailToSmsApi.SmsEmailSmsStrippedStringPost: " + e.Message );
            }
        }
    }
}

Parameters

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

SmsEmailSmsStrippedStringPut

string SmsEmailSmsStrippedStringPut (StrippedString body, int? ruleId)

Update email to sms stripped string rule

Example

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

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

            var apiInstance = new EmailToSmsApi();
            var body = new StrippedString(); // StrippedString | StrippedString model
            var ruleId = 56;  // int? | Your rule id

            try
            {
                // Update email to sms stripped string rule
                string result = apiInstance.SmsEmailSmsStrippedStringPut(body, ruleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailToSmsApi.SmsEmailSmsStrippedStringPut: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	StrippedString	StrippedString model
ruleId	int?	Your rule id

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]

SmsEmailSmsStrippedStringsGet

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

Get list of email to sms stripped string rules

Example

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

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

            var apiInstance = new EmailToSmsApi();
            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 email to sms stripped string rules
                string result = apiInstance.SmsEmailSmsStrippedStringsGet(page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailToSmsApi.SmsEmailSmsStrippedStringsGet: " + 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]

Files

EmailToSmsApi.md

Latest commit

History

EmailToSmsApi.md

File metadata and controls

IO.ClickSend.ClickSend.Api.EmailToSmsApi

SmsEmailSmsGet

Example

Parameters

Return type

Authorization

HTTP request headers

SmsEmailSmsPost

Example

Parameters

Return type

Authorization

HTTP request headers

SmsEmailSmsStrippedStringDelete

Example

Parameters

Return type

Authorization

HTTP request headers

SmsEmailSmsStrippedStringGet

Example

Parameters

Return type

Authorization

HTTP request headers

SmsEmailSmsStrippedStringPost

Example

Parameters

Return type

Authorization

HTTP request headers

SmsEmailSmsStrippedStringPut

Example

Parameters

Return type

Authorization

HTTP request headers

SmsEmailSmsStrippedStringsGet

Example

Parameters

Return type

Authorization

HTTP request headers