创建 OTP 发送任务

功能简述

支持为手机号码发送一条包含 OTP 验证码的短信，用以验证该手机号的合法性。

手机号码规则

OTP 类型：

• stcpay

支持以下手机号码格式：5xxxxxxxx、9665xxxxxxxx、+9665xxxxxxxx、05xxxxxxxx

相同手机号码，使用不同格式进行请求发送，以生效手机号码为准。例如：

请求手机号码	生效手机号码
512345678	512345678
0512345678	512345678
966512345678	512345678
+966512345678	512345678

验证码规则

• 验证码：随机 6 位数字，会出现以 0 开头的数字。
• 验证码有效期：5 分钟。
• 验证码频率：同一生效的手机号码，一分钟内只能发送 1 次。

测试号码

注意

测试号码只支持沙箱环境使用，生产环境所有格式验证通过的手机号码都会正常进行短信发送。

联调测试可以使用测试号码进行测试，测试号码不会真实发送短信，其他号码系统会尝试进行短信发送。

测试号码的验证码和返回的 sessionid 保持不变。

测试号码	验证码	sessionid
512345678 0512345678 966512345678 +966512345678	123456	10290d703f8254593ff93533f00af153
500000001 0500000001 966500000001 +966500000001	123456	a3f551d80f05a0e3e9056869fda18485
500000002 0500000002 966500000002 +966500000002	123456	e8cffbb22c2e09af7004c92b82a4275f
500000003 0500000003 966500000003 +966500000003	123456	05121e9b019b6ac4bd938322dcaf73ef
500000004 0500000004 966500000004 +966500000004	123456	9e1aac7c1f6719e12e3384ced6782887
500000005 0500000005 966500000005 +966500000005	123456	c6cfc53d34b2c93eaaa9d430397dead0

验证码模版

OTP 类型：

• stcpay

{CODE} is OTP to varify your STCPAY account , please input within {ECPIRY} minutes. - {APP_NAME}

变量	类型	说明
{CODE}	string	验证码
{ECPIRY}	number	过期时间，单位：分
{APP_NAME}	string	产品名称

创建 OTP 发送任务 API

请求 URL

• /otp/sendOtp

请求方式

• POST

请求参数

请求参数如下：

• Header

  • 查看请求/响应头

• Request Body

参数	必填	类型	默认值	描述
mobile	是	string	-	发送验证的手机号码，长度限制 13 字符
appname	是	string	-	产品名称，长度限制 32 字符

响应参数

响应参数如下：

• Response Body

参数名	类型	描述
mobile	string	发送手机号码
appname	string	产品名称
sessionid	string	OTP 发送凭证

响应参数示例

{
    "code": 200,
    "message": "Request succeeded.",
    "data": {
        "mobile": "+966512345678",
        "appname": "TestApp",
        "sessionid": "10290d703f8254593ff93533f00af153"
    },
    "sensitiveFields": {},
    "requestId": "758EFC622B2D51B4C37353D4C8BEA374"
}