检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
构造请求 本节介绍REST API请求的组成,并以调用KooMessage服务的查询手机号码智能信息解析能力说明如何调用API。 请求URI 请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}?{query-string}
上传智能信息模板素材 功能介绍 支持用户上传模板使用的图片或者视频。 单个租户资源空间为10GB,包括回收站内容,系统会自动删除30天未使用的资源并释放其内存,请及时清理无用资源,防止资源浪费。 请求中所有字符串不允许携带“<”、“>”或多个空格。 URI POST /v1/aim
定义智能信息基础版上行消息回执 功能介绍 用户按照接口规格实现智能信息基础版上行消息回执接口。接口规格包括请求方式、Header参数和Body参数。 响应参数仅供参考,客户可以返回任意响应消息给平台,平台不会对响应消息处理。 URI POST /v1/vms/reply-callback
定义智能信息基础版发送回执 功能介绍 用户按照接口规格实现智能信息基础版发送状态回执接口。接口规格包括请求方式、Header参数和Body参数。 响应参数仅供参考,客户可以返回任意响应消息给平台,平台不会对响应消息处理。 URI POST /v1/vms/send-callback
事件处理效果预览 “事件”是指用户在客户端查看智能短信时,通过与子组件交互可完成的客户端操作。比如手机用户点击短信中的“进入官网”按钮,即可访问官网。 如您需要在预览模板时查询模板绑定的事件处理效果,这一需求可通过调用PreviewService函数统一处理事件来实现。目前item
创建个人模板 功能介绍 用于用户创建个人模板。 请求中所有字符串不允许携带“<”、“>”、“&”或多个空格。 模板内容需加“拒收请回复R”。 URI POST /v1/aim/templates 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type
查询模板 功能介绍 根据客户提供的过滤条件查询智能信息模板列表。 URI GET /v1/aim/templates 表1 Query参数 参数 是否必选 参数类型 描述 tpl_id 否 String 智能信息模板ID。 最小长度:0 最大长度:36 tpl_name 否 String
app-preview-image组件 HTML <div class="imgBox preview-element"> <img class="preview-element" [src]="item?.src" [style]="item.style" // 若图片的动作类型为查看大图
支持的子组件类型 以图1为例,该模板的预览视图由image、text、button三个子组件拼接而成。目前KooMessage的智能短信模板已支持11种类型的子组件开发,详见表1。对于各类型子组件,子组件代码示例提供了相应的HTML、CSS、JavaScript代码段供参考,部分组件无需编写
查询智能信息发送报表 功能介绍 查询智能信息发送报表。 URI POST /v1/aim/send-reports 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token
查询服务号列表 功能介绍 支持根据用户提供的过滤条件查询服务号列表。 URI GET /v1/aim-sa/pubs 表1 Query参数 参数 是否必选 参数类型 描述 pub_name 否 String 服务号名称。 最小长度:1 最大长度:15 state 否 Integer
注册通道号 功能介绍 注册通道号。 URI POST /v1/aim-sa/ports 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token
查询智能信息基础版发送任务 功能介绍 支持用户根据过滤条件查询智能信息基础版任务列表。包括:发送任务名称、智能信息基础版模板ID等。 URI GET /v1/aim-basic/send-tasks 表1 Query参数 参数 是否必选 参数类型 描述 task_name 否 String
app-preview-button组件 HTML <div> <p [style]="item.style" (click)="PreviewService.emit(item.event)" class="preview-element" > {{ item.text }} <
查询智能信息发送任务 功能介绍 根据用户提供的过滤条件查询智能信息发送任务列表,包括:发送任务名称、智能信息模板ID等。 URI GET /v1/aim/send-tasks 表1 Query参数 参数 是否必选 参数类型 描述 task_id 否 String 智能信息发送任务ID
子组件代码示例 app-preview-text组件 app-preview-button组件 app-preview-image组件 app-preview-video组件 app-preview-sideslip组件 app-preview-swiper组件 app-preview-eCommerce
查询解析任务 功能介绍 创建解析任务后,客户可以查询解析任务状态信息。 通过模板ID等过滤条件,查询解析任务列表。 如需查询明细,建议使用查询解析明细接口。 URI GET /v1/aim/resolve-tasks 表1 Query参数 参数 是否必选 参数类型 描述 task_id
父组件代码示例 HTML <div class="previews" [style]=" pages[0].style" > // ngFor为循环指令,遍历content数组获取item <div *ngFor="let item of pages[0].content
查询智能信息基础版模板状态 功能介绍 根据用户提供的过滤条件查询智能信息基础版模板状态列表。 包括:模板ID、模板名称等。 URI GET /v1/aim-basic/templates 表1 Query参数 参数 是否必选 参数类型 描述 tpl_id 否 String 智能信息基础版模板
查询短信应用 功能介绍 该接口用于用户查询已创建的短信应用。 URI GET /v1/sms/apps 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 缺省值:0 limit 否 Integer