GlobalSendingApi.md

IO.ClickSend.ClickSend.Api.GlobalSendingApi

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

Method	HTTP request	Description
ListCountriesGet	GET /country-list	List of countries
UserCountriesAgreePost	POST /user-countries/agree	Agree to rules and regulation
UserCountriesGet	GET /user-countries	Get Countries for Global Sending
UserCountriesPost	POST /user-countries	Select Countries for Global Sending

ListCountriesGet

string ListCountriesGet ()

List of countries

List of countries with IDs that can be used in selecting countries for Global sending.

Example

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

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

            var apiInstance = new GlobalSendingApi();

            try
            {
                // List of countries
                string result = apiInstance.ListCountriesGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GlobalSendingApi.ListCountriesGet: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

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]

UserCountriesAgreePost

string UserCountriesAgreePost ()

Agree to rules and regulation

To agree on rules and regulations of selected countries and confirm selection.

Example

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

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

            var apiInstance = new GlobalSendingApi();

            try
            {
                // Agree to rules and regulation
                string result = apiInstance.UserCountriesAgreePost();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GlobalSendingApi.UserCountriesAgreePost: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

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]

UserCountriesGet

string UserCountriesGet ()

Get Countries for Global Sending

Get the list of selected countries.

Example

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

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

            var apiInstance = new GlobalSendingApi();

            try
            {
                // Get Countries for Global Sending
                string result = apiInstance.UserCountriesGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GlobalSendingApi.UserCountriesGet: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

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]

UserCountriesPost

string UserCountriesPost (CountryListIds body)

Select Countries for Global Sending

Use this endpoint to select countries that you intend to send sms / mms to. To remove / unselect a country, just remove the country id from the array in the payload.

Example

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

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

            var apiInstance = new GlobalSendingApi();
            var body = new CountryListIds(); // CountryListIds | Id of countr(ies) you want to select, you can get them from GET /country-list response

            try
            {
                // Select Countries for Global Sending
                string result = apiInstance.UserCountriesPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GlobalSendingApi.UserCountriesPost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	CountryListIds	Id of countr(ies) you want to select, you can get them from GET /country-list response

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]