Skip to content

Latest commit

 

History

History
314 lines (250 loc) · 13.9 KB

TransactionalSMSApi.md

File metadata and controls

314 lines (250 loc) · 13.9 KB
Raw

sib_api_v3_sdk.Api.TransactionalSMSApi

All URIs are relative to https://api.sendinblue.com/v3

Method HTTP request Description
GetSmsEvents GET /transactionalSMS/statistics/events Get all your SMS activity (unaggregated events)
GetTransacAggregatedSmsReport GET /transactionalSMS/statistics/aggregatedReport Get your SMS activity aggregated over a period of time
GetTransacSmsReport GET /transactionalSMS/statistics/reports Get your SMS activity aggregated per day
SendTransacSms POST /transactionalSMS/sms Send SMS message to a mobile number

GetSmsEvents

GetSmsEventReport GetSmsEvents (long? limit = null, string startDate = null, string endDate = null, long? offset = null, long? days = null, string phoneNumber = null, string _event = null, string tags = null, string sort = null)

Get all your SMS activity (unaggregated events)

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetSmsEventsExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalSMSApi();
            var limit = 789;  // long? | Number of documents per page (optional)  (default to 50)
            var startDate = startDate_example;  // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) 
            var endDate = endDate_example;  // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) 
            var offset = 789;  // long? | Index of the first document of the page (optional)  (default to 0)
            var days = 789;  // long? | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) 
            var phoneNumber = phoneNumber_example;  // string | Filter the report for a specific phone number (optional) 
            var _event = _event_example;  // string | Filter the report for specific events (optional) 
            var tags = tags_example;  // string | Filter the report for specific tags passed as a serialized urlencoded array (optional) 
            var sort = sort_example;  // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional)  (default to desc)

            try
            {
                // Get all your SMS activity (unaggregated events)
                GetSmsEventReport result = apiInstance.GetSmsEvents(limit, startDate, endDate, offset, days, phoneNumber, _event, tags, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalSMSApi.GetSmsEvents: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
limit long? Number of documents per page [optional] [default to 50]
startDate string Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report [optional]
endDate string Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report [optional]
offset long? Index of the first document of the page [optional] [default to 0]
days long? Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' [optional]
phoneNumber string Filter the report for a specific phone number [optional]
_event string Filter the report for specific events [optional]
tags string Filter the report for specific tags passed as a serialized urlencoded array [optional]
sort string Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed [optional] [default to desc]

Return type

GetSmsEventReport

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTransacAggregatedSmsReport

GetTransacAggregatedSmsReport GetTransacAggregatedSmsReport (string startDate = null, string endDate = null, long? days = null, string tag = null)

Get your SMS activity aggregated over a period of time

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetTransacAggregatedSmsReportExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalSMSApi();
            var startDate = startDate_example;  // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) 
            var endDate = endDate_example;  // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) 
            var days = 789;  // long? | Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional) 
            var tag = tag_example;  // string | Filter on a tag (optional) 

            try
            {
                // Get your SMS activity aggregated over a period of time
                GetTransacAggregatedSmsReport result = apiInstance.GetTransacAggregatedSmsReport(startDate, endDate, days, tag);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalSMSApi.GetTransacAggregatedSmsReport: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
startDate string Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report [optional]
endDate string Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report [optional]
days long? Number of days in the past including today (positive integer). Not compatible with startDate and endDate [optional]
tag string Filter on a tag [optional]

Return type

GetTransacAggregatedSmsReport

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTransacSmsReport

GetTransacSmsReport GetTransacSmsReport (string startDate = null, string endDate = null, long? days = null, string tag = null, string sort = null)

Get your SMS activity aggregated per day

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetTransacSmsReportExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalSMSApi();
            var startDate = startDate_example;  // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) 
            var endDate = endDate_example;  // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) 
            var days = 789;  // long? | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) 
            var tag = tag_example;  // string | Filter on a tag (optional) 
            var sort = sort_example;  // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional)  (default to desc)

            try
            {
                // Get your SMS activity aggregated per day
                GetTransacSmsReport result = apiInstance.GetTransacSmsReport(startDate, endDate, days, tag, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalSMSApi.GetTransacSmsReport: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
startDate string Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report [optional]
endDate string Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report [optional]
days long? Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' [optional]
tag string Filter on a tag [optional]
sort string Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed [optional] [default to desc]

Return type

GetTransacSmsReport

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SendTransacSms

SendSms SendTransacSms (SendTransacSms sendTransacSms)

Send SMS message to a mobile number

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class SendTransacSmsExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalSMSApi();
            var sendTransacSms = new SendTransacSms(); // SendTransacSms | Values to send a transactional SMS

            try
            {
                // Send SMS message to a mobile number
                SendSms result = apiInstance.SendTransacSms(sendTransacSms);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalSMSApi.SendTransacSms: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
sendTransacSms SendTransacSms Values to send a transactional SMS

Return type

SendSms

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]