# huaweicloud-aim-java

**Repository Path**: HuaweiCloudDeveloper/huaweicloud-aim-java

## Basic Information

- **Project Name**: huaweicloud-aim-java
- **Description**: 智能短信是通过手机终端增强技术和用户数据分析能力，以可交付的富媒体方式精准触达到最终消费者，并提供敏捷的内容开发服务和多种链接跳转手段帮助企业客户实现用户增长等营销服务。本示例将使用华为云SDK完成智能信息的发送
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master-dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2022-10-18
- **Last Updated**: 2024-06-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 功能介绍

智能短信是通过手机终端增强技术和用户数据分析能力，以可交互的富媒体方式精准触达到最终消费者，并提供敏捷的内容开发服务和多种链接跳转手段帮助企业客户实现用户增长等营销服务。
本示例将使用华为云SDK完成智能信息的发送。

## 流程图
![](assets/aim20230720.png)
## 前置条件
- 已 [注册](https://reg.huaweicloud.com/registerui/cn/register.html?locale=zh-cn#/register) 华为云，并完成 [实名认证](https://account.huaweicloud.com/usercenter/?region=cn-north-4#/accountindex/realNameAuth) 。
- 已订阅 [云消息服务](https://www.huaweicloud.com/product/koomessage.html)。
- 已获取华为云开发工具包（SDK），您也可以查看安装[JAVA SDK](https://console.huaweicloud.com/apiexplorer/#/sdkcenter/KooMessage?lang=Java)。
- 已获取华为云账号对应的Access Key（AK）和Secret Access Key（SK）。请在华为云控制台“我的凭证 > 访问密钥”页面上创建和查看您的AK/SK。具体请参见 [访问密钥](https://support.huaweicloud.com/usermanual-ca/zh-cn_topic_0046606340.html) 。
- 已具备开发环境，支持Java JDK 1.8及其以上版本。
- 在KooMessage控制台完成短消息配置并通过审核，包括短消息模板管理、短消息应用管理、短消息签名管理。

## SDK获取和安装
在Maven 项目的 pom.xml 文件加入相应版本的依赖项

以引入3.1.45版本的SDK为例：

```xml
<dependency>
    <groupId>com.huaweicloud.sdk</groupId>
    <artifactId>huaweicloud-sdk-koomessage</artifactId>
    <version>3.1.45</version>
</dependency>

```

## 示例代码

调用前请替换示例中的变量，请根据需要执行的方法注释掉无关方法，并执行Run Application。

```java
package com.huawei.demo;

import com.huawei.demo.enums.TemplateAuditState;
import com.huawei.demo.enums.TemplateState;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.core.http.HttpConfig;
import com.huaweicloud.sdk.core.utils.JsonUtils;
import com.huaweicloud.sdk.core.utils.StringUtils;
import com.huaweicloud.sdk.koomessage.v1.KooMessageClient;
import com.huaweicloud.sdk.koomessage.v1.model.AIMResolveTask;
import com.huaweicloud.sdk.koomessage.v1.model.AIMTemplate;
import com.huaweicloud.sdk.koomessage.v1.model.AimPersonalTemplateContent;
import com.huaweicloud.sdk.koomessage.v1.model.AimPersonalTemplateContentAction;
import com.huaweicloud.sdk.koomessage.v1.model.AimPersonalTemplateFactory;
import com.huaweicloud.sdk.koomessage.v1.model.AimPersonalTemplatePage;
import com.huaweicloud.sdk.koomessage.v1.model.CreateAimPersonalTemplateRequest;
import com.huaweicloud.sdk.koomessage.v1.model.CreateAimPersonalTemplateRequestBody;
import com.huaweicloud.sdk.koomessage.v1.model.CreateAimPersonalTemplateResponse;
import com.huaweicloud.sdk.koomessage.v1.model.CreateAimSendTaskRequest;
import com.huaweicloud.sdk.koomessage.v1.model.CreateAimSendTaskRequestBody;
import com.huaweicloud.sdk.koomessage.v1.model.CreateAimSendTaskResponse;
import com.huaweicloud.sdk.koomessage.v1.model.CreateResolveTaskParam;
import com.huaweicloud.sdk.koomessage.v1.model.ListAimSendDetailsRequest;
import com.huaweicloud.sdk.koomessage.v1.model.ListAimSendDetailsResponse;
import com.huaweicloud.sdk.koomessage.v1.model.ListAimSendTasksRequest;
import com.huaweicloud.sdk.koomessage.v1.model.ListAimSendTasksResponse;
import com.huaweicloud.sdk.koomessage.v1.model.ListAimTemplatesRequest;
import com.huaweicloud.sdk.koomessage.v1.model.ListAimTemplatesResponse;
import com.huaweicloud.sdk.koomessage.v1.model.SmsChannel;
import com.huaweicloud.sdk.koomessage.v1.model.UploadAimTemplateMaterialRequest;
import com.huaweicloud.sdk.koomessage.v1.model.UploadAimTemplateMaterialRequestBody;
import com.huaweicloud.sdk.koomessage.v1.model.UploadAimTemplateMaterialResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.UUID;

public class SendAimTask {
    private static final Logger logger = LoggerFactory.getLogger(SendAimTask.class);

    public static void main(String[] args) {
        String ak = "<YOUR AK>";
        String sk = "<YOUR SK>";
        BasicCredentials credentials = new BasicCredentials().withAk(ak).withSk(sk);

        HttpConfig config = HttpConfig.getDefaultHttpConfig().withIgnoreSSLVerification(true);
        KooMessageClient kmClient = KooMessageClient.newBuilder()
            .withCredential(credentials)
            .withEndpoints(Arrays.asList("koomessage.myhuaweicloud.com"))
            .withHttpConfig(config)
            .build();

        // 上传智能信息模板素材
        UploadAimTemplateMaterialRequest uploadAimTemplateMaterialRequest = buildUploadAimTemplateMaterialRequest();
        UploadAimTemplateMaterialResponse uploadAimTemplateMaterialResponse = uploadAimTemplateMaterial(kmClient,
            uploadAimTemplateMaterialRequest);
        // 智能信息模板素材资源id
        String aimResourceId;
        if (uploadAimTemplateMaterialResponse != null && uploadAimTemplateMaterialResponse.getData() != null
            && !StringUtils.isEmpty(uploadAimTemplateMaterialResponse.getData().getAimResourceId())) {
            aimResourceId = uploadAimTemplateMaterialResponse.getData().getAimResourceId();
            System.out.println(aimResourceId);
        }

        // 创建智能信息个人模板
        CreateAimPersonalTemplateRequest createAimPersonalTemplateRequest = buildCreateAimPersonalTemplateRequest();
        CreateAimPersonalTemplateResponse createAimPersonalTemplateResponse = createAimPersonalTemplate(kmClient,
            createAimPersonalTemplateRequest);
        if (createAimPersonalTemplateResponse != null && createAimPersonalTemplateResponse.getData() != null
            && !StringUtils.isEmpty(createAimPersonalTemplateResponse.getData().getTplId())) {
            String tplId = createAimPersonalTemplateResponse.getData().getTplId();
            System.out.println(tplId);
        }

        // 您可以通过KooMessage控制台查询到以下参数
        // 智能信息模板ID,KooMessage控制台-》智能信息配置-》智能信息模板管理-》模板ID
        String tplId = "<YOUR tplId>";
        // 根据模板ID查询智能信息模板
        AIMTemplate template = getAimTemplateById(kmClient, tplId);

        // 判断模板是否审核通过并且非禁用状态
        if (template != null && TemplateAuditState.APPROVED.getCode() == template.getAuditState()
            && TemplateState.ENABLE.getCode() == template.getTplState()) {
            // 提交智能信息发送任务
            CreateAimSendTaskResponse sendTask = createSendTask(kmClient, tplId);
            // 查询发送任务提交结果
            assert sendTask != null;
            String taskId = sendTask.getTaskId();
            ListAimSendTasksRequest listAimSendTasksRequest = new ListAimSendTasksRequest();
            listAimSendTasksRequest.setOffset(0);
            listAimSendTasksRequest.setLimit(10);
            listAimSendTasksRequest.setTaskId(taskId);
            ListAimSendTasksResponse response = kmClient.listAimSendTasks(listAimSendTasksRequest);
            System.out.println(JsonUtils.toJSON(response));

            // 查询发送明细
            ListAimSendDetailsRequest listAimSendDetailsRequest = new ListAimSendDetailsRequest();
            listAimSendDetailsRequest.setOffset(0);
            listAimSendDetailsRequest.setLimit(10);
            listAimSendDetailsRequest.setTaskId(taskId);
            ListAimSendDetailsResponse listAimSendDetailsResponse = kmClient.listAimSendDetails(
                listAimSendDetailsRequest);
            System.out.println(JsonUtils.toJSON(listAimSendDetailsResponse));
        }
    }

    /**
     * 构建上传智能信息模板素材请求
     *
     * @return UploadAimTemplateMaterialRequest 上传智能信息模板素材请求
     */
    public static UploadAimTemplateMaterialRequest buildUploadAimTemplateMaterialRequest() {
        UploadAimTemplateMaterialRequestBody body = new UploadAimTemplateMaterialRequestBody()
            // 资源类型，可选值：image, video, thumbnail
            .withResourceType("image")
            // 文件类型，可选值：url-资源url链接地址, stream-多媒体资源文件流的BASE64编码，需要带资源类型前缀
            .withFileType("url")
            // 资源文件URL
            .withFileUrl("<YOUR fileUrl>")
            // 素材ID，最大长度36
            .withMaterialId(UUID.randomUUID().toString())
            // 图像比例，可选值：oneToOne, sixteenToNine, threeToOne, fortyEightToSixtyFive, twentyOneToNine
            .withImageRate("sixteenToNine")
            // 素材描述信息
            .withDescription("<YOUR description>");
        UploadAimTemplateMaterialRequest request = new UploadAimTemplateMaterialRequest();
        request.withBody(body);
        return request;
    }

    /**
     * 智能信息上传模板素材
     *
     * @param kmClient KooMessage sdk 客户端
     * @param request  上传模板素材请求
     * @return UploadAimTemplateMaterialResponse 上传模板素材响应
     */
    public static UploadAimTemplateMaterialResponse uploadAimTemplateMaterial(KooMessageClient kmClient,
        UploadAimTemplateMaterialRequest request) {
        UploadAimTemplateMaterialResponse response = new UploadAimTemplateMaterialResponse();
        try {
            response = kmClient.uploadAimTemplateMaterial(request);
            logger.info(response.toString());
            return response;
        } catch (ConnectionException | RequestTimeoutException e) {
            logger.error("uploadAimTemplateMaterial error.", e);
        } catch (ServiceResponseException e) {
            logger.error("httpStatusCode: {}, requestId: {}, errorCode: {}, errorMsg: {}", e.getHttpStatusCode(),
                e.getRequestId(), e.getErrorCode(), e.getErrorMsg());
        }
        return response;
    }

    /**
     * 构建创建智能信息个人模板请求
     *
     * @return CreateAimPersonalTemplateRequest 创建智能信息个人模板请求
     */
    public static CreateAimPersonalTemplateRequest buildCreateAimPersonalTemplateRequest() {
        CreateAimPersonalTemplateRequest request = new CreateAimPersonalTemplateRequest();
        List<AimPersonalTemplatePage> pages = buildAimPersonalTemplatePages();
        List<AimPersonalTemplateFactory> templateFactories = buildAimPersonalTemplateFactories();

        CreateAimPersonalTemplateRequestBody body = new CreateAimPersonalTemplateRequestBody()
            // 模板用途，可选值：1-商用, 2-试商用
            .withUseId(2)
            // 布局类型，可选值：StandardImageAndText-图文类, MultipleImageAndText-多图文类, RedPacket-红包类等
            .withCardId("StandardImageAndText")
            // 模板名称，试商用模板名称要包含"测试"字样
            .withTplName("<YOUR tplName>")
            // 模板协议
            .withPages(pages)
            // 模板参数集
            .withParams(Collections.emptyList()).withFactorys(templateFactories);
        request.withBody(body);
        return request;
    }

    /**
     * 构建智能信息个人模板支持厂商列表
     *
     * @return List<AimPersonalTemplateFactory> 模板支持厂商列表
     */
    private static List<AimPersonalTemplateFactory> buildAimPersonalTemplateFactories() {
        List<AimPersonalTemplateFactory> templateFactories = new ArrayList<>(3);
        AimPersonalTemplateFactory huaweiFactory = new AimPersonalTemplateFactory().withFactoryType("HUAWEI")
            // 支持状态，可选值：1-支持, 0-不支持
            .withState(1);
        templateFactories.add(huaweiFactory);
        AimPersonalTemplateFactory xiaomiFactory = new AimPersonalTemplateFactory().withFactoryType("XIAOMI")
            .withState(1);
        templateFactories.add(xiaomiFactory);
        AimPersonalTemplateFactory oppoFactory = new AimPersonalTemplateFactory().withFactoryType("OPPO").withState(1);
        templateFactories.add(oppoFactory);
        return templateFactories;
    }

    /**
     * 构建智能信息个人模板协议
     *
     * @return List<AimPersonalTemplatePage> 模板协议
     */
    private static List<AimPersonalTemplatePage> buildAimPersonalTemplatePages() {
        List<AimPersonalTemplatePage> pages = new ArrayList<>(1);
        AimPersonalTemplatePage page = new AimPersonalTemplatePage();
        List<AimPersonalTemplateContent> contents = new ArrayList<>(4);
        // 智能信息模板图片组件
        AimPersonalTemplateContent imageContent = new AimPersonalTemplateContent()
            // 模板资源类型，可选值：text-文本, image-图片, video-视频, button-按钮, followPub-华为服务号，暂不支持
            .withType("image")
            // 资源类型，可选值：1-模板素材资源id, 2-资源url地址
            .withSrcType(1)
            // 模板素材上传资源id，即上传素材接口中返回的aim_resource_id
            .withSrc("<YOUR aimResourceId>")
            // 功能类型：可选值：OPEN_URL-跳转H5, OPEN_APP-跳转APP, OPEN_BROWSER-打开浏览器等
            .withActionType("OPEN_BROWSER")
            // 个人模板事件对象
            .withAction(new AimPersonalTemplateContentAction()
                // 此字段根据action_type对应不同的含义，当前表示打开浏览器地址
                .withTarget("<YOUR targetUrl>"))
            // 卡片组件位置序号
            .withPositionNumber(1);
        contents.add(imageContent);
        // 智能信息模板标题组件，试商用标题要包含"测试"字样
        AimPersonalTemplateContent titleContent = new AimPersonalTemplateContent().withType("text")
            .withContent("<YOUR templateTitle>")
            // 是否为文本标题
            .withIsTextTitle("true")
            .withPositionNumber(2);
        contents.add(titleContent);
        // 智能信息模板正文组件，试商用正文要包含"测试"字样
        AimPersonalTemplateContent mainContent = new AimPersonalTemplateContent().withType("text")
            .withContent("<YOUR templateText>")
            .withIsTextTitle("false")
            .withPositionNumber(3);
        contents.add(mainContent);
        // 智能信息模板按钮组件
        AimPersonalTemplateContent buttonContent = new AimPersonalTemplateContent().withType("button")
            .withContent("<YOUR templateButton>")
            .withActionType("OPEN_BROWSER")
            .withPositionNumber(4)
            .withAction(new AimPersonalTemplateContentAction().withTarget("<YOUR targetUrl>"));
        contents.add(buttonContent);
        page.withContents(contents).withPageOrder(1);
        pages.add(page);
        return pages;
    }

    /**
     * 创建智能信息个人模板
     *
     * @param kmClient KooMessage sdk 客户端
     * @param request  创建智能信息个人模板请求
     * @return CreateAimPersonalTemplateResponse 创建智能信息个人模板响应
     */
    public static CreateAimPersonalTemplateResponse createAimPersonalTemplate(KooMessageClient kmClient,
        CreateAimPersonalTemplateRequest request) {
        CreateAimPersonalTemplateResponse response = new CreateAimPersonalTemplateResponse();
        try {
            response = kmClient.createAimPersonalTemplate(request);
            logger.info(response.toString());
            return response;
        } catch (ConnectionException | RequestTimeoutException e) {
            logger.error("createAimPersonalTemplate error.", e);
        } catch (ServiceResponseException e) {
            logger.error("httpStatusCode: {}, requestId: {}, errorCode: {}, errorMsg: {}", e.getHttpStatusCode(),
                e.getRequestId(), e.getErrorCode(), e.getErrorMsg());
        }
        return response;
    }

    /**
     * 根据模板ID查询智能信息模板
     *
     * @param kmClient 请求客户端
     * @param tplId    模板ID
     * @return AIMTemplate 智能信息模板信息
     */
    public static AIMTemplate getAimTemplateById(KooMessageClient kmClient, String tplId) {
        AIMTemplate aimTemplate = new AIMTemplate();
        try {
            ListAimTemplatesRequest request = new ListAimTemplatesRequest();
            request.setTplId(tplId);
            ListAimTemplatesResponse listAIMTemplatesResponse = kmClient.listAimTemplates(request);
            logger.info(listAIMTemplatesResponse.toString());
            List<AIMTemplate> templates = listAIMTemplatesResponse.getTemplates();
            if (templates != null && templates.size() > 0) {
                return templates.get(0);
            }
        } catch (ConnectionException | RequestTimeoutException e) {
            logger.error("getAimTemplateById error.", e);
        } catch (ServiceResponseException e) {
            logger.error("httpStatusCode: {}, requestId: {}, errorCode: {}, errorMsg: {}", e.getHttpStatusCode(),
                e.getRequestId(), e.getErrorCode(), e.getErrorMsg());
        }
        return aimTemplate;
    }

    /**
     * 创建智能信息发送任务
     *
     * @param kmClient 请求客户端
     * @param tplId    模板ID
     * @return CreateAimSendTaskResponse 发送任务响应
     */
    public static CreateAimSendTaskResponse createSendTask(KooMessageClient kmClient, String tplId) {
        CreateAimSendTaskResponse sendTaskResponse = new CreateAimSendTaskResponse();
        try {
            AIMResolveTask resolve = buildAimResolveTask(tplId);
            SmsChannel smsChannel = buildSmsChannel();
            CreateAimSendTaskRequestBody body = new CreateAimSendTaskRequestBody()
                // 智能信息发送任务名称
                .withTaskName("<YOUR taskName>")
                // 短息发送通道参数
                .withSmsChannel(smsChannel)
                // 短链生成配置
                .withResolveTask(resolve);
            CreateAimSendTaskRequest request = new CreateAimSendTaskRequest();
            request.setBody(body);
            sendTaskResponse = kmClient.createAimSendTask(request);
            System.out.println(sendTaskResponse);
            return sendTaskResponse;
        } catch (ConnectionException | RequestTimeoutException e) {
            logger.error("createSendTask error.", e);
        } catch (ServiceResponseException e) {
            logger.error("httpStatusCode: {}, requestId: {}, errorCode: {}, errorMsg: {}", e.getHttpStatusCode(),
                e.getRequestId(), e.getErrorCode(), e.getErrorMsg());
        }
        return sendTaskResponse;
    }

    /**
     * 构建短链生成配置
     *
     * @param tplId 智能信息模板ID
     * @return AIMResolveTask 短链生成配置
     */
    private static AIMResolveTask buildAimResolveTask(String tplId) {
        // 您可以设置自己要发送的目标手机号，如果发送多个请按需创建多个param加入params数组中
        String targetPhone = "<YOUR targetPhone>";
        CreateResolveTaskParam param = new CreateResolveTaskParam()
            // 解析任务用户唯一标识，发送时必填用户手机号码
            .withCustFlag(targetPhone);
        List<CreateResolveTaskParam> params = new ArrayList<>();
        AIMResolveTask resolve = new AIMResolveTask()
            // 模板ID
            .withTplId(tplId)
            // 编码类型，可选值：group-群发，individual-个性化
            .withAimCodeType("individual")
            // 短链最大解析次数
            .withResolveTimes(1)
            // 短链解析详情列表
            .withParams(params)
            // 短链失效时间（天）
            .withExpirationTime(7);
        params.add(param);
        return resolve;
    }

    /**
     * 构建短信发送通道参数
     *
     * @return SmsChannel 短息发送通道参数
     */
    private static SmsChannel buildSmsChannel() {
        return new SmsChannel()
            // 短信模板签名所绑定的通道号，KooMessage控制台-》短消息签名管理-》通道号
            .withChannelNumber("<YOUR smsChannelNumber>")
            // 短信模板所属签名，KooMessage控制台-》短消息模板管理-》所属签名
            .withSmsSign("<YOUR smsSign>")
            // 短信模板ID，KooMessage控制台-》短消息配置（国内）-》短消息模板管理-》模板ID
            .withSmsTplId("<YOUR smsTplId>")
            // 短信应用名称，KooMessage控制台-》短消息配置（国内）-》短消息模板管理-》所属应用
            .withSmsAppName("<YOUR smsAppName>");
    }
}
```
## 返回结果示例
查询智能信息模板：
```json
{
  "tpl_id" : "600000001",
  "tpl_name" : "金秋钜惠",
  "scene" : "测试模板",
  "tpl_state" : 1,
  "disable_desc" : "",
  "disable_time" : "1970-01-01T00:00:00Z",
  "audit_state" : 2,
  "audit_desc" : "审核通过",
  "description" : "您有一条新消息。",
  "creation_time" : "2022-05-23T17:49:00Z",
  "update_time" : "2022-05-23T19:29:14Z",
  "pages" : "[{\"typeIndex\":0,\"cardId\":\"com.hbm.redpacket\",\"style\":{\"width\":\"342px\",\"opacity\":1,\"height\":\"456px\"},\"label\":\"主页1\",\"tag\":\"page1\",\"content\":[{\"visible\":true,\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/editor_file/redpacketBg.png\",\"h\":456,\"isBgimg\":true,\"type\":\"image\",\"skipReplaceSrc\":true,\"size\":0,\"borderRadius\":0,\"w\":342,\"x\":0,\"y\":0,\"notValid\":true,\"angle\":0,\"style\":{\"padding\":0,\"borderRadius\":0,\"borderWidth\":0,\"borderStyle\":\"none\"},\"z\":0,\"tag\":\"tg0.34403423289983026\",\"locked\":true,\"event\":{\"packageNames\":\"\",\"subject\":\"\",\"navType\":2,\"latitude\":\"\",\"description\":\"\",\"floorType\":0,\"txtButton\":\"\",\"body\":\"\",\"content\":\"\",\"target\":\"\",\"merchantName\":\"\",\"browserFloorUrl\":\"\",\"mode\":0,\"floorUrl\":\"\",\"copyType\":1,\"action\":\"\",\"longitude\":\"\"}},{\"serviceType\":0,\"visible\":false,\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/editor_file/defaultImg/defaultImg2.jpg\",\"h\":23,\"type\":\"serviceNumber\",\"serviceName\":\"请选择服务号\",\"skipReplaceSrc\":true,\"borderRadius\":0,\"w\":342,\"x\":0,\"y\":348,\"angle\":0,\"style\":{\"padding\":0,\"borderRadius\":0,\"color\":\"#fff\",\"textAlign\":\"center\",\"borderWidth\":0,\"borderStyle\":\"none\"},\"z\":0,\"tag\":\"tg0.6574206986442455\",\"locked\":true,\"serviceID\":\"\"},{\"visible\":true,\"proportion\":[1,1],\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/tpl_file/Montnets/E01/S01/Template/603264561/20220523174859881fILNZn.jpg\",\"bg\":{\"proportion\":[9,5],\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/tpl_file/Montnets/E01/S01/Template/610579108/20220523174900022c8XeYT.jpg\",\"w\":342,\"h\":190},\"h\":70,\"type\":\"image\",\"oppobg\":{\"proportion\":[3,4],\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/editor_file/redpacketBg-oppo.jpg\",\"w\":342,\"h\":456},\"passItem\":false,\"size\":91289,\"borderRadius\":0,\"w\":70,\"x\":136,\"width\":1024,\"y\":44,\"angle\":0,\"style\":{\"padding\":0,\"borderRadius\":\"70px\",\"borderWidth\":0,\"borderStyle\":\"none\"},\"z\":0,\"tag\":\"tg0.45509392249988934\",\"srcParam\":\"\",\"locked\":true,\"event\":{\"packageNames\":\"\",\"subject\":\"\",\"latitude\":\"\",\"navType\":2,\"floorType\":0,\"description\":\"\",\"txtButton\":\"\",\"body\":\"\",\"content\":\"\",\"browserFloorUrl\":\"\",\"merchantName\":\"\",\"target\":\"https://mbs.boc.cn/v/JzEZb\",\"mode\":0,\"floorUrl\":\"\",\"copyType\":1,\"action\":\"OPEN_BROWSER\",\"longitude\":\"\"},\"isBg\":0,\"height\":1024},{\"visible\":true,\"h\":23,\"title\":\"true\",\"type\":\"text\",\"textMaxlength\":36,\"passItem\":false,\"textOPPOLength\":24,\"w\":342,\"x\":0,\"y\":128,\"angle\":0,\"z\":2,\"style\":{\"backgroundColor\":\"transparent\",\"fontFamily\":\"微软雅黑\",\"color\":\"#ffffff\",\"textAlign\":\"center\",\"letterSpacing\":0,\"fontSize\":\"14px\",\"textDecoration\":\"none\",\"lineHeight\":1.5,\"boxSizing\":\"border-box\",\"fontStyle\":\"normal\",\"opacity\":1,\"fontWeight\":\"700\"},\"tag\":\"tg0.42763825585357296\",\"text\":\"中行送您最高20元话费券\",\"placeholder\":\"编辑名称，最多显示18个字\",\"locked\":true,\"event\":{}},{\"visible\":true,\"h\":40,\"type\":\"text\",\"textMaxlength\":22,\"passItem\":false,\"w\":342,\"x\":0,\"y\":196,\"angle\":0,\"z\":2,\"style\":{\"backgroundColor\":\"transparent\",\"fontFamily\":\"微软雅黑\",\"color\":\"#ffffff\",\"textAlign\":\"center\",\"letterSpacing\":0,\"fontSize\":\"24px\",\"textDecoration\":\"none\",\"lineHeight\":1.5,\"boxSizing\":\"border-box\",\"fontStyle\":\"normal\",\"opacity\":1,\"fontWeight\":\"700\"},\"divTextAreaTitle\":\"true\",\"tag\":\"tg0.04688490460114725\",\"text\":\"话费+签到双重福利红包\",\"placeholder\":\"编辑文本，最多11个字\",\"locked\":true,\"event\":{}},{\"visible\":true,\"h\":69,\"type\":\"text\",\"textMaxlength\":108,\"passItem\":false,\"textOPPOLength\":76,\"w\":280,\"x\":31,\"y\":236,\"angle\":0,\"z\":2,\"style\":{\"backgroundColor\":\"transparent\",\"fontFamily\":\"微软雅黑\",\"color\":\"#ffffff\",\"textAlign\":\"center\",\"letterSpacing\":0,\"fontSize\":\"14px\",\"textDecoration\":\"none\",\"lineHeight\":1.5,\"boxSizing\":\"border-box\",\"fontStyle\":\"normal\",\"opacity\":1,\"fontWeight\":\"700\"},\"divTextAreaContent\":\"true\",\"tag\":\"tg0.7916708792687688\",\"text\":\"登录手机银行首页-搜索-热门活动参加签到活动赢最高20元话费券！-测试\",\"placeholder\":\"编辑文本，最多显示54个字。编辑文本，最多显示54个字。编辑文本，最多显示54个字。\",\"locked\":true,\"event\":{}},{\"visible\":true,\"pageTitle\":\"\",\"h\":40,\"type\":\"button\",\"target\":\"\",\"passItem\":false,\"w\":202,\"x\":70,\"y\":381,\"angle\":0,\"action\":\"OPEN_APP\",\"z\":3,\"style\":{\"padding\":0,\"backgroundColor\":\"#ff9800\",\"color\":\"#ffffff\",\"textAlign\":\"center\",\"letterSpacing\":0,\"textDecoration\":\"none\",\"boxSizing\":\"border-box\",\"fontStyle\":\"normal\",\"fontFamily\":\"微软雅黑\",\"borderRadius\":\"32px\",\"borderWidth\":0,\"fontSize\":\"16px\",\"opacity\":1,\"borderStyle\":\"none\",\"fontWeight\":\"normal\"},\"tag\":\"tg0.6309152129863151\",\"text\":\"立即领取\",\"locked\":true,\"thirdService\":\"\",\"event\":{\"packageNames\":\"\",\"subject\":\"\",\"navType\":2,\"latitude\":\"\",\"description\":\"\",\"floorType\":0,\"txtButton\":\"\",\"body\":\"\",\"content\":\"\",\"target\":\"https://mbs.boc.cn/v/JzEZb\",\"merchantName\":\"\",\"browserFloorUrl\":\"\",\"mode\":0,\"floorUrl\":\"\",\"copyType\":1,\"action\":\"OPEN_BROWSER\",\"longitude\":\"\"},\"maxLength\":9}]}]",
  "params" : [ ],
  "factory_info" : [ {
    "factory_type" : "HuaWei",
    "state" : 1,
    "version" : null
  }, {
    "factory_type" : "XiaoMi",
    "state" : 1,
    "version" : null
  }, {
    "factory_type" : "OPPO",
    "state" : 1,
    "version" : null
  } ]
}
```
创建智能信息发送任务：
```json
{
  "task_name" : "智能信息发送",
  "sms_channel" : {
    "channel_number" : "8822053111111",
    "sms_tpl_id" : 15010661,
    "sms_sign" : "KooMessage",
    "sms_app_name" : "KooMessageApp"
  },
  "resolve_task" : {
    "tpl_id" : "600000001",
    "resolve_times" : 1,
    "aim_code_type" : "individual",
    "domain" : null,
    "expiration_time" : 7,
    "params" : [ {
      "cust_flag" : "131****0000",
      "dync_params" : null,
      "custom_url" : "https://www.xxxx.com"
    } ]
  },
  "task_id" : "c3d7659d-06b0-4fa0-9eed-9225389ecccc",
  "task_state" : "Success",
  "creation_time" : "2022-07-19T14:37:34.00Z",
  "submission_count" : 1,
  "send_count" : 1,
  "resolve_count" : 0
}
```
查询智能信息发送任务：
```json
{
  "aim_send_tasks" : [ {
    "task_id" : "7cc198c3-91d3-425b-9226-54c27cd7cccc",
    "task_name" : "智能信息发送-动态参数",
    "task_state" : "Success",
    "submission_count" : 2,
    "send_count" : 2,
    "resolve_count" : 1,
    "support_resolve_count" : -1,
    "sms_channel" : {
      "sms_sign" : "KooMessage"
    },
    "creation_time" : "2022-07-19T14:57:20.00Z"
  } ],
  "page_info" : {
    "offset" : 0,
    "limit" : 2,
    "total" : 1
  }
}
```
查询智能信息发送明细：
```json
{
  "send_details" : [ {
    "msg_id" : "7e52e4fe-ef00-4826-84b6-756446c5cccc_595223901",
    "task_id" : "7cc198c3-91d3-425b-9226-54c27cd7cccc",
    "task_name" : "智能信息发送-动态参数",
    "tpl_id" : "600000001",
    "tpl_name" : "金秋钜惠",
    "cust_flag" : "131****0000",
    "send_account" : "kmsg_001",
    "send_status" : "success",
    "send_time" : "2022-07-19T14:57:20Z",
    "receive_time" : "2022-07-19T14:57:31Z",
    "result_code" : null
  }, {
    "msg_id" : "7e52e4fe-ef00-4826-84b6-756446c5cccc_595223902",
    "task_id" : "7cc198c3-91d3-425b-9226-54c27cd7cccc",
    "task_name" : "智能信息发送-动态参数",
    "tpl_id" : "600000001",
    "tpl_name" : "金秋钜惠",
    "cust_flag" : "131****0001",
    "send_account" : "kmsg_001",
    "send_status" : "success",
    "send_time" : "2022-07-19T14:57:20Z",
    "receive_time" : "2022-07-19T14:57:30Z",
    "result_code" : null
  } ],
  "page_info" : {
    "offset" : 0,
    "limit" : 2,
    "total" : 2
  }
}
```

## 参考
更多信息请参考：
[创建个人模板](https://support.huaweicloud.com/api-koomessage/CreatePersonalTemplate.html)
[查询智能信息模板](https://support.huaweicloud.com/api-KooMessage/ListAIMTemplates.html)
[发送智能信息](https://support.huaweicloud.com/api-KooMessage/SendAIMTask.html)
[查询智能信息发送任务](https://support.huaweicloud.com/api-KooMessage/ListAIMSendTasks.html)
[查询智能信息发送明细](https://support.huaweicloud.com/api-KooMessage/ListSendDetails.html)

## 修订记录

|  发布日期  | 文档版本 |   修订说明   |
| :--------: | :------: | :----------: |
| 2022-10-28 |   1.0    | 文档首次发布 |
| 2023-07-20 |   2.0    |   文档完善   |