Yach开放平台

# 普通消息

# 点对点普通消息

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /single/message/send?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
from_user_id String 是 发送者员工yach唯一标识 yach131763
to_user_id String 是 接收者员工yach唯一标识 yach076429
message String 是 消息格式参考：消息类型与数据格式
message_id String 否 业务方消息唯一ID（主要用于避免业务方消息重复发送）

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "yachMid":"61087906893637191"
    }
}

# 点对点机器人消息

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /v1/single/message/send?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

该接口单机器人限频为 60次/分钟

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
to_user_id String 否 接收者员工yach唯一标识 32343242342432，多个用户用半角竖线分割，单次最多支持100个用户，to_user_id和to_work_code两者不能同时为空，sscard类型消息不支持批量发送
to_work_code String 否 接收者员工工号 1234567，多个用户用半角竖线分割，单次最多支持100个用户，to_user_id和to_work_code两者不能同时为空，sscard类型消息不支持批量发送
message String 是 消息格式参考：消息类型与数据格式
message_id String 否 业务方消息唯一ID（主要用于避免业务方消息重复发送）

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "yachMid":"61087906893637191"
    }
}

# 点对点机器人群消息

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /group/robot/message/send?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
group_id String 是 群唯一标识 2740956956
message String 是 消息格式参考：消息类型与数据格式
message_id String 否 业务方消息唯一ID（主要用于避免消息重复发送）

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "yachMid":"61087906893637191"
    }
}

# 点对群消息

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /group/message/send?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
from_user_id String 是 发送者员工 yach唯一标识 yach131763
group_id String 是 群唯一标识 2740956956
message String 是 消息格式参考：消息类型与数据格式
message_id String 否 业务方消息唯一ID（主要用于避免消息重复发送）

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "yachMid":"61087906893637191"
    }
}

# 点对点普通消息批量

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /single/message/batch/send?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
from_user_id String 是 发送者员工yach唯一标识（yach131763）
is_skip_error int 是 to_user_ids是否跳过已离职的人员，继续给其他有效用户发送消息（默认:0，0:不跳过 1:跳过）
to_user_ids String 是 接收者员工列表，半角竖线分割
message String 是 消息格式参考：消息类型与数据格式
message_id String 否 业务方消息唯一ID（主要用于避免消息重复发送）

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "yachMid":"61087906893637191"
    }
}

# 聊天机器人异步推送消息

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

注意

目前该接口仅只支持stream类型的消息，后续会逐步支持其它类型。

# 概述

名称 值
地址 /chat_robot/message/send?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
to_id String 是 接收者ID，接收人的用户ID或者接收群组的ID
conversation_type int 是 会话类型，1为私聊，2为群聊，对应机器人抄送消息的conversationType一致
last_msg String 否 流式消息类型时候必传，用于会话列表的消息展示
message String 是 消息格式参考：消息类型与数据格式

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "yachMid":"61087906893637191"
    }
}

# 获取普通消息内容(仅支持sscard类型消息)

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

注意

目前该接口仅支持sscard类型消息

# 概述

名称 值
地址 /normal/message/sscard/info?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
msg_id String 是 发送消息的接口返回的消息id
to_id String 是 接收者ID，接收人的用户ID或者接收群组的ID
conversation_type int 是 会话类型，1为私聊，2为群聊(暂不支持)

private_message 字段群聊时候才有

返回值

{
  "code": 200,
  "msg": "",
  "obj": {
    "msg":"[{\"type\":\"select_person\",\"id\":\"select_person\",\"title\":{\"i18n\":{\"zh_cn\":\"\参\会\人\",\"en_us\":\"attendee\"}},\"placeholder_title\":{\"i18n\":{\"zh_cn\":\"\",\"en_us\":\"\"}},\"action_url\":\"https:\\/\\/xxxxx.com\\/\\/test\\/session\\/sscard\",\"limit\":50,\"required\":true,\"required_tips\":{\"i18n\":{\"zh_cn\":\"\请\选\择\参\会\人\",\"en_us\":\"please select attendee\"}},\"prompt_tips\":{\"i18n\":{\"zh_cn\":\"\",\"en_us\":\"\"}},\"default_person\":\"Yach111965,yach088408\",\"locked_person\":\"\"}]",
    "mod_time": 1713769182,
    "private_message":{
      "message_list": {
        "agree": "[{\"type\":\"select_person\",\"id\":\"select_person\",\"title\":{\"i18n\":{\"zh_cn\":\"\参\会\人\",\"en_us\":\"attendee\"}},\"placeholder_title\":{\"i18n\":{\"zh_cn\":\"\",\"en_us\":\"\"}},\"action_url\":\"https:\\/\\/xxxxx.com\\/\\/test\\/session\\/sscard\",\"limit\":50,\"required\":true,\"required_tips\":{\"i18n\":{\"zh_cn\":\"\请\选\择\参\会\人\",\"en_us\":\"please select attendee\"}},\"prompt_tips\":{\"i18n\":{\"zh_cn\":\"\",\"en_us\":\"\"}},\"default_person\":\"Yach111965,yach088408\",\"locked_person\":\"\"}]",
        "refuse": "[{\"type\":\"select_person\",\"id\":\"select_person\",\"title\":{\"i18n\":{\"zh_cn\":\"\参\会\人\",\"en_us\":\"attendee\"}},\"placeholder_title\":{\"i18n\":{\"zh_cn\":\"\",\"en_us\":\"\"}},\"action_url\":\"https:\\/\\/xxxxx.com\\/\\/test\\/session\\/sscard\",\"limit\":50,\"required\":true,\"required_tips\":{\"i18n\":{\"zh_cn\":\"\请\选\择\参\会\人\",\"en_us\":\"please select attendee\"}},\"prompt_tips\":{\"i18n\":{\"zh_cn\":\"\",\"en_us\":\"\"}},\"default_person\":\"Yach111965,yach088408\",\"locked_person\":\"\"}]",
        "user_data": {
          "agree": [
            "uuid3",
            "uuid4"
          ],
          "refuse": [
            "uuid1",
            "uuid2"
          ]
        }
      }
  }
}

# 修改普通消息内容

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

注意

目前该接口仅支持sscard类型消息

# 概述

名称 值
地址 /normal/message/sscard/update?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用口凭证
to_id String 是 接收者ID，接收人的用户ID或者接收群组的ID
message String 是 消息格式参考：消息类型与数据格式
conversation_type int 是 会话类型，1为私聊，2为群聊(暂不支持)
msg_id String 否 发送普通消息接口返回的消息id

返回值

{
  "code": 200,
  "msg": "",
  "obj": {}
}
上次更新: 1/2/2025, 9:53:41 PM

← 助手消息 →

foo