发送短信验证码-SendSmsVerificationCode

功能介绍

企业主账号在自建平台发送短信验证码。

接口约束

该接口只允许使用企业主账号AK/SK或者Token调用。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

当前API调用无需授权。

URI

POST /v2/enterprises/multi-accounts/sm-verification-code

请求消息

请求参数

参数	是否必选	参数类型	取值范围	描述
mobile_phone	是	String	最大长度：20	接收短信验证码的手机号码。
timeout	否	Integer	[1-100]	超时时间，此参数不携带或携带值为null，取默认值10分钟；不支持携带值为空串。单位：分钟此参数时间超60分钟时，取值固定为5分钟。
language	否	String	最大长度：5	发送的短信的语言。 zh-cn: 中文 en-us: 英语默认为偏好设置的默认语言。此参数不携带或携带值为null时，取偏好设置的默认语言；不支持携带值为空串。
sm_template_args	是	List<TemplateArgs>	最大长度：6	短信发送模板中的变量，具体参见表1。若传入多个TemplateArgs，且key的值相同，只有第一个模板参数及模板参数值生效。

表1 TemplateArgs
参数	是否必选	参数类型	取值范围	描述
key	是	String	最大长度：64	模板参数名。目前仅支持sub_customer_name：表明企业主创建企业子的名字。
value	是	String	最大长度：255	模板参数值。 key对应的取值。

请求示例

POST https://bss.myhuaweicloud.com/v2/enterprises/multi-accounts/sm-verification-code HTTP/1.1
Content-Type: application/json
X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
    "sm_template_args": [
        {
            "value": "sub***001",
            "key": "sub_customer_name"
        }
    ],
    "mobile_phone": "188****8888",
    "language": "zh-cn",
    "timeout": 10
}

响应消息

响应参数

参数	参数类型	取值范围	描述
error_code	String	最大长度：20	状态码。具体请参考状态码。只有失败才返回该字段。
error_msg	String	最大长度：1000	错误描述信息。只有失败才返回该字段。

响应示例

HTTP/1.1 204 Not Content
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time

状态码

状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。
状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。

HTTP状态码	错误码	错误描述
400	CBC.0100	参数错误。
400	CBC.70300008	非企业主不能发送短信验证码。
400	CBC.99000082	客户发送验证码次数超出限制。
400	CBC.99004003	验证码生成成功但发送失败。
403	CBC.0151	访问拒绝。
500	CBC.0999	其他错误。