检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API接口 KooMessage是否支持集成到第三方产品中? KooMessage的API是否存在对调用IP的限制?
API概览 云消息服务接口的分类与说明如表1所示。 表1 API概览 类型 说明 一站式创建服务号 包含服务号的创建,主页、菜单催审等接口。 智能信息服务号通道号 包含通道号的注册、查询、绑定、删除等接口。 智能信息服务号主页 包含服务号主页的修改、查询接口。 智能信息服务号资料
API 一站式创建服务号 智能信息服务号通道号 智能信息服务号主页 智能信息服务号资料 智能信息服务号菜单 智能信息模板 智能信息解析 智能信息发送 智能信息回执 智能信息基础版模板 智能信息基础版发送 短信应用 短信签名 短信模板 短信发送
如何调用API 构造请求 认证鉴权 返回结果
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:0 最大长度:2000 表2 请求Body参数 参数 是否必选 参数类型
符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于查询手机号码智能信息解析能力接口,您可以从接口的请求部分看到所需的请求参数及
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data
新建智能信息基础版模板 功能介绍 支持用户通过此接口创建智能信息基础版模板。 URI POST /v1/aim-basic/templates 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型,该字段
cover 否 String 视频封面。 说明: 资源类型为Video时,为必填,通过设置视频模板封面图接口设置视频封面。 如上src_type为1,即资源ID时,参数填入上传模板素材接口中返回的aim_resource_id,如:691996319597764608 如上src_ty
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 请求体参数类型,该字段必须设置为:application/json。
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表2 请求Body参数 参数 是否必选 参数类型 描述 channel_num 否
功能介绍 该接口用于用户创建短信签名。 URI POST /v1/sms/signatures 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 change_reason
定义智能信息基础版上行消息回执 功能介绍 用户按照接口规格实现智能信息基础版上行消息回执接口。接口规格包括请求方式、Header参数和Body参数。 响应参数仅供参考,客户可以返回任意响应消息给平台,平台不会对响应消息处理。 URI POST /v1/vms/reply-callback
发送智能信息基础版任务 功能介绍 支持用户通过此接口进行智能信息基础版任务发送。 URI POST /v1/aim-basic/send-tasks 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型,
定义智能信息基础版发送回执 功能介绍 用户按照接口规格实现智能信息基础版发送状态回执接口。接口规格包括请求方式、Header参数和Body参数。 响应参数仅供参考,客户可以返回任意响应消息给平台,平台不会对响应消息处理。 URI POST /v1/vms/send-callback
发送分批短信 功能介绍 该接口用于向不同用户发送不同内容的短信。 前提条件 已创建短信应用。 已申请短信签名,获取签名通道号。 已申请短信模板,获取模板ID。 注意事项 单条短信最多允许携带500个号码,每个号码最大长度为21位。 URI POST /v1/aim/sms/diff-messages
查询解析任务 功能介绍 创建解析任务后,客户可以查询解析任务状态信息。 通过模板ID等过滤条件,查询解析任务列表。 如需查询明细,建议使用查询解析明细接口。 URI GET /v1/aim/resolve-tasks 表1 Query参数 参数 是否必选 参数类型 描述 task_id 否 String
响应示例 状态码: 200 返回200状态码仅代表接口请求成功,任务提交结果由task_state字段来区分,此结果仅代表任务提交结果,并非智能信息发送结果。用户手机接收智能信息结果请以收到的回执结果为准,也可通过查询智能信息发送明细API获取或登录KooMessage控制台查看。 {
Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 云服务存在两种部署方式:项目级服务和全局级服务。其中: 项目级服务需要获