快速上手

准备工作

为满足相关部门监管要求，在正式使用 Skynoo 短信服务前须进入控制台依次完成如下操作。

实名认证

应运营商网关要求，发送短信必须通过实名认证，未认证个人、企业、组织机构均不支持提交自定义模板，仅允许发送普通验证码短信。

添加短信模板

前往控制台「国际短信-模板报备」添加模板，可自定义短信模板编码以增加模板标识可读性，注意事项如下：

1. 短信正文总长度须控制在460个字符以内。不支持【】及★、 ※、 →、 ●等特殊符号。
2. 变量使用#变量名#表示，如 #code# #order_no# 等，变量名为字母、数字和下划线组成的字符串，长度须小于24个字符。同一个变量在模板中仅可出现一次，不支持短链接与变量直接组合的格式。

发送短信

在完成上述工作后，即可调用发送短信 API 发送短信，详见 API 文档。

区域及接入点

API 通用说明

接入点

https://api.skynoo.com

访问 区域及接入点 查看更多全球接入点。

公共参数

公共参数为调用 API 请求时必须携带的参数，统一设置到请求头Header里面传输。

鉴权码生成步骤

1. 在系统后台申请 apiKey 和 apiToken，以Base64进行编码，示例如下：

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

2. 将鉴权码作为 Authorization 的值增加到请求 Header 参数中发送请求，最终完整的请求示例如下：

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

发送短信 API

使用该接口发送文本短信至一个或多个收件人。阅读本文档前请先阅读 API 通用说明。

轻松地向全球任意国家的一个或多个收件人发送验证码、事务性和营销短信。该接口提供了简洁、灵活但全面的参数输入方式，以满足各种短信使用场景。

接口定义

• 接口名：/api/sms/send
• HTTP Method：POST
• Content-Type：application/json

请求参数

请求示例

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": "【极速网】您的验证码是823721，10分钟内有效。",
  "useType": 1
}'

响应参数

返回结果 data

响应示例

成功响应示例

Status Code: 200, Response Body:

{
  "code": "200",
  "message": "请求成功",
  "data": [{
    "id": "8fc02cb2dbcdc500bf4056330bd6a312",
    "toNumber": "+16167265308",
    "status": "1"
  }]
}

失败响应示例

Status Code: 200, Response Body:

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

获取短信状态 API

使用该接口获取短信的发送状态，每次最多只能查询100个短信发送状态。阅读本文档前请先阅读 API 通用说明。

接口定义

• 接口名: /api/sms/getStatus
• HTTP Method: POST
• Content-Type: application/json

请求参数

请求示例

以下示例将查询已发送的短信状态。

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"]
}'

响应参数

返回结果 data

响应示例

成功响应示例

Status Code: 200, Response Body:

{
  "code": "200",
  "message": "请求成功",
  "data": [
    {
    "sid": "8fc02cb2dbcdc500bf4056330bd6a312",
    "errorCode": "",
    "status": "DELIVERED"
    },
    {
    "sid": "8fc02cb2dbcdc500bf4099330bd6a312",
    "errorCode": "",
    "status": "REJECTED"
    }
  ]
}

失败响应示例

Status Code: 200, Response Body:

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