检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前必读 概述 调用说明 终端节点 约束与限制 基本概念
获取短信应用详情 功能介绍 该接口用于用户获取已创建的短信应用详情。 URI GET /v1/sms/apps/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用ID。 请求参数 表2 请求Header参数 参数 是否必选 参数类型
pub_name 否 String 服务号名称。 说明: type=1时,此字段作为过滤条件 type=0时,不作为过滤条件 最小长度:0 最大长度:64 is_bind 否 Integer 绑定状态。 0:未绑定 1:已绑定 说明: type=0时,此字段作为过滤条件 type=1时,不作为过滤条件
上传申请文件 功能介绍 该接口用于用户上传创建短信签名所需的营业执照/授权委托书文件。 URI POST /v1/sms/signatures/files 表1 Query参数 参数 是否必选 参数类型 描述 file_desc 否 String 文件描述。 请求参数 表2 请求Header参数
定义智能信息基础版模板状态回执 功能介绍 用户按接口定义实现智能信息基础版模板状态回执接口。 响应参数仅供参考,客户可以返回任意响应消息给平台,平台不会对响应消息处理。 URI POST /v1/aim-basic/template-status 请求参数 表1 请求Body参数
String 服务号LOGO图片ID。 说明: 通过上传智能信息服务号图片资源接口上传LOGO图片后获得的图片resource_id。图片要求大于等于240*240且比例相同。 最小长度:32 最大长度:32 pub_name 是 String 服务号名称。 说明: 同一个企业下可以相同,不同企业下不能重复。
查询短信模板 功能介绍 该接口用于用户查询已创建的短信模板。 URI GET /v1/sms/templates 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量。表示从偏移量开始查询,offset大于等于0。 缺省值:1 limit
删除短信模板 功能介绍 该接口用于用户删除已创建的短信模板。 URI DELETE /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接口获取(响应消息
请求体参数类型,该字段必须设置为:application/json。 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表2 请求Body参数 参数 是否必选 参数类型 描述 material_ids
修改短信应用 功能介绍 该接口用于用户修改短信应用。 URI PUT /v1/sms/apps/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用ID。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
查询申请文件 功能介绍 该接口用于用户查询创建短信签名时上传的营业执照/授权委托书文件信息。 URI GET /v1/sms/signatures/files 表1 Query参数 参数 是否必选 参数类型 描述 file_id 是 String 营业执照/授权委托书文件ID。 offset
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 KM.00001075 短信签名为空 短信签名为空 请检查并在更改错误参数后重试 400 KM.00001076 短信签名的长度范围在1-18个字符之间
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 status
修改短信模板 功能介绍 该接口用于用户修改短信模板信息,目前仅支持审核不通过的短信模板重新修改。 URI PUT /v1/sms/templates/{template_id} 表1 路径参数 参数 是否必选 参数类型 描述 template_id 是 String 短信模板ID。
注册智能信息基础版回执URL 功能介绍 用户根据要求创建智能信息基础版回执接口后,可以调用此接口进行注册。 URI POST /v1/aim-basic/callbacks 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
删除短信签名 功能介绍 该接口用于用户删除已创建的短信签名。删除已审核通过的签名,会同步删除该签名对应的通道号和该签名下的所有短信模板,请谨慎操作。 URI DELETE /v1/sms/signatures/{signature_id} 表1 路径参数 参数 是否必选 参数类型
定义智能信息基础版发送回执 功能介绍 用户按照接口规格实现智能信息基础版发送状态回执接口。接口规格包括请求方式、Header参数和Body参数。 响应参数仅供参考,客户可以返回任意响应消息给平台,平台不会对响应消息处理。 URI POST /v1/vms/send-callback
冻结服务号 功能介绍 支持用户通过此接口冻结服务号。 URI POST /v1/aim-sa/pubs/{pub_id}/freeze 表1 路径参数 参数 是否必选 参数类型 描述 pub_id 是 String 服务号ID。 请求参数 表2 请求Header参数 参数 是否必选