检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
控制台-短消息配置(国内)-短消息签名管理-通道号”中获取。未填写时默认取模板所属签名通道号。 最小长度:1 最大长度:21 template_id 是 String 短信模板ID。 说明: 可以从“云消息服务KooMessage-管理控制台-短消息配置(国内)-短消息模板管理-模板ID”中获取。
发送分批短信 功能介绍 该接口用于向不同用户发送不同内容的短信。 前提条件 已创建短信应用。 已申请短信签名,获取签名通道号。 已申请短信模板,获取模板ID。 注意事项 单条短信最多允许携带500个号码,每个号码最大长度为21位。 URI POST /v1/aim/sms/diff-messages
创建短信签名 功能介绍 该接口用于用户创建短信签名。 URI POST /v1/sms/signatures 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口
修改短信签名 功能介绍 该接口用于用户修改短信签名信息,目前仅支持审核不通过的短信签名重新修改。 URI PUT /v1/sms/signatures/{signature_id} 表1 路径参数 参数 是否必选 参数类型 描述 signature_id 是 String 签名ID。
枚举值: CREATED:待上线。应用暂未创建成功,请稍候 SUSPENDED:暂停。无法发起业务请求。当客户所发短信内容触发业务违规,或客户申请退订短信业务时,运营经理会将客户短信应用暂停 LAUNCHED:正常。应用添加成功,可以正常使用 region String 地域。 最小长度:1
创建短信应用 功能介绍 该接口用于用户创建短信应用。 URI POST /v1/sms/apps 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消
修改短信应用 功能介绍 该接口用于用户修改短信应用。 URI PUT /v1/sms/apps/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用ID。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
查询短信模板 功能介绍 该接口用于用户查询已创建的短信模板。 URI GET /v1/sms/templates 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量。表示从偏移量开始查询,offset大于等于0。 缺省值:1 limit
枚举值: CREATED:待上线。应用暂未创建成功,请稍候 SUSPENDED:暂停。无法发起业务请求。当客户所发短信内容触发业务违规,或客户申请退订短信业务时,运营经理会将客户短信应用暂停 LAUNCHED:正常。应用添加成功,可以正常使用 region String 地域。 最小长度:1
获取短信模板详情 功能介绍 该接口用于用户获取已创建的短信模板详情。 URI GET /v1/sms/templates/{template_id} 表1 路径参数 参数 是否必选 参数类型 描述 template_id 是 String 短信模板ID。 请求参数 表2 请求Header参数
创建短信模板 功能介绍 该接口用于用户创建短信模板。 URI POST /v1/sms/templates 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获
删除短信模板 功能介绍 该接口用于用户删除已创建的短信模板。 URI DELETE /v1/sms/templates/{template_id} 表1 路径参数 参数 是否必选 参数类型 描述 template_id 是 String 短信模板ID。 请求参数 表2 请求Header参数
修改短信模板 功能介绍 该接口用于用户修改短信模板信息,目前仅支持审核不通过的短信模板重新修改。 URI PUT /v1/sms/templates/{template_id} 表1 路径参数 参数 是否必选 参数类型 描述 template_id 是 String 短信模板ID。
查询短信签名 功能介绍 该接口用于用户查询已创建的短信签名。 URI GET /v1/sms/signatures 表1 Query参数 参数 是否必选 参数类型 描述 app_name 否 String 应用名称。 signature_id 否 String 签名ID。 signature_name
获取短信签名详情 功能介绍 该接口用于用户获取已创建的短信签名详情。 URI GET /v1/sms/signatures/{signature_id} 表1 路径参数 参数 是否必选 参数类型 描述 signature_id 是 String 签名ID。 请求参数 表2 请求Header参数
删除短信签名 功能介绍 该接口用于用户删除已创建的短信签名。删除已审核通过的签名,会同步删除该签名对应的通道号和该签名下的所有短信模板,请谨慎操作。 URI DELETE /v1/sms/signatures/{signature_id} 表1 路径参数 参数 是否必选 参数类型
查询短信模板变量 功能介绍 该接口用于用户查询短信模板变量。 URI GET /v1/sms/templates/{template_id}/variable 表1 路径参数 参数 是否必选 参数类型 描述 template_id 是 String 短信模板ID。 请求参数 表2
短信应用 创建短信应用 查询短信应用 获取短信应用详情 修改短信应用 父主题: API
短信发送 发送短信 发送分批短信 父主题: API
请求体参数类型,该字段必须设置为:multipart/form-data。 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 FormData参数 参数 是否必选 参数类型 描述 file 是 File