API文档

发送短信

描述

短信发送接口,用户给用户发短信验证码、通知类短信。

注意:

  1. 对一个手机号码发送同一模板短信,每天不能超过10条;
  2. 短信长度(签名+正文)不超过70字,按照一条短信计费;超过70字即为长短信时,按67字/条分隔成多条计费。例如,短信长度为150字,则按照67字/67字/16字分隔成3条计费。

    接口地址

    1. /sms/sendSms

    HTTP METHOD

    POST

    HTTP BODY编码格式

    application/x-www-form-urlencoded

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

名称 类型 是否必填 说明
phone string 手机号码,多个手机号码用逗号(,)分隔
templateCode string 模板编号
templateVars string 模板变量

注意:
在一次请求中,最多可以向1000个手机号码发送同样内容的短信;

返回结果

名称 类型 说明
code int 错误码
RequestId string 唯一请求 ID,每次请求都会返回。
message string 结果描述
data Array 短信发送结果数据

data字段详情

名称 类型 说明
phone string 手机号码
result string 短信发送结果
message string 短信发送结果描述
sn string 发送流水号

请求示例

  1. curl -X POST \
  2. "https://api.yisu.com/sms/sendSms" \
  3. -H "content-type: application/x-www-form-urlencoded" \
  4. -d "accessId=abcdefghijklmnop&nonce=48693365&phone=13800000000&templateCode=100001&templateVars=%7B%22code%22%3A123123%7D×tamp=1577777585&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D"

返回示例

  1. {
  2. "code":14105,
  3. "message":"签名错误",
  4. "requestId":"9754efdccd3283c551531a501d671c8a"
  5. }