# 助手消息

# 发送助手消息

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

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

# 概述

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

# 参数

参数 参数类型 必须 说明
access_token String 调用接口凭证
agent_id String 应用app_id
chatbot_id String 授权应用的机器人id (目前支持红包机器人助手(3007)、周报机器人助手(3005),需要先授权才能使用)
userids String 接收助手消息的员工id,半角竖线隔开,接收人员不能超过100人。
message String 消息格式参考:消息类型与数据格式
is_skip_error Int 遇到不存在的用户,是否跳过校验,默认0(0:否1:是)
important_flag Int 重要通知标识,默认0(0:不推送 1:推送)
everyone_sscard_msg Int 多人时是否按照单个人发消息。
userids是多人时且只有消息类型是sscard时有效,默认0(0:多个人返回同一个消息id 1:每个人都返回一条自己的消息id),且不能userids不能超过10人

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "msgBodyId":"61087906893637192"
    }
}

当everyone_sscard_msg为1{
  "code": 200,
  "msg": "",
  "obj": {
    "yach111111": {
      "msgBodyId": 593074552100270121
    },
    "yach222222": {
      "msgBodyId": 593074552100270123
    },
    "yach333333": {
      "msgBodyId": 593074552100270124
    }
  }
}

{ "code": 200, "msg": "", "obj": { "112362": { "task_id": 593019860183855233 }, "300859": { "task_id": 593019860183855236 }, "111965": { "task_id": 593019860183855239 } } }


## 撤回助手消息
#### host: https://yach-oapi.zhiyinlou.com 正式环境
#### host: https://yach-oapi-test.zhiyinlou.com 测试环境

### 概述
| 名称 | 值 |
| ------- | ---- |
| 地址    | /chatbot/message/recall?access_token=ACCESS_TOKEN |
| 请求方式 | POST |
| 参数 | 见【参数】 |
| 返回值 | 见【返回值】 |


### 参数
| 参数    | 参数类型 | 必须  | 说明 |
| ------- | -------- | ------ | ---------------------------------------------------------------------- |
| access_token | String | 是 | 调用接口凭证 |
| chatbot_id | String | 是 | 授权应用的机器人id (目前支持红包机器人助手(3007)、周报机器人助手(3005),需要先授权才能使用) |
| msg_body_ids | String | 是| 助手消息id,半角竖线隔开,不能超过100个 |

返回值
```json
{
    "code": 200,
    "msg": "",
    "obj": {
        "recallMid":"61087906893637193"
    }
}

# 更新助手消息(当前仅支持sscard消息类型)

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

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

# 概述

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

# 参数

参数 参数类型 必须 说明
access_token String 调用接口凭证
chatbot_id String 授权应用的机器人id (目前支持红包机器人助手(3007)、周报机器人助手(3005),需要先授权才能使用)
message String 消息格式参考:消息类型与数据格式
msg_body_ids String 助手消息id,半角竖线隔开,不能超过10个

返回值

{
    "code": 200,
    "msg": "",
    "obj": [
        "61087906893637193",
        "61087906893637194"
    ]
}

# 获取助手某条消息详情

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

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

# 概述

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

# 参数

参数 参数类型 必须 说明
access_token String 调用接口凭证
chatbot_id String 授权应用的机器人id (目前支持红包机器人助手(3007)、周报机器人助手(3005),需要先授权才能使用)
message String 消息格式参考:消息类型与数据格式
msg_body_ids String 助手消息id,半角竖线隔开,不能超过10个

返回值

{
  "code": 200,
  "msg": "",
  "obj": {
    "585504564590104764": {
      "msgtype": "sscard",
      "sscard": [
        {
          "type": "header",
          "id": "111111",
          "title": {
            "i18n": {
              "zh_cn": "这是一个中文的 Markdown",
              "en_us": "This is a markdown"
            }
          },
          "textColor": "ff0000",
          "backgroundColor": "ff0000"
        }
      ],
      "last_msg": "这里是sscardtitle"
    }
  }
}
上次更新: 9/12/2024, 9:07:19 PM
foo