wechat-api/desc/wechat/whatsapp.api

import "../base.api"
import "./agent.api"
import "./label_relationship.api"

type (
    // The data of whatsapp information | Whatsapp信息
    WhatsappInfo {
        BaseIDInfo

        // Status 1: normal 2: ban | 状态 1 正常 2 禁用 
        Status  *uint8 `json:"status,optional"`

        // ak 
        Ak  *string `json:"ak,optional"`

        // 端口号 
        Sk  *string `json:"sk,optional"`

        // 回调地址 
        Callback  *string `json:"callback,optional"`

        // 微信账号 
        Account  *string `json:"account,optional"`

        // 昵称 
        Nickname  *string `json:"nickname,optional"`

        // 手机号 
        Phone  *string `json:"phone,optional"`

        // 机构 ID 
        OrganizationId  *uint64 `json:"organizationId,optional"`
		OrganizationName *string `json:"organizationName,optional"`

        // 模式ID 
        AgentId  *uint64 `json:"agentId,optional"`
		AgentInfo *AgentInfo `json:"agentInfo,optional"`

        // 大模型服务地址 
        ApiBase  *string `json:"apiBase,optional"`

        // 大模型服务密钥 
        ApiKey  *string `json:"apiKey,optional"`

        // 白名单 
        AllowList  []ContactInfo `json:"allowList,optional"`

        // 群白名单 
        GroupAllowList  []ContactInfo `json:"groupAllowList,optional"`

        // 黑名单 
        BlockList  []ContactInfo `json:"blockList,optional"`

        // 群黑名单 
        GroupBlockList  []ContactInfo `json:"groupBlockList,optional"`
    }

    // The response data of whatsapp list | Whatsapp列表数据
    WhatsappListResp {
        BaseDataInfo

        // Whatsapp list data | Whatsapp列表数据
        Data WhatsappListInfo `json:"data"`
    }

    // Whatsapp list data | Whatsapp列表数据
    WhatsappListInfo {
        BaseListInfo

        // The API list data | Whatsapp列表数据
        Data  []WhatsappInfo  `json:"data"`
    }

    // Get whatsapp list request params | Whatsapp列表请求参数
    WhatsappListReq {
        PageInfo

        // ak 
        Ak  *string `json:"ak,optional"`

        // 端口号 
        Sk  *string `json:"sk,optional"`

        // 回调地址 
        Callback  *string `json:"callback,optional"`
    }

    // Whatsapp information response | Whatsapp信息返回体
    WhatsappInfoResp {
        BaseDataInfo

        // Whatsapp information | Whatsapp数据
        Data WhatsappInfo `json:"data"`
    }
)

@server(
    jwt: Auth
    group: whatsapp
    middleware: Authority
)

service Wechat {
    // Create whatsapp information | 创建Whatsapp
    @handler createWhatsapp
    post /whatsapp/create (WhatsappInfo) returns (BaseMsgResp)

    // Update whatsapp information | 更新Whatsapp
    @handler updateWhatsapp
    post /whatsapp/update (WhatsappInfo) returns (BaseMsgResp)

    // Delete whatsapp information | 删除Whatsapp信息
    @handler deleteWhatsapp
    post /whatsapp/delete (IDsReq) returns (BaseMsgResp)

    // Get whatsapp list | 获取Whatsapp列表
    @handler getWhatsappList
    post /whatsapp/list (WhatsappListReq) returns (WhatsappListResp)

    // Get whatsapp by ID | 通过ID获取Whatsapp
    @handler getWhatsappById
    post /whatsapp (IDReq) returns (WhatsappInfoResp)
}