# 普通消息

# 点对点普通消息

# 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
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 调用接口凭证
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 测试环境

# 概述

名称
地址 /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"
    }
}
上次更新: 5/18/2023, 6:55:39 PM
foo