检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前必读 概述 调用说明 终端节点 约束与限制 基本概念
第二十一次正式发布。 新增: 短信应用,包含短信应用的创建、查询、修改等接口。 短信签名,包含短信签名的创建、查询、修改等接口。 短信模板,包含短信模板的创建、查询、修改等接口。 短信发送,包含短信发送的分批发送等接口。 修改: 一站式服务号创建、修改主页信息,修改logo_img请求参数说明,删除“比例+-0
智能信息服务号支持的省市地区 表1 省市地区列表 一级地区 二级地区 三级地区 全国 河北省 石家庄市 唐山市 秦皇岛市 邯郸市 邢台市 保定市 张家口市 承德市 沧州市 廊坊市 衡水市 山西省 太原市 大同市 阳泉市 长治市 晋城市 朔州市 晋中市 运城市 忻州市 临汾市 吕梁市
符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于查询手机号码智能信息解析能力接口,您可以从接口的请求部分看到所需的请求参数及
KooMessage的API是否存在对调用IP的限制? 无限制。 父主题: API接口
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 请求体参数类型,该字段必须设置为:application/json。
查询解析任务 功能介绍 创建解析任务后,客户可以查询解析任务状态信息。 通过模板ID等过滤条件,查询解析任务列表。 如需查询明细,建议使用查询解析明细接口。 URI GET /v1/aim/resolve-tasks 表1 Query参数 参数 是否必选 参数类型 描述 task_id 否 String
体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于查询手机号码智能信息解析能力接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 响应消息体
创建短信模板 功能介绍 该接口用于用户创建短信模板。 URI POST /v1/sms/templates 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 请求体参数类型,该字段必须设置为:application/json。
响应示例 状态码: 200 返回200状态码仅代表接口请求成功,任务提交结果由task_state字段来区分,此结果仅代表任务提交结果,并非智能信息发送结果。用户手机接收智能信息结果请以收到的回执结果为准,也可通过查询智能信息发送明细API获取或登录KooMessage控制台查看。 {
定义模板状态回执 功能介绍 用户按接口定义实现模板状态回执接口。 响应参数仅供参考,客户可以返回任意响应消息给平台,平台不会对响应消息处理。 URI POST /v1/aim/template-status 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type
查询短信模板 功能介绍 该接口用于用户查询已创建的短信模板。 URI GET /v1/sms/templates 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量。表示从偏移量开始查询,offset大于等于0。 缺省值:1 limit
修改短信模板 功能介绍 该接口用于用户修改短信模板信息,目前仅支持审核不通过的短信模板重新修改。 URI PUT /v1/sms/templates/{template_id} 表1 路径参数 参数 是否必选 参数类型 描述 template_id 是 String 短信模板ID。
private:查个人模板 说明: 不传查全部模板。 factory_type 否 Array of strings 厂商类型。 HUAWEI:华为 XIAOMI:小米 OPPO:OPPO MEIZU:魅族 VIVO:VIVO SAMSUNG:三星 数组长度:0 - 6 has_param
Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 云服务存在两种部署方式:项目级服务和全局级服务。其中: 项目级服务需要获
右边按钮为玫粉色。仅华为厂商支持sub_type取值为2、3、4、5。 当card_id为CarouselVerticalImage时,sub_type用于设置按钮颜色,1表示蓝色(默认颜色)、2表示黑色、3表示紫色、4表示金色、5表示粉色、6表示玫粉。仅华为厂商支持sub_type取值为2、3、4、5、6。
发送分批短信 功能介绍 该接口用于向不同用户发送不同内容的短信。 前提条件 已创建短信应用。 已申请短信签名,获取签名通道号。 已申请短信模板,获取模板ID。 注意事项 单条短信最多允许携带500个号码,每个号码最大长度为21位。 URI POST /v1/aim/sms/diff-messages
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表2 请求Body参数 参数 是否必选 参数类型 描述 channel_num 否
获取短信模板详情 功能介绍 该接口用于用户获取已创建的短信模板详情。 URI GET /v1/sms/templates/{template_id} 表1 路径参数 参数 是否必选 参数类型 描述 template_id 是 String 短信模板ID。 请求参数 表2 请求Header参数