Skip to content

Latest commit

 

History

History
338 lines (260 loc) · 9.93 KB

InboundSMSRulesApi.md

File metadata and controls

338 lines (260 loc) · 9.93 KB
Raw

IO.ClickSend.ClickSend.Api.InboundSMSRulesApi

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

Method HTTP request Description
SmsInboundAutomationDelete DELETE /automations/sms/inbound/{inbound_rule_id} Delete inbound sms automation
SmsInboundAutomationGet GET /automations/sms/inbound/{inbound_rule_id} Get specific inbound sms automation
SmsInboundAutomationPost POST /automations/sms/inbound Create new inbound sms automation
SmsInboundAutomationPut PUT /automations/sms/inbound/{inbound_rule_id} Update inbound sms automation
SmsInboundAutomationsGet GET /automations/sms/inbound Get all inbound sms automations

SmsInboundAutomationDelete

string SmsInboundAutomationDelete (int? inboundRuleId)

Delete inbound sms automation

Delete inbound sms automation

Example

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

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

            var apiInstance = new InboundSMSRulesApi();
            var inboundRuleId = 56;  // int? | Inbound rule id

            try
            {
                // Delete inbound sms automation
                string result = apiInstance.SmsInboundAutomationDelete(inboundRuleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundSMSRulesApi.SmsInboundAutomationDelete: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
inboundRuleId int? Inbound 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]

SmsInboundAutomationGet

string SmsInboundAutomationGet (int? inboundRuleId)

Get specific inbound sms automation

Get specific inbound sms automation

Example

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

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

            var apiInstance = new InboundSMSRulesApi();
            var inboundRuleId = 56;  // int? | Inbound rule id

            try
            {
                // Get specific inbound sms automation
                string result = apiInstance.SmsInboundAutomationGet(inboundRuleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundSMSRulesApi.SmsInboundAutomationGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
inboundRuleId int? Inbound 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]

SmsInboundAutomationPost

string SmsInboundAutomationPost (InboundSMSRule body)

Create new inbound sms automation

Create new inbound sms automation

Example

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

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

            var apiInstance = new InboundSMSRulesApi();
            var body = new InboundSMSRule(); // InboundSMSRule | Inbound sms rule model

            try
            {
                // Create new inbound sms automation
                string result = apiInstance.SmsInboundAutomationPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundSMSRulesApi.SmsInboundAutomationPost: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body InboundSMSRule Inbound sms rule 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]

SmsInboundAutomationPut

string SmsInboundAutomationPut (InboundSMSRule body, int? inboundRuleId)

Update inbound sms automation

Update inbound sms automation

Example

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

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

            var apiInstance = new InboundSMSRulesApi();
            var body = new InboundSMSRule(); // InboundSMSRule | Inbound sms rule model
            var inboundRuleId = 56;  // int? | Inbound rule id

            try
            {
                // Update inbound sms automation
                string result = apiInstance.SmsInboundAutomationPut(body, inboundRuleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundSMSRulesApi.SmsInboundAutomationPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body InboundSMSRule Inbound sms rule model
inboundRuleId int? Inbound 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]

SmsInboundAutomationsGet

string SmsInboundAutomationsGet (string q = null, int? page = null, int? limit = null)

Get all inbound sms automations

Get all inbound sms automations

Example

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

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

            var apiInstance = new InboundSMSRulesApi();
            var q = q_example;  // string | Your keyword or query. (optional) 
            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 all inbound sms automations
                string result = apiInstance.SmsInboundAutomationsGet(q, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundSMSRulesApi.SmsInboundAutomationsGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
q string Your keyword or query. [optional]
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]