Skip to content

Latest commit

 

History

History
338 lines (260 loc) · 10.6 KB

SMSDeliveryReceiptRulesApi.md

File metadata and controls

338 lines (260 loc) · 10.6 KB

IO.ClickSend.ClickSend.Api.SMSDeliveryReceiptRulesApi

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

Method HTTP request Description
SmsDeliveryReceiptAutomationDelete DELETE /automations/sms/receipts/{receipt_rule_id} Delete sms delivery receipt automation
SmsDeliveryReceiptAutomationGet GET /automations/sms/receipts/{receipt_rule_id} Get specific sms delivery receipt automation
SmsDeliveryReceiptAutomationPost POST /automations/sms/receipts Create sms delivery receipt automations
SmsDeliveryReceiptAutomationPut PUT /automations/sms/receipts/{receipt_rule_id} Update sms delivery receipt automation
SmsDeliveryReceiptAutomationsGet GET /automations/sms/receipts Get all sms delivery receipt automations

SmsDeliveryReceiptAutomationDelete

string SmsDeliveryReceiptAutomationDelete (int? receiptRuleId)

Delete sms delivery receipt automation

Delete sms delivery receipt 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 SmsDeliveryReceiptAutomationDeleteExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SMSDeliveryReceiptRulesApi();
            var receiptRuleId = 56;  // int? | Receipt rule id

            try
            {
                // Delete sms delivery receipt automation
                string result = apiInstance.SmsDeliveryReceiptAutomationDelete(receiptRuleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMSDeliveryReceiptRulesApi.SmsDeliveryReceiptAutomationDelete: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
receiptRuleId int? Receipt 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]

SmsDeliveryReceiptAutomationGet

string SmsDeliveryReceiptAutomationGet (int? receiptRuleId)

Get specific sms delivery receipt automation

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

            var apiInstance = new SMSDeliveryReceiptRulesApi();
            var receiptRuleId = 56;  // int? | Receipt rule id

            try
            {
                // Get specific sms delivery receipt automation
                string result = apiInstance.SmsDeliveryReceiptAutomationGet(receiptRuleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMSDeliveryReceiptRulesApi.SmsDeliveryReceiptAutomationGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
receiptRuleId int? Receipt 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]

SmsDeliveryReceiptAutomationPost

string SmsDeliveryReceiptAutomationPost (DeliveryReceiptRule body)

Create sms delivery receipt automations

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

            var apiInstance = new SMSDeliveryReceiptRulesApi();
            var body = new DeliveryReceiptRule(); // DeliveryReceiptRule | sms delivery receipt rule model

            try
            {
                // Create sms delivery receipt automations
                string result = apiInstance.SmsDeliveryReceiptAutomationPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMSDeliveryReceiptRulesApi.SmsDeliveryReceiptAutomationPost: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body DeliveryReceiptRule sms delivery receipt 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]

SmsDeliveryReceiptAutomationPut

string SmsDeliveryReceiptAutomationPut (DeliveryReceiptRule body, int? receiptRuleId)

Update sms delivery receipt automation

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

            var apiInstance = new SMSDeliveryReceiptRulesApi();
            var body = new DeliveryReceiptRule(); // DeliveryReceiptRule | Delivery receipt rule model
            var receiptRuleId = 56;  // int? | Receipt rule id

            try
            {
                // Update sms delivery receipt automation
                string result = apiInstance.SmsDeliveryReceiptAutomationPut(body, receiptRuleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMSDeliveryReceiptRulesApi.SmsDeliveryReceiptAutomationPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body DeliveryReceiptRule Delivery receipt rule model
receiptRuleId int? Receipt 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]

SmsDeliveryReceiptAutomationsGet

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

Get all sms delivery receipt automations

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

            var apiInstance = new SMSDeliveryReceiptRulesApi();
            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 sms delivery receipt automations
                string result = apiInstance.SmsDeliveryReceiptAutomationsGet(q, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMSDeliveryReceiptRulesApi.SmsDeliveryReceiptAutomationsGet: " + 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]