SMS API Documentation

Documentation

Table of Contents:
  1. SMS API
    1. What is this API used for?
    2. Which countries are supported?
    3. How do I send an SMS?
    4. How do I send an SMS at a specific time?
    5. What is a Contact List?
    6. How to create a contact list
    7. Getting a list of all your Contact Lists
    8. Adding a number to a contact list
    9. Removing a number from a contact list
    10. Get a list of all the numbers on a contact list
    11. Sending an SMS to a Contact List

1. SMS API

a. What is this API used for?

To send SMS's to various cellphones networks across the globe.

b. Which countries are supported?

Our API can be used to send to the following countries:

  • Afghanistan
  • Albania
  • Algeria
  • Andorra
  • Anguilla
  • Antigua and Barbuda
  • Argentina
  • Armenia
  • Aruba
  • Australia
  • Austria
  • Azerbaijan
  • Bahamas
  • Bahrain
  • Bangladesh
  • Barbados
  • Belarus
  • Belgium
  • Belize
  • Bermuda
  • Bhutan
  • Bolivia
  • Bosnia and Herzegovina
  • Botswana
  • Brazil
  • Brunei
  • Bulgaria
  • Burkina Faso
  • Burundi
  • Cambodia
  • Cameroon
  • Canada
  • Cape Verde
  • Cayman Islands
  • Central African Republic
  • Chad
  • Chile
  • China
  • Colombia
  • Comoros
  • Cook Islands
  • Costa Rica
  • Croatia
  • Cyprus
  • Czechia (Czech Republic)
  • Democratic Republic of the Congo
  • Denmark
  • Djibouti
  • Dominican Republic
  • Dominican Republic
  • Dominican Republic
  • Ecuador
  • Egypt
  • El Salvador
  • Equitorial Guinea
  • Eritrea
  • Estonia
  • Ethiopia
  • Faroe Islands
  • Fiji
  • Finland
  • France
  • French Guiana
  • French Polynesia
  • Gabon
  • Gambia
  • Georgia
  • Germany
  • Ghana
  • Gibraltar
  • Greece
  • Greenland
  • Grenada
  • Guadeloupe
  • Guam
  • Guatemala
  • Guernsey
  • Guinea
  • Guinea-Bissau
  • Guyana
  • Honduras
  • Hong Kong
  • Hungary
  • Iceland
  • India
  • Indonesia
  • Iraq
  • Ireland
  • Isle of Man
  • Israel
  • Italy
  • Ivory Coast
  • Jamaica
  • Japan
  • Jersey
  • Jordan
  • Kazakhstan
  • Kenya
  • Kuwait
  • Kyrgyzstan
  • Laos
  • Latvia
  • Lebanon
  • Lesotho
  • Liberia
  • Libya
  • Liechtenstein
  • Lithuania
  • Luxembourg
  • Macau
  • Macedonia
  • Madagascar
  • Malawi
  • Malaysia
  • Maldives
  • Mali
  • Malta
  • Marshall Islands, The
  • Martinique
  • Mauritania
  • Mauritius
  • Mayotte
  • Mexico
  • Micronesia (Federated States of)
  • Moldova
  • Monaco
  • Mongolia
  • Montenegro
  • Montserrat
  • Morocco
  • Mozambique
  • Myanmar
  • Namibia
  • Namibia
  • Nepal
  • Netherlands
  • New Caledonia
  • New Zealand
  • Nicaragua
  • Niger
  • Nigeria
  • Niue
  • Norway
  • Oman
  • Pakistan
  • Palestine
  • Panama
  • Papua New Guinea
  • Paraguay
  • Peru
  • Philippines
  • Poland
  • Portugal
  • Puerto Rico
  • Puerto Rico
  • Qatar
  • Republic of the Congo
  • Reunion
  • Romania
  • Rwanda
  • Saint Kitts and Nevis
  • Saint Lucia
  • Samoa
  • San Marino
  • Sao Tome and Principe
  • Saudi Arabia
  • Senegal
  • Serbia
  • Seychelles
  • Sierra Leone
  • Singapore
  • Slovakia
  • Slovenia
  • Solomon Islands
  • Somalia
  • South Africa
  • South Africa
  • South Korea
  • South Sudan
  • Spain
  • Sri Lanka
  • Suriname
  • Swaziland
  • Sweden
  • Switzerland
  • Taiwan
  • Tajikistan
  • Thailand
  • Timor-Leste
  • Togo
  • Tonga
  • Trinidad and Tobago
  • Tunisia
  • Turkey
  • Turkmenistan
  • Turks and Caicos Islands
  • Tuvalu
  • Uganda
  • Ukraine
  • United Arab Emirates (UAE)
  • United Kingdom
  • United States
  • Uruguay
  • Uzbekistan
  • Vanuatu
  • Venezuela
  • Vietnam
  • Virgin Islands, British
  • Virgin Islands, US
  • Yemen
  • Zambia
  • Zimbabwe

Country not listed here? Contact us and we might be able to add the country.

c. How do I send an SMS?

You can call the API as follows: 

https://www.completeapi.com/v1/[api_key]/sms/[cellphone_number]?message=[url_encoded_message]

A typical JSON Response would look as follows: 

{
  api: "CompleteAPI.com",
  api_version: "1.1",
  status: "",
  errors: [ ],
  success: true,
  credit_used: 0.4,
  credit_remaining: 458.2,
  successCode: 900,
  successMessage: "Success. Message successfully queued for sending."
}

d. How do I send an SMS at a specific time?

It is possible to schedule the SMS for a specific time by including a timestamp. For example, if you want the SMS to be sent on 3 May 2025, you could use the timestamp "1746223200" like this: 

https://www.completeapi.com/v1/[api_key]/sms/[cellphone_number]?message=[url_encoded_message]&sendAt=[timestamp]

e. What is a Contact List?

A contact list is a list of several cellphone numbers. These lists can be used to send one single message to multiple recipients.

f. How to create a contact list

You can call the API as follows: 

https://www.completeapi.com/v1/[api_key]/sms/contactLists/create/[name]

g. Getting a list of all your Contact Lists

You can call the API as follows: 

https://www.completeapi.com/v1/[api_key]/sms/contactLists/get

h. Adding a number to a contact list

You can call the API as follows: 

https://www.completeapi.com/v1/[api_key]/sms/contactLists/[contact_list_id]/add/[number]

i. Removing a number from a contact list

You can call the API as follows: 

https://www.completeapi.com/v1/[api_key]/sms/contactLists/[contact_list_id]/remove/[number]

j. Get a list of all the numbers on a contact list

You can call the API as follows: 

https://www.completeapi.com/v1/[api_key]/sms/contactLists/[contact_list_id]

k. Sending an SMS to a Contact List

You can call the API as follows: 

https://www.completeapi.com/v1/[api_key]/sms/[list_id]?message=[url_encoded_message]

A typical JSON Response would look as follows: 

{
  api: "CompleteAPI.com",
  api_version: "1.1",
  status: "",
  errors: [ ],
  success: true,
  credit_used: 0.4,
  credit_remaining: 458.2,
  successCode: 900,
  successMessage: "Success. Message successfully queued for sending."
}