短信服务 API

提供发送短信验证码的功能，用于用户身份验证、操作确认等场景。

短信服务

短信服务API用于在各种需要验证用户身份或确认操作的场景下，发送短信验证码到用户手机。

重要提示： 调用本分类下所有接口时，请务必在 HTTP 请求 Header 中携带有效的 appId, accessToken, userId (操作人ID), 和 source (来源标识) 作为通用认证参数。关于 source 参数的详细说明和取值，请参考快速开始章节。文档中的请求示例将仅展示放入 Body 中的业务参数。

POST /sms/sendSmsVerifyCode 发送短信验证码

向指定手机号发送用于特定场景的短信验证码。

请求 Header (通用认证参数)

参数名类型必填描述
appIdstring是您的应用ID
accessTokenstring是有效访问令牌
userIdinteger (int64)是操作人用户ID (与本次操作关联的用户)

请求参数 (Body - 发送短信请求实体类)

参数名类型必填描述
mobilestring是接收短信的手机号码
smsTypestring是短信发送类型/场景标识，决定短信模板和用途。例如：
commSms (注册/登录验证)
sign (合同签名验证)
approval (合同审批通知/验证)
signPwd (修改签署密码验证)

请求示例

CURL
curl -X POST 'https://your-api-host.com/sms/sendSmsVerifyCode' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-d '{
  "mobile": "13800138000",
  "smsType": "sign"
}'

响应

成功响应 (200 OK)
错误响应
{
  "code": "200", // 根据 JSON 定义，成功是 "200"
  "msg": "成功",
  "data": {} // 成功发送通常不返回具体数据
}

错误码

HTTP状态码/业务码描述
200成功
400请求参数错误 (如手机号格式错误, smsType无效)
401未授权 (Token无效/过期)
403禁止访问 (权限不足)
429请求过于频繁 (触发限流)
500服务器内部错误 (短信通道发送失败等)
12XX具体短信业务错误 (如模板未配置、账户余额不足等)