All URIs are relative to https://rest.clicksend.com/v3
Method | HTTP request | Description |
---|---|---|
SmsCancelAllPut | PUT /sms/cancel-all | Update all scheduled message as cancelled |
SmsCancelByMessageIdPut | PUT /sms/{message_id}/cancel | Update scheduled message as cancelled |
SmsHistoryExportGet | GET /sms/history/export | Export all sms history |
SmsHistoryGet | GET /sms/history | Get all sms history |
SmsInboundGet | GET /sms/inbound | Get all inbound sms |
SmsInboundPost | POST /sms/inbound | Create inbound sms |
SmsInboundReadByMessageIdPut | PUT /sms/inbound-read/{message_id} | Mark inbound SMS as read |
SmsInboundReadPut | PUT /sms/inbound-read | Mark inbound SMS as read |
SmsPricePost | POST /sms/price | Calculate sms price |
SmsReceiptsByMessageIdGet | GET /sms/receipts/{message_id} | Get a Specific Delivery Receipt |
SmsReceiptsGet | GET /sms/receipts | Get all delivery receipts |
SmsReceiptsPost | POST /sms/receipts | Add a delivery receipt |
SmsReceiptsReadPut | PUT /sms/receipts-read | Mark delivery receipts as read |
SmsSendPost | POST /sms/send | Send sms message(s) |
SmsTemplatesByTemplateIdDelete | DELETE /sms/templates/{template_id} | Delete sms template |
SmsTemplatesByTemplateIdPut | PUT /sms/templates/{template_id} | Update sms template |
SmsTemplatesGet | GET /sms/templates | Get lists of all sms templates |
SmsTemplatesPost | POST /sms/templates | Create sms template |
string SmsCancelAllPut ()
Update all scheduled message as cancelled
Update all scheduled message as cancelled
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsCancelAllPutExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
try
{
// Update all scheduled message as cancelled
string result = apiInstance.SmsCancelAllPut();
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsCancelAllPut: " + e.Message );
}
}
}
}
This endpoint does not need any parameter.
string
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsCancelByMessageIdPut (string messageId)
Update scheduled message as cancelled
Update scheduled message as cancelled
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsCancelByMessageIdPutExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
var messageId = messageId_example; // string | The message ID you want to cancel
try
{
// Update scheduled message as cancelled
string result = apiInstance.SmsCancelByMessageIdPut(messageId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsCancelByMessageIdPut: " + e.Message );
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
messageId | string | The message ID you want to cancel |
string
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsHistoryExportGet (string filename)
Export all sms history
Export all sms history
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsHistoryExportGetExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
var filename = filename_example; // string | Filename to download history as
try
{
// Export all sms history
string result = apiInstance.SmsHistoryExportGet(filename);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsHistoryExportGet: " + e.Message );
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
filename | string | Filename to download history as |
string
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsHistoryGet (string q = null, int? dateFrom = null, int? dateTo = null, int? page = null, int? limit = null)
Get all sms history
Get all sms history
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsHistoryGetExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
var q = q_example; // string | Custom query Example: from:{number},status_code:201. (optional)
var dateFrom = 56; // int? | Start date (optional)
var dateTo = 56; // int? | End date (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 history
string result = apiInstance.SmsHistoryGet(q, dateFrom, dateTo, page, limit);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsHistoryGet: " + e.Message );
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
q | string | Custom query Example: from:{number},status_code:201. | [optional] |
dateFrom | int? | Start date | [optional] |
dateTo | int? | End date | [optional] |
page | int? | Page number | [optional] [default to 1] |
limit | int? | Number of records per page | [optional] [default to 10] |
string
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsInboundGet (string q = null, int? page = null, int? limit = null)
Get all inbound sms
Get all inbound sms
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsInboundGetExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
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
string result = apiInstance.SmsInboundGet(q, page, limit);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsInboundGet: " + e.Message );
}
}
}
}
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] |
string
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsInboundPost (Url body)
Create inbound sms
Create inbound sms
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsInboundPostExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
var body = new Url(); // Url | Url model
try
{
// Create inbound sms
string result = apiInstance.SmsInboundPost(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsInboundPost: " + e.Message );
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
body | Url | Url model |
string
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsInboundReadByMessageIdPut (string messageId)
Mark inbound SMS as read
Mark specific inbound SMS as read
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsInboundReadByMessageIdPutExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
var messageId = messageId_example; // string | Message ID
try
{
// Mark inbound SMS as read
string result = apiInstance.SmsInboundReadByMessageIdPut(messageId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsInboundReadByMessageIdPut: " + e.Message );
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
messageId | string | Message ID |
string
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsInboundReadPut (DateBefore body = null)
Mark inbound SMS as read
Mark all inbound SMS as read optionally before a certain date
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsInboundReadPutExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
var body = new DateBefore(); // DateBefore | DateBefore model (optional)
try
{
// Mark inbound SMS as read
string result = apiInstance.SmsInboundReadPut(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsInboundReadPut: " + e.Message );
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
body | DateBefore | DateBefore model | [optional] |
string
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsPricePost (SmsMessageCollection body)
Calculate sms price
Calculate sms price
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsPricePostExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
var body = new SmsMessageCollection(); // SmsMessageCollection | SmsMessageCollection model
try
{
// Calculate sms price
string result = apiInstance.SmsPricePost(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsPricePost: " + e.Message );
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
body | SmsMessageCollection | SmsMessageCollection model |
string
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsReceiptsByMessageIdGet (string messageId)
Get a Specific Delivery Receipt
Get a Specific Delivery Receipt
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsReceiptsByMessageIdGetExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
var messageId = messageId_example; // string | Message ID
try
{
// Get a Specific Delivery Receipt
string result = apiInstance.SmsReceiptsByMessageIdGet(messageId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsReceiptsByMessageIdGet: " + e.Message );
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
messageId | string | Message ID |
string
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsReceiptsGet (int? page = null, int? limit = null)
Get all delivery receipts
Get all delivery receipts
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsReceiptsGetExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
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 delivery receipts
string result = apiInstance.SmsReceiptsGet(page, limit);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsReceiptsGet: " + e.Message );
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
page | int? | Page number | [optional] [default to 1] |
limit | int? | Number of records per page | [optional] [default to 10] |
string
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsReceiptsPost (Url body)
Add a delivery receipt
Add a delivery receipt
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsReceiptsPostExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
var body = new Url(); // Url | Url model
try
{
// Add a delivery receipt
string result = apiInstance.SmsReceiptsPost(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsReceiptsPost: " + e.Message );
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
body | Url | Url model |
string
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsReceiptsReadPut (DateBefore body = null)
Mark delivery receipts as read
Mark delivery receipts as read
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsReceiptsReadPutExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
var body = new DateBefore(); // DateBefore | DateBefore model (optional)
try
{
// Mark delivery receipts as read
string result = apiInstance.SmsReceiptsReadPut(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsReceiptsReadPut: " + e.Message );
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
body | DateBefore | DateBefore model | [optional] |
string
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsSendPost (SmsMessageCollection body)
Send sms message(s)
Send one or more SMS messages You can post up to 1000 messages with each API call. You can send to a mix of contacts and contact lists, as long as the total number of recipients is up to 1000. The response contains status and details for each recipient. Refer to Application Status Codes for the possible response message status strings.
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsSendPostExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
var body = new SmsMessageCollection(); // SmsMessageCollection | SmsMessageCollection model
try
{
// Send sms message(s)
string result = apiInstance.SmsSendPost(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsSendPost: " + e.Message );
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
body | SmsMessageCollection | SmsMessageCollection model |
string
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsTemplatesByTemplateIdDelete (int? templateId)
Delete sms template
Delete sms template
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsTemplatesByTemplateIdDeleteExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
var templateId = 56; // int? | Template id
try
{
// Delete sms template
string result = apiInstance.SmsTemplatesByTemplateIdDelete(templateId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsTemplatesByTemplateIdDelete: " + e.Message );
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
templateId | int? | Template id |
string
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsTemplatesByTemplateIdPut (SmsTemplate body, int? templateId)
Update sms template
Update sms template
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsTemplatesByTemplateIdPutExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
var body = new SmsTemplate(); // SmsTemplate | Template item
var templateId = 56; // int? | Template id
try
{
// Update sms template
string result = apiInstance.SmsTemplatesByTemplateIdPut(body, templateId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsTemplatesByTemplateIdPut: " + e.Message );
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
body | SmsTemplate | Template item | |
templateId | int? | Template id |
string
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsTemplatesGet (int? page = null, int? limit = null)
Get lists of all sms templates
Get lists of all sms templates
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsTemplatesGetExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
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 lists of all sms templates
string result = apiInstance.SmsTemplatesGet(page, limit);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsTemplatesGet: " + e.Message );
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
page | int? | Page number | [optional] [default to 1] |
limit | int? | Number of records per page | [optional] [default to 10] |
string
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string SmsTemplatesPost (SmsTemplate body)
Create sms template
Create sms template
using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;
namespace Example
{
public class SmsTemplatesPostExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new SMSApi();
var body = new SmsTemplate(); // SmsTemplate | SmsTemplate model
try
{
// Create sms template
string result = apiInstance.SmsTemplatesPost(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling SMSApi.SmsTemplatesPost: " + e.Message );
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
body | SmsTemplate | SmsTemplate model |
string
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]