International Messaging

Select Countries for Global Sending

Request

Select Countries

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.

Properties

Name	Type	Required	Restrictions	Description
country_list_ids	number	true	none	Country list ID's

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Security

basicAuth

Bodyapplication/json

country_list_idsArray of integers

Example: [1]

curl --location --request POST 'https://rest.clicksend.com/v3/user-countries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==' \
--data '{
  "country_list_ids": [1, 2]
}'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Here are your countries selection."

dataArray of objects(global_sending)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Here are your countries selection.",
  "data": [
    { … }
  ]
}

Get Countries for Global Sending

Request

Get Countries for global sending

Get the list of selected countries.

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Security

basicAuth

curl --location 'https://rest.clicksend.com/v3/user-countries' \
--header 'Authorization: Bearer YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==' \

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Here are your countries selection."

dataArray of objects(global_sending)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Here are your countries selection.",
  "data": [
    { … }
  ]
}

Agree to rules and regulation

Request

Update Country Rule

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

Properties

Name	Type	Required	Restrictions	Description
country_list_ids	number	true	none	Country list ID's

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Security

basicAuth

Body

curl --location --request POST 'https://rest.clicksend.com/v3/user-countries/agree' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==' \

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Here are your countries selection."

dataArray of objects(global_sending)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Here are your countries selection.",
  "data": [
    { … }
  ]
}

International Messaging

Request

List of countries

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

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Security

basicAuth

curl --location 'https://rest.clicksend.com/v3/country-list' \
--header 'Authorization: Bearer YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==' \

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "List of Countries."

dataArray of objects

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "List of Countries.",
  "data": [
    { … }
  ]
}

View Countries

Request

Get all country codes

Get all countries

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint does not require authentication

curl --include \
'https://rest.clicksend.com/v3/countries'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "List of Countries."

dataArray of objects(country)

Example: [{"code":"AF","value":"Afghanistan"},{"code":"AU","value":"Australia"},{"code":"FI","value":"Finland"}]

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "List of Countries.",
  "data": [
    { … },
    { … },
    { … }
  ]
}

Timezones

Request

Get supported list of timezones.

Get supported list of timezones.

Parameters

Parameter	In	Type	Required	Description
page	query	integer(int32)	false	Page number
limit	query	integer(int32)	false	Number of records per page

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Security

basicAuth

Headers

Content-Typestring

Example: application/json

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/timezones'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "List of timezones."

dataArray of strings

Example: ["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","etc..."]

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "List of timezones.",
  "data": [
    "Africa/Abidjan",
    "Africa/Accra",
    "Africa/Addis_Ababa",
    "Africa/Algiers",
    "Africa/Asmara",
    "Africa/Asmera",
    "Africa/Bamako",
    "Africa/Bangui",
    "Africa/Banjul",
    "Africa/Bissau",
    "Africa/Blantyre",
    "Africa/Brazzaville",
    "Africa/Bujumbura",
    "Africa/Cairo",
    "Africa/Casablanca",
    "Africa/Ceuta",
    "Africa/Conakry",
    "Africa/Dakar",
    "Africa/Dar_es_Salaam",
    "Africa/Djibouti",
    "etc..."
  ]
}

International Messaging

Select Countries for Global Sending

Request

Properties

Responses

Was this helpful?

Get Countries for Global Sending

Request

Responses

Was this helpful?

Agree to rules and regulation

Request

Properties

Responses

Was this helpful?

International Messaging

Request

Responses

Was this helpful?

View Countries

Request

Responses

Was this helpful?

Timezones

Request

Parameters

Responses

Was this helpful?