com.aliyun.dingtalkim_1_0.models.SendInteractiveCardRequest Maven / Gradle / Ivy

// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.dingtalkim_1_0.models;

import com.aliyun.tea.*;

public class SendInteractiveCardRequest extends TeaModel {
    // 消息@人，{123456:"钉三多"}，key：根据userIdType来设置，【特殊设置：如果key、value都为"@ALL"则判断at所有人】
    @NameInMap("atOpenIds")
    public java.util.Map atOpenIds;

    // 可控制卡片回调时的路由Key，用于指定特定的callbackUrl【可空：不填写默认用企业的回调地址】
    @NameInMap("callbackRouteKey")
    public String callbackRouteKey;

    // 卡片公共主体部分数据
    @NameInMap("cardData")
    public SendInteractiveCardRequestCardData cardData;

    // 卡片属性
    @NameInMap("cardOptions")
    public SendInteractiveCardRequestCardOptions cardOptions;

    // 卡片模板ID
    @NameInMap("cardTemplateId")
    public String cardTemplateId;

    // 【robotCode & chatBotId二选一必填】机器人ID（企业机器人）
    @NameInMap("chatBotId")
    public String chatBotId;

    // 发送的会话类型：单聊-0, 群聊-1（单聊时：openConversationId不用填写；receiverUserIdList填写有且一个员工号）
    @NameInMap("conversationType")
    public Integer conversationType;

    // 接收卡片的群的openConversationId
    @NameInMap("openConversationId")
    public String openConversationId;

    // 唯一标识一张卡片的外部ID（卡片幂等ID，可用于更新或重复发送同一卡片到多个群会话）
    @NameInMap("outTrackId")
    public String outTrackId;

    // 卡片用户私有差异部分数据（如卡片不同人显示不同按钮；key：用户userId；value：用户数据变量）
    @NameInMap("privateData")
    public java.util.Map privateData;

    // 互动卡片消息需要群会话部分人可见时的接收人列表，不填写默认群会话所有人可见
    @NameInMap("receiverUserIdList")
    public java.util.List receiverUserIdList;

    // 【robotCode & chatBotId二选一必填】机器人编码（群模板机器人）
    @NameInMap("robotCode")
    public String robotCode;

    // 用户ID类型：1：userId模式【默认】；2：unionId模式；对应receiverUserIdList、privateData字段关于用户id的值填写方式
    @NameInMap("userIdType")
    public Integer userIdType;

    public static SendInteractiveCardRequest build(java.util.Map map) throws Exception {
        SendInteractiveCardRequest self = new SendInteractiveCardRequest();
        return TeaModel.build(map, self);
    }

    public SendInteractiveCardRequest setAtOpenIds(java.util.Map atOpenIds) {
        this.atOpenIds = atOpenIds;
        return this;
    }
    public java.util.Map getAtOpenIds() {
        return this.atOpenIds;
    }

    public SendInteractiveCardRequest setCallbackRouteKey(String callbackRouteKey) {
        this.callbackRouteKey = callbackRouteKey;
        return this;
    }
    public String getCallbackRouteKey() {
        return this.callbackRouteKey;
    }

    public SendInteractiveCardRequest setCardData(SendInteractiveCardRequestCardData cardData) {
        this.cardData = cardData;
        return this;
    }
    public SendInteractiveCardRequestCardData getCardData() {
        return this.cardData;
    }

    public SendInteractiveCardRequest setCardOptions(SendInteractiveCardRequestCardOptions cardOptions) {
        this.cardOptions = cardOptions;
        return this;
    }
    public SendInteractiveCardRequestCardOptions getCardOptions() {
        return this.cardOptions;
    }

    public SendInteractiveCardRequest setCardTemplateId(String cardTemplateId) {
        this.cardTemplateId = cardTemplateId;
        return this;
    }
    public String getCardTemplateId() {
        return this.cardTemplateId;
    }

    public SendInteractiveCardRequest setChatBotId(String chatBotId) {
        this.chatBotId = chatBotId;
        return this;
    }
    public String getChatBotId() {
        return this.chatBotId;
    }

    public SendInteractiveCardRequest setConversationType(Integer conversationType) {
        this.conversationType = conversationType;
        return this;
    }
    public Integer getConversationType() {
        return this.conversationType;
    }

    public SendInteractiveCardRequest setOpenConversationId(String openConversationId) {
        this.openConversationId = openConversationId;
        return this;
    }
    public String getOpenConversationId() {
        return this.openConversationId;
    }

    public SendInteractiveCardRequest setOutTrackId(String outTrackId) {
        this.outTrackId = outTrackId;
        return this;
    }
    public String getOutTrackId() {
        return this.outTrackId;
    }

    public SendInteractiveCardRequest setPrivateData(java.util.Map privateData) {
        this.privateData = privateData;
        return this;
    }
    public java.util.Map getPrivateData() {
        return this.privateData;
    }

    public SendInteractiveCardRequest setReceiverUserIdList(java.util.List receiverUserIdList) {
        this.receiverUserIdList = receiverUserIdList;
        return this;
    }
    public java.util.List getReceiverUserIdList() {
        return this.receiverUserIdList;
    }

    public SendInteractiveCardRequest setRobotCode(String robotCode) {
        this.robotCode = robotCode;
        return this;
    }
    public String getRobotCode() {
        return this.robotCode;
    }

    public SendInteractiveCardRequest setUserIdType(Integer userIdType) {
        this.userIdType = userIdType;
        return this;
    }
    public Integer getUserIdType() {
        return this.userIdType;
    }

    public static class SendInteractiveCardRequestCardData extends TeaModel {
        // 卡片模板内容替换参数-多媒体类型
        @NameInMap("cardMediaIdParamMap")
        public java.util.Map cardMediaIdParamMap;

        // 卡片模板内容替换参数-普通文本类型
        @NameInMap("cardParamMap")
        public java.util.Map cardParamMap;

        public static SendInteractiveCardRequestCardData build(java.util.Map map) throws Exception {
            SendInteractiveCardRequestCardData self = new SendInteractiveCardRequestCardData();
            return TeaModel.build(map, self);
        }

        public SendInteractiveCardRequestCardData setCardMediaIdParamMap(java.util.Map cardMediaIdParamMap) {
            this.cardMediaIdParamMap = cardMediaIdParamMap;
            return this;
        }
        public java.util.Map getCardMediaIdParamMap() {
            return this.cardMediaIdParamMap;
        }

        public SendInteractiveCardRequestCardData setCardParamMap(java.util.Map cardParamMap) {
            this.cardParamMap = cardParamMap;
            return this;
        }
        public java.util.Map getCardParamMap() {
            return this.cardParamMap;
        }

    }

    public static class SendInteractiveCardRequestCardOptions extends TeaModel {
        // 是否支持转发
        @NameInMap("supportForward")
        public Boolean supportForward;

        public static SendInteractiveCardRequestCardOptions build(java.util.Map map) throws Exception {
            SendInteractiveCardRequestCardOptions self = new SendInteractiveCardRequestCardOptions();
            return TeaModel.build(map, self);
        }

        public SendInteractiveCardRequestCardOptions setSupportForward(Boolean supportForward) {
            this.supportForward = supportForward;
            return this;
        }
        public Boolean getSupportForward() {
            return this.supportForward;
        }

    }

}