Getting Started

Preparation

To meet the requirements of relevant departments, you must complete the following operations in the console before using the Skynoo SMS service.

Real Name Authentication

According to the requirements of the operator gateway, sending SMS requires real-name authentication. Unauthenticated individuals, enterprises, and organizations do not support custom template submissions and can only send ordinary verification code SMS.

Add SMS Template

Go to the console "International SMS-Template Reporting" to add a template. You can customize the template code to increase the readability of the template identifier. Notes:

1. The total length of the SMS body must be controlled within 460 characters. Special symbols such as 【】 and ★, ※, →, ●, etc., are not supported.
2. Variables are represented by #variable_name#, such as #code# #order_no#. Variable names are strings composed of letters, numbers, and underscores, with a length of less than 24 characters. The same variable can only appear once in the template. The format of short links combined with variables directly is not supported.

Send SMS

After completing the above work, you can call the Send SMS API to send SMS, see API Documentation.

Regions and Access Points

API General Description

Access Point

https://api.skynoo.com

See Regions and Access Points for more global access points.

Common Parameters

Common parameters are parameters that must be carried when calling the API request, uniformly set in the request header Header for transmission.

Authorization Code Generation Steps

1. Apply for apiKey and apiToken in the system background, encode with Base64, example as follows:

   "Basic " + Base64.getEncoder().encodeToString(( apiKey + ":" + apiToken).getBytes())

2. Add the authorization code as the value of Authorization in the request Header parameter and send the request. The final complete request example is as follows:

   HttpHeaders headers = new HttpHeaders();headers.set("Authorization", "Basic MTpmZWFiOTJhOTAyNjA0NzA1OWZjOTIyZDA5OTM3N2RmYg==");

Send SMS API

Use this interface to send text SMS to one or more recipients. Please read the API General Description before reading this document.

Easily send verification codes, transactional, and marketing SMS to any country globally. This interface provides a simple, flexible but comprehensive parameter input method to meet various SMS usage scenarios.

Interface Definition

• Interface Name：/api/sms/send
• HTTP Method：POST
• Content-Type：application/json

Request Parameters

Request Example

curl -X POST 'https://api.skynoo.com/api/sms/v1/send' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic MTpmZWFiOTJhOTAyNjA0NzA1OWZjOTIyZDA5OTM3N2RmYg==' \
-d '{
  "mobile": ["+16167265308"],
  "apiKey": "123",
  "text": "Dear customer your OTP for registration is 467355 Use this password to validate your login.",
  "useType": 1
}'

Response Parameters

Return Result data

Response Example

Successful Response Example

Status Code: 200, Response Body:

{
  "code": "200",
  "message": "Request successful",
  "data": [{
    "id": "8fc02cb2dbcdc500bf4056330bd6a312",
    "toNumber": "+16167265308",
    "status": "1"
  }]
}

Failed Response Example

Status Code: 200, Response Body:

{
  "code": "400",
  "message": "Number status is incorrect."
}

Get SMS Status API

Use this interface to get the sending status of SMS, up to 100 SMS sending statuses can be queried at a time. Please read the API General Description before reading this document.

Interface Definition

• Interface Name: /api/sms/getStatus
• HTTP Method: POST
• Content-Type: application/json

Request Parameters

Request Example

The following example queries the sending status of the sent SMS.

curl -X POST 'https://api.skynoo.com/api/sms/v1/getStatus' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic MTpmZWFiOTJhOTAyNjA0NzA1OWZjOTIyZDA5OTM3N2RmYg==' \
-d '{
  "apikey": "2373",
  "ids": ["0058380fd2c9a2082b90d2f6b94519bb","006ea531dce75738cdd4961bbffd8b62"]
}'

Response Parameters

Return Result data

Response Example

Successful Response Example

Status Code: 200, Response Body:

{
  "code": "200",
  "message": "Request successful",
  "data": [
    {
    "sid": "8fc02cb2dbcdc500bf4056330bd6a312",
    "errorCode": "",
    "status": "DELIVERED"
    },
    {
    "sid": "8fc02cb2dbcdc500bf4099330bd6a312",
    "errorCode": "",
    "status": "REJECTED"
    }
  ]
}

Failed Response Example

Status Code: 200, Response Body:

{
  "code": "400",
  "message": "Param Error."
}