开放平台

在这里，您可以调用短信宝接口进行短信的发送。

WARNING

本功能属于增值服务，您需订购此项服务后，才可使用本功能。
如需在付费前进行试用：您需支付1元即可试用3天。

调用说明

method

统一为 POST

content-type

统一为 application/json; charset=utf-8

token

开放者token通过 header 传输, key 是 Open-Token

body

统一传输格式是 json ，若接口无参数需传一个空json {}

示例

shell

curl -X "POST" "https://APIHOST/PATH" \
     -H 'Open-Token: openxxx' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{}'

Token相关

开发者token，可用来调用短信宝开放平台接口。token有效期与开发者服务有效期相同（成功生成新token后，旧token将在一个小时后到期）

生成token

有两种方式来生成token。如果是首次生成token，请在短信宝后台生成

在短信宝后台生成

进入短信宝后台，左侧点击开放平台 ，点击点此生成新 token

通过接口调用来生成

如果还没有token，请在短信宝后台进行生成
请求路径: /open/token/create
请求参数: 无

shell

## 生成token
curl -X "POST" "https://APIHOST/open/token/create" \
     -H 'Open-Token: opendxxx' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{}'

查看生效中的token

请求路径: /open/token/list
请求参数: 无

shell

## token 列表
curl -X "POST" "https://APIHOST/open/token/list" \
     -H 'Open-Token: opendxxx' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{}'

发送短信

通过手机号来发送

通过真实手机号发送短信。
支持带变量发送，可在短信内带上自定义变量，格式为#变量名#，例如#code#。在参数map中传入变量名及变量值，详见下发说明及示例。
请求路径: /open/send/mobile
请求参数:

字段	类型	含义	示例
templateId	Long	模版ID	1999
list	List	发送对象列表

list

字段	类型	含义	示例
map	object	发送对象

map

字段	类型	含义	示例
mobile	string	手机号	13800138000
code	string	短信内自定义字段1	helloworld

shell

## send mobile
curl -X "POST" "https://APIHOST/open/send/mobile" \
     -H 'Open-Token: opendxxx' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "templateId": 1999,
  "list": [
    {
      "map": {
        "mobile": "13800138000",
        "code": "helloworld"
      }
    }
  ]
}

通过订单号来发送

如果您没有真实手机号，可通过当前店铺的订单号来给收件人发送短信（仅限于订购短信宝基础服务之后产生的新订单，历史订单不支持发送）。
支持带变量发送，可在短信内带上自定义变量，格式为#变量名#，例如#code#。在参数map中传入变量名及变量值，详见下发说明及示例。
请求路径: /open/send/order
请求参数:

字段	类型	含义	示例
templateId	Long	模版ID	1999
list	List	发送对象列表

list

字段	类型	含义	示例
map	object	发送对象

map

字段	类型	含义	示例
orderNo	string	订单号	6572829102878993
code	string	自定义字段1	helloworld

shell

## send mobile
curl -X "POST" "https://APIHOST/open/send/order" \
     -H 'Open-Token: opendxxx' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "templateId": 1999,
  "list": [
    {
      "map": {
        "orderNo": "13800138000",
        "code": "helloworld"
      }
    }
  ]
}

查询发送的短信

通过手机号来查询

通过真实手机号，查询发送的记录（仅支持查询最近5条发送记录，更多记录请通过后台查询。若平台加密手机号则无法通过此接口查询到）
请求路径: /open/query/mobile
请求参数:

字段	类型	含义	示例
mobile	String	手机号	13800138000

响应参数:

字段	类型	含义	示例
status	String	状态	0:待执行,1:执行中,2:已执行
description	String	状态描述	发送成功
content	String	短信内容	xxxx
num	Integer	短信计费条数	2
reportedAt	Long	短信回执时间	1737624410
createdAt	Long	创建时间	1737624310

shell

## query mobile
curl -X "POST" "https://APIHOST/open/query/mobile" \
     -H 'Open-Token: opendxxx' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "mobile": "13800138000"
}

通过订单号来查询

通过订单号，查询发送的记录（仅支持查询最近5条发送记录，更多记录请通过后台查询）
请求路径: /open/query/order
请求参数:

字段	类型	含义	示例
orderNo	String	订单号	3311122392878

响应参数:

字段	类型	含义	示例
eventSource	String	触发场景时间来源(一般是订单号)	3311122392878
status	String	状态	0:待执行,1:执行中,2:已执行
description	String	状态描述	发送成功
content	String	短信内容	xxxx
num	Integer	短信计费条数	2
reportedAt	Long	短信回执时间	1737624410
createdAt	Long	创建时间	1737624310

shell

## query mobile
curl -X "POST" "https://APIHOST/open/query/mobile" \
     -H 'Open-Token: opendxxx' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "orderNo": "3311122392878"
}

常见问题

token有效期？
- token有效期与开发者服务有效期相同
- 成功生成新token后，旧token将在一个小时后到期
APIHOST具体是什么？
- 请在短信宝后台「开放平台」查看
自定义变量名可以是什么？
- 目前一个短信模版支持的变量，需要通过 场景通知 来新建，可点选页面上支持的变量
templateId 如何获取？
- 短信宝后台的 短信模版 列表可以获取到，审核通过的可以正常使用，未审核通过无法使用

开放平台 ​

调用说明 ​

method ​

content-type ​

token ​

body ​

示例 ​

Token相关 ​

生成token ​

在短信宝后台生成 ​

通过接口调用来生成 ​

查看生效中的token ​

发送短信 ​

通过手机号来发送 ​

通过订单号来发送 ​

查询发送的短信 ​

通过手机号来查询 ​

通过订单号来查询 ​

常见问题 ​

开放平台

调用说明

method

content-type

token

body

示例

Token相关

生成token

在短信宝后台生成

通过接口调用来生成

查看生效中的token

发送短信

通过手机号来发送

通过订单号来发送

查询发送的短信

通过手机号来查询

通过订单号来查询

常见问题