Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
企业内部开发智慧硬件开发
第三方应用开发
企业内部开发智慧硬件开发
第三方应用开发
  1. 消息推送
  • 开发指南
    • 回调配置
      • 虚拟业务信息查询接口
    • 获取服务商凭证
      POST
  • 消息推送
    • 接收消息与事件
      • 概述
        • 概述-验证URL有效性
        • 概述-获取企业微信服务器的ip段
        • 概述-使用接收消息
    • 发送应用消息
      POST
    • 更新模版卡片消息
      POST
  • 通讯录管理
    • 成员管理
      • 创建成员
      • 读取成员
      • 更新成员
      • 删除成员
      • 批量删除成员
      • 获取部门成员
      • 获取部门成员详情
      • userid与openid互换-userid转openid
      • userid与openid互换-openid转userid
      • 二次验证
      • 邀请成员
    • 部门管理
      • 创建部门
      • 更新部门
      • 删除部门
      • 获取部门列表
    • 标签管理
      • 创建标签
      • 更新标签名字
      • 删除标签
      • 获取标签成员
      • 增加标签成员
      • 删除标签成员
      • 获取标签列表
    • 异步批量接口
      • 增量更新成员
      • 全量覆盖成员
      • 全量覆盖部门
      • 获取异步任务结果
  • 应用管理
    • 获取应用-获取指定的应用详情
      GET
    • 获取应用-获取access_token对应的应用列表
      GET
  • 素材管理
    • 上传临时素材
      POST
    • 上传图片
      POST
    • 获取临时素材
      GET
    • 获取高清语音素材
      GET
  • OA数据接口
    • 审批流程引擎
      POST
  • 电子发票
    • 查询电子发票
      POST
    • 更新发票状态
      POST
    • 批量更新发票状态
      POST
    • 批量查询电子发票
      POST
  • 推广二维码
    • 回调通知
      • 注册完成回调事件
    • 调用接口
      • 获取注册码
      • 查询注册状态
      • 设置授权应用可见范围
      • 设置通讯录同步完成
  • 应用授权
    • 接口调用
      • 获取第三方应用凭证
      • 获取预授权码
      • 设置授权配置
      • 获取企业永久授权码
      • 获取企业授权信息
      • 获取企业凭证
      • 获取应用的管理员列表
    • 回调接口
      • 标签通知事件 标签成员变更事件
  • 身份验证
    • 网页授权登录
      • 获取访问用户身份
      • 获取访问用户敏感信息
    • 扫码授权登录
      • 获取登录用户信息
  • 设备管理
    • 接口调用
      • 添加设备实例
      • 查询设备绑定信息
      • 重置设备SecretNo
      • 获取设备列表
      • 上传设备日志
      • 获取设备自定义参数
      • 删除设备实例
      • 设置打印机支持状态
  1. 消息推送

更新模版卡片消息

POST
http://127.0.0.1/cgi-bin/message/update_template_card
智慧硬件开发/消息推送
最后修改时间:2022-08-30 03:03:35
责任人:未设置
应用可以发送模板卡片消息,发送之后可再通过接口更新可回调的用户任务卡片消息的替换文案信息(仅原卡片为 按钮交互型、投票选择型、多项选择型的卡片以及填写了action_menu字段的文本通知型、图文展示型可以调用本接口更新)。
请注意,当应用调用发送模版卡片消息后,接口会返回一个response_code,通过response_code用户可以调用本接口一次。后续如果有用户点击任务卡片,回调接口也会带上response_code,开发者通过该code也可以调用本接口一次,注意response_code的有效期是24小时,超过24小时后将无法使用。

如果部分指定的用户无权限或不存在,更新仍然执行,但会返回无效的部分(即invaliduser),常见的原因是用户不在应用的可见范围内或者不在消息的接收范围内。#

更新按钮为不可点击状态#

可回调的卡片可以将按钮更新为不可点击状态,并且自定义文案
{
    "userids" : ["userid1","userid2"],
    "partyids" : [2,3],
    "tagids" : [44,55],
    "atall" : 0,
    "agentid" : 1,
    "response_code": "response_code",
    "button":{
        "replace_name": "replace_name"
    }
}
参数说明:
参数是否必须说明
userids否企业的成员ID列表(最多支持1000个)
partyids否企业的部门ID列表(最多支持100个)
tagids否企业的标签ID列表(最多支持100个)
atall否更新整个任务接收人员
agentid是应用的agentid
response_code是更新卡片所需要消费的code,可通过发消息接口和回调接口返回值获取,一个code只能调用一次该接口,且只能在24小时内调用
replace_name是需要更新的按钮的文案

更新为新的卡片#

可回调的卡片可以更新成任何一种模板卡片

文本通知型#

img
{
    "userids" : ["userid1","userid2"],
    "partyids" : [2,3],
    "agentid" : 1,
    "response_code": "response_code",
    "template_card" : {
        "card_type" : "text_notice",
        "source" : {
            "icon_url": "图片的url",
            "desc": "企业微信",
            "desc_color": 1
        },
        "action_menu": {
            "desc": "卡片副交互辅助文本说明",
            "action_list": [
                {"text": "接受推送", "key": "A"},
                {"text": "不再推送", "key": "B"}
            ]
        },
        "main_title" : {
            "title" : "欢迎使用企业微信",
            "desc" : "您的好友正在邀请您加入企业微信"
        },
        "quote_area": {
            "type": 1,
            "url": "https://work.weixin.qq.com",
            "title": "企业微信的引用样式",
            "quote_text": "企业微信真好用呀真好用"
        },
        "emphasis_content": {
            "title": "100",
            "desc": "核心数据"
        },
        "sub_title_text" : "下载企业微信还能抢红包!",
        "horizontal_content_list" : [
            {
                "keyname": "邀请人",
                "value": "张三"
            },
            {
                "type": 1,
                "keyname": "企业微信官网",
                "value": "点击访问",
                "url": "https://work.weixin.qq.com"
            },
            {
                "type": 2,
                "keyname": "企业微信下载",
                "value": "企业微信.apk",
                "media_id": "文件的media_id"
            },
            {
                "type": 3,
                "keyname": "员工信息",
                "value": "点击查看",
                "userid": "zhangsan"
            }
        ],
        "jump_list" : [
            {
                "type": 1,
                "title": "企业微信官网",
                "url": "https://work.weixin.qq.com"
            },
            {
                "type": 2,
                "title": "跳转小程序",
                "appid": "小程序的appid",
                "pagepath": "/index.html"
            }
        ],
        "card_action": {
            "type": 2,
            "url": "https://work.weixin.qq.com",
            "appid": "小程序的appid",
            "pagepath": "/index.html"
        }
    }
}
参数说明:
参数是否必须说明
userids否企业的成员ID列表(最多支持1000个)
partyids否企业的部门ID列表(最多支持100个)
tagids否企业的标签ID列表(最多支持100个)
atall否更新整个任务接收人员
agentid是应用的agentid
response_code是更新卡片所需要消费的code,可通过发消息接口和回调接口返回值获取,一个code只能调用一次该接口,且只能在24小时内调用
card_type是模板卡片类型,文本通知型卡片填写 “text_notice”
source否卡片来源样式信息,不需要来源样式可不填写
source.icon_url否来源图片的url
source.desc否来源图片的描述,建议不超过20个字
source.desc_color否来源文字的颜色,目前支持:0(默认) 灰色,1 黑色,2 红色,3 绿色
action_menu否卡片右上角更多操作按钮
action_menu.desc否更多操作界面的描述
action_menu.action_list是操作列表,列表长度取值范围为 [1, 3]
action_menu.action_list.text是操作的描述文案
action_menu.action_list.key是操作key值,用户点击后,会产生回调事件将本参数作为EventKey返回,回调事件会带上该key值,最长支持1024字节,不可重复
main_title.title否一级标题,建议不超过36个字,文本通知型卡片本字段非必填,但不可本字段和sub_title_text都不填
main_title.desc否标题辅助信息,建议不超过44个字
quote_area否引用文献样式
quote_area.type否引用文献样式区域点击事件,0或不填代表没有点击事件,1 代表跳转url,2 代表跳转小程序
quote_area.url否点击跳转的url,quote_area.type是1时必填
quote_area.appid否点击跳转的小程序的appid,必须是与当前应用关联的小程序,quote_area.type是2时必填
quote_area.pagepath否点击跳转的小程序的pagepath,quote_area.type是2时选填
quote_area.title否引用文献样式的标题
quote_area.quote_text否引用文献样式的引用文案
emphasis_content否关键数据样式
emphasis_content.title否关键数据样式的数据内容,建议不超过14个字
emphasis_content.desc否关键数据样式的数据描述内容,建议不超过22个字
sub_title_text否二级普通文本,建议不超过160个字
horizontal_content_list否二级标题+文本列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过6
horizontal_content_list.type否链接类型,0或不填代表不是链接,1 代表跳转url,2 代表下载附件,3 代表点击跳转成员详情
horizontal_content_list.keyname是二级标题,建议不超过5个字
horizontal_content_list.value否二级文本,如果horizontal_content_list.type是2,该字段代表文件名称(要包含文件类型),建议不超过30个字
horizontal_content_list.url否链接跳转的url,horizontal_content_list.type是1时必填
horizontal_content_list.media_id否附件的media_id,horizontal_content_list.type是2时必填
horizontal_content_list.userid否成员详情的userid,horizontal_content_list.type是3时必填
jump_list否跳转指引样式的列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过3
jump_list.type否跳转链接类型,0或不填代表不是链接,1 代表跳转url,2 代表跳转小程序
jump_list.title是跳转链接样式的文案内容,建议不超过18个字
jump_list.url否跳转链接的url,jump_list.type是1时必填
jump_list.appid否跳转链接的小程序的appid,jump_list.type是2时必填
jump_list.pagepath否跳转链接的小程序的pagepath,jump_list.type是2时选填
card_action是整体卡片的点击跳转事件,text_notice必填本字段
card_action.type是跳转事件类型,0或不填代表不是链接,1 代表跳转url,2 代表打开小程序
card_action.url否跳转事件的url,card_action.type是1时必填
card_action.appid否跳转事件的小程序的appid,card_action.type是2时必填
card_action.pagepath否跳转事件的小程序的pagepath,card_action.type是2时选填

图文展示型#

img
{
    "userids" : ["userid1","userid2"],
    "partyids" : [2,3],
    "agentid" : 1,
    "response_code": "response_code",
    "template_card" : {
        "card_type" : "news_notice",
        "source" : {
            "icon_url": "图片的url",
            "desc": "企业微信",
            "desc_color": 1
        },
        "action_menu": {
            "desc": "卡片副交互辅助文本说明",
            "action_list": [
                {"text": "接受推送", "key": "A"},
                {"text": "不再推送", "key": "B"}
            ]
        },
        "main_title" : {
            "title" : "欢迎使用企业微信",
            "desc" : "您的好友正在邀请您加入企业微信"
        },
        "quote_area": {
            "type": 1,
            "url": "https://work.weixin.qq.com",
            "title": "企业微信的引用样式",
            "quote_text": "企业微信真好用呀真好用"
        },
        "image_text_area": {
            "type": 1,
            "url": "https://work.weixin.qq.com",
            "title": "企业微信的左图右文样式",
            "desc": "企业微信真好用呀真好用",
            "image_url": "https://img.iplaysoft.com/wp-content/uploads/2019/free-images/free_stock_photo_2x.jpg"
        },
        "card_image": {
            "url": "图片的url",
            "aspect_ratio": 1.3
        },
        "vertical_content_list": [
            {
                "title": "惊喜红包等你来拿",
                "desc": "下载企业微信还能抢红包!"
            }
        ],
        "horizontal_content_list" : [
            {
                "keyname": "邀请人",
                "value": "张三"
            },
            {
                "type": 1,
                "keyname": "企业微信官网",
                "value": "点击访问",
                "url": "https://work.weixin.qq.com"
            },
            {
                "type": 2,
                "keyname": "企业微信下载",
                "value": "企业微信.apk",
                "media_id": "文件的media_id"
            },
            {
                "type": 3,
                "keyname": "员工信息",
                "value": "点击查看",
                "userid": "zhangsan"
            }
        ],
        "jump_list" : [
            {
                "type": 1,
                "title": "企业微信官网",
                "url": "https://work.weixin.qq.com"
            },
            {
                "type": 2,
                "title": "跳转小程序",
                "appid": "小程序的appid",
                "pagepath": "/index.html"
            }
        ],
        "card_action": {
            "type": 2,
            "url": "https://work.weixin.qq.com",
            "appid": "小程序的appid",
            "pagepath": "/index.html"
        }
    }
}
参数说明:
参数是否必须说明
userids否企业的成员ID列表(最多支持1000个)
partyids否企业的部门ID列表(最多支持100个)
tagids否企业的标签ID列表(最多支持100个)
atall否更新整个任务接收人员
agentid是应用的agentid
response_code是更新卡片所需要消费的code,可通过发消息接口和回调接口返回值获取,一个code只能调用一次该接口,且只能在24小时内调用
card_type是模板卡片类型,图文展示型卡片此处填写 “news_notice”
source否卡片来源样式信息,不需要来源样式可不填写
source.icon_url否来源图片的url
source.desc否来源图片的描述,建议不超过20个字
source.desc_color否来源文字的颜色,目前支持:0(默认) 灰色,1 黑色,2 红色,3 绿色
action_menu否卡片右上角更多操作按钮
action_menu.desc否更多操作界面的描述
action_menu.action_list是操作列表,列表长度取值范围为 [1, 3]
action_menu.action_list.text是操作的描述文案
action_menu.action_list.key是操作key值,用户点击后,会产生回调事件将本参数作为EventKey返回,回调事件会带上该key值,最长支持1024字节,不可重复
main_title.title是一级标题,建议不超过36个字
main_title.desc否标题辅助信息,建议不超过44个字
quote_area否引用文献样式
quote_area.type否引用文献样式区域点击事件,0或不填代表没有点击事件,1 代表跳转url,2 代表跳转小程序
quote_area.url否点击跳转的url,quote_area.type是1时必填
quote_area.appid否点击跳转的小程序的appid,必须是与当前应用关联的小程序,quote_area.type是2时必填
quote_area.pagepath否点击跳转的小程序的pagepath,quote_area.type是2时选填
quote_area.title否引用文献样式的标题
quote_area.quote_text否引用文献样式的引用文案
image_text_area否左图右文样式,news_notice类型的卡片,card_image和image_text_area两者必填一个字段,不可都不填
image_text_area.type否左图右文样式区域点击事件,0或不填代表没有点击事件,1 代表跳转url,2 代表跳转小程序
image_text_area.url否点击跳转的url,image_text_area.type是1时必填
image_text_area.appid否点击跳转的小程序的appid,必须是与当前应用关联的小程序,image_text_area.type是2时必填
image_text_area.pagepath否点击跳转的小程序的pagepath,image_text_area.type是2时选填
image_text_area.title否左图右文样式的标题
image_text_area.desc否左图右文样式的描述
image_text_area.image_url是左图右文样式的图片url
card_image否图片样式,news_notice类型的卡片,card_image和image_text_area两者必填一个字段,不可都不填
card_image.url是图片的url
card_image.aspect_ratio否图片的宽高比,宽高比要小于2.25,大于1.3,不填该参数默认1.3
vertical_content_list否卡片二级垂直内容,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过4
vertical_content_list.title是卡片二级标题,建议不超过38个字
vertical_content_list.desc否二级普通文本,建议不超过160个字
horizontal_content_list否二级标题+文本列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过6
horizontal_content_list.type否链接类型,0或不填代表不是链接,1 代表跳转url,2 代表下载附件,3 代表点击跳转成员详情
horizontal_content_list.keyname是二级标题,建议不超过5个字
horizontal_content_list.value否二级文本,如果horizontal_content_list.type是2,该字段代表文件名称(要包含文件类型),建议不超过30个字
horizontal_content_list.url否链接跳转的url,horizontal_content_list.type是1时必填
horizontal_content_list.media_id否附件的media_id,horizontal_content_list.type是2时必填
horizontal_content_list.userid否成员详情的userid,horizontal_content_list.type是3时必填
jump_list否跳转指引样式的列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过3
jump_list.type否跳转链接类型,0或不填代表不是链接,1 代表跳转url,2 代表跳转小程序
jump_list.title是跳转链接样式的文案内容,建议不超过18个字
jump_list.url否跳转链接的url,jump_list.type是1时必填
jump_list.appid否跳转链接的小程序的appid,jump_list.type是2时必填
jump_list.pagepath否跳转链接的小程序的pagepath,jump_list.type是2时选填
card_action是整体卡片的点击跳转事件,news_notice必填本字段
card_action.type是跳转事件类型,0或不填代表不是链接,1 代表跳转url,2 代表打开小程序
card_action.url否跳转事件的url,card_action.type是1时必填
card_action.appid否跳转事件的小程序的appid,card_action.type是2时必填
card_action.pagepath否跳转事件的小程序的pagepath,card_action.type是2时选填

按钮交互型#

img
{
    "userids" : ["userid1","userid2"],
    "partyids" : [2,3],
    "agentid" : 1,
    "response_code": "response_code",
    "template_card" : {
        "card_type" : "button_interaction",
        "source" : {
            "icon_url": "图片的url",
            "desc": "企业微信",
            "desc_color": 1
        },
        "action_menu": {
            "desc": "卡片副交互辅助文本说明",
            "action_list": [
                {"text": "接受推送", "key": "A"},
                {"text": "不再推送", "key": "B"}
            ]
        },
        "main_title" : {
            "title" : "欢迎使用企业微信",
            "desc" : "您的好友正在邀请您加入企业微信"
        },
        "quote_area": {
            "type": 1,
            "url": "https://work.weixin.qq.com",
            "title": "企业微信的引用样式",
            "quote_text": "企业微信真好用呀真好用"
        },
        "sub_title_text" : "下载企业微信还能抢红包!",
        "horizontal_content_list" : [
            {
                "keyname": "邀请人",
                "value": "张三"
            },
            {
                "type": 1,
                "keyname": "企业微信官网",
                "value": "点击访问",
                "url": "https://work.weixin.qq.com"
            },
            {
                "type": 2,
                "keyname": "企业微信下载",
                "value": "企业微信.apk",
                "media_id": "文件的media_id"
            },
            {
                "type": 3,
                "keyname": "员工信息",
                "value": "点击查看",
                "userid": "zhangsan"
            }
        ],
        "card_action": {
            "type": 2,
            "url": "https://work.weixin.qq.com",
            "appid": "小程序的appid",
            "pagepath": "/index.html"
        },
        "button_selection": {
            "question_key": "btn_question_key1",
            "title": "企业微信评分",
            "option_list": [
                {
                    "id": "btn_selection_id1",
                    "text": "100分"
                },
                {
                    "id": "btn_selection_id2",
                    "text": "101分"
                }
            ],
            "selected_id": "btn_selection_id1"
        },
        "button_list": [
            {
                "text": "按钮1",
                "style": 1,
                "key": "button_key_1"
            },
            {
                "text": "按钮2",
                "style": 2,
                "key": "button_key_2"
            }
        ],
        "replace_text": "已提交"
    }
}
参数说明:
参数是否必须说明
userids否企业的成员ID列表(最多支持1000个)
partyids否企业的部门ID列表(最多支持100个)
tagids否企业的标签ID列表(最多支持100个)
atall否更新整个任务接收人员
agentid是应用的agentid
response_code是更新卡片所需要消费的code,可通过发消息接口和回调接口返回值获取,一个code只能调用一次该接口,且只能在24小时内调用
card_type是模板卡片类型,按钮交互型卡片填写”button_interaction”
source否卡片来源样式信息,不需要来源样式可不填写
source.icon_url否来源图片的url
source.desc否来源图片的描述,建议不超过20个字
source.desc_color否来源文字的颜色,目前支持:0(默认) 灰色,1 黑色,2 红色,3 绿色
action_menu否卡片右上角更多操作按钮
action_menu.desc否更多操作界面的描述
action_menu.action_list是操作列表,列表长度取值范围为 [1, 3]
action_menu.action_list.text是操作的描述文案
action_menu.action_list.key是操作key值,用户点击后,会产生回调事件将本参数作为EventKey返回,回调事件会带上该key值,最长支持1024字节,不可重复
main_title.title是一级标题,建议不超过36个字
main_title.desc否标题辅助信息,建议不超过44个字
quote_area否引用文献样式
quote_area.type否引用文献样式区域点击事件,0或不填代表没有点击事件,1 代表跳转url,2 代表跳转小程序
quote_area.url否点击跳转的url,quote_area.type是1时必填
quote_area.appid否点击跳转的小程序的appid,必须是与当前应用关联的小程序,quote_area.type是2时必填
quote_area.pagepath否点击跳转的小程序的pagepath,quote_area.type是2时选填
quote_area.title否引用文献样式的标题
quote_area.quote_text否引用文献样式的引用文案
sub_title_text否二级普通文本,建议不超过160个字
horizontal_content_list否二级标题+文本列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过6
horizontal_content_list.type否链接类型,0或不填代表不是链接,1 代表跳转url,2 代表下载附件,3 代表点击跳转成员详情
horizontal_content_list.keyname是二级标题,建议不超过5个字
horizontal_content_list.value否二级文本,如果horizontal_content_list.type是2,该字段代表文件名称(要包含文件类型),建议不超过30个字
horizontal_content_list.url否链接跳转的url,horizontal_content_list.type是1时必填
horizontal_content_list.media_id否附件的media_id,horizontal_content_list.type是2时必填
horizontal_content_list.userid否成员详情的userid,horizontal_content_list.type是3时必填
card_action否整体卡片的点击跳转事件
card_action.type否跳转事件类型,0或不填代表不是链接,1 代表跳转url,2 代表打开小程序
card_action.url否跳转事件的url,card_action.type是1时必填
card_action.appid否跳转事件的小程序的appid,card_action.type是2时必填
card_action.pagepath否跳转事件的小程序的pagepath,card_action.type是2时选填
button_selection.question_key是下拉式的选择器的key,用户提交选项后,会产生回调事件,回调事件会带上该key值表示该题,最长支持1024字节
button_selection.title否下拉式的选择器左边的标题
button_selection.option_list是选项列表,下拉选项不超过 10 个,最少1个
button_selection.selected_id否默认选定的id,不填或错填默认第一个
button_selection.option_list.id是下拉式的选择器选项的id,用户提交后,会产生回调事件,回调事件会带上该id值表示该选项,最长支持128字节,不可重复
button_selection.option_list.text是下拉式的选择器选项的文案,建议不超过16个字
button_list是按钮列表,列表长度不超过6
button_list.type否按钮点击事件类型,0 或不填代表回调点击事件,1 代表跳转url
button_list.text是按钮文案,建议不超过10个字
button_list.style否按钮样式,目前可填1~4,不填或错填默认1
button_list.key否按钮key值,用户点击后,会产生回调事件将本参数作为EventKey返回,回调事件会带上该key值,最长支持1024字节,不可重复,button_list.type是0时必填
button_list.url否跳转事件的url,button_list.type是1时必填
replace_text否按钮替换文案,填写本字段后会展现灰色不可点击按钮
备注:
按钮样式
img

投票选择型#

img
{
    "userids" : ["userid1","userid2"],
    "partyids" : [2,3],
    "agentid" : 1,
    "response_code": "response_code",
    "template_card" : {
        "card_type" : "vote_interaction",
        "source" : {
            "icon_url": "图片的url",
            "desc": "企业微信"
        },
        "main_title" : {
            "title" : "欢迎使用企业微信",
            "desc" : "您的好友正在邀请您加入企业微信"
        },
        "checkbox": {
            "question_key": "question_key1",
            "option_list": [
                {
                    "id": "option_id1",
                    "text": "选择题选项1",
                    "is_checked": true
                },
                {
                    "id": "option_id2",
                    "text": "选择题选项2",
                    "is_checked": false
                }
            ],
            "disable": false,
            "mode": 1
        },
        "submit_button": {
            "text": "提交",
            "key": "key"
        },
        "replace_text": "已提交"
    }
}
参数说明:
参数是否必须说明
userids否企业的成员ID列表(最多支持1000个)
partyids否企业的部门ID列表(最多支持100个)
tagids否企业的标签ID列表(最多支持100个)
atall否更新整个任务接收人员
agentid是应用的agentid
response_code是更新卡片所需要消费的code,可通过发消息接口和回调接口返回值获取,一个code只能调用一次该接口,且只能在24小时内调用
card_type是模板卡片类型,投票选择型卡片填写”vote_interaction”
source否卡片来源样式信息,不需要来源样式可不填写
source.icon_url否来源图片的url
source.desc否来源图片的描述,建议不超过20个字
main_title.title是一级标题,建议不超过16个字
main_title.desc否二级普通文本,建议不超过160个字
checkbox否选择题样式
checkbox.question_key是选择题key值,用户提交选项后,会产生回调事件,回调事件会带上该key值表示该题,最长支持1024字节
checkbox.disable否是否可以选择状态
checkbox.mode否选择题模式,单选:0,多选:1,不填默认0
checkbox.option_list是选项list,选项个数不超过 20 个,最少1个
checkbox.option_list.id是选项id,用户提交选项后,会产生回调事件,回调事件会带上该id值表示该选项,最长支持128字节,不可重复
checkbox.option_list.text是选项文案描述,建议不超过17个字
checkbox.option_list.is_checked是该选项是否要默选中
submit_button否提交按钮样式
submit_button.text是按钮文案,建议不超过10个字,不填默认为提交
submit_button.key是提交按钮的key,会产生回调事件将本参数作为EventKey返回,最长支持1024字节
replace_text否按钮替换文案,填写本字段后会展现灰色不可点击按钮

多项选择型#

img
{
    "userids" : ["userid1","userid2"],
    "partyids" : [2,3],
    "tagids" : [44,55],
    "atall" : 0,
    "agentid" : 1,
    "response_code": "response_code",
    "template_card" : {
        "card_type" : "multiple_interaction",
        "source" : {
            "icon_url": "图片的url",
            "desc": "企业微信"
        },
        "main_title" : {
            "title" : "欢迎使用企业微信",
            "desc" : "您的好友正在邀请您加入企业微信"
        },
        "select_list": [
            {
                "question_key": "question_key1",
                "title": "选择器标签1",
                "selected_id": "selection_id1",
                "disable": false,
                "option_list": [
                    {
                        "id": "selection_id1",
                        "text": "选择器选项1"
                    },
                    {
                        "id": "selection_id2",
                        "text": "选择器选项2"
                    }
                ]
            },
            {
                "question_key": "question_key2",
                "title": "选择器标签2",
                "selected_id": "selection_id3",
                "disable": false,
                "option_list": [
                    {
                        "id": "selection_id3",
                        "text": "选择器选项3"
                    },
                    {
                        "id": "selection_id4",
                        "text": "选择器选项4"
                    }
                ]
            }
        ],
        "submit_button": {
            "text": "提交",
            "key": "key"
        },
        "replace_text": "已提交"
    }
}
参数说明:
参数是否必须说明
userids否企业的成员ID列表(最多支持1000个)
partyids否企业的部门ID列表(最多支持100个)
tagids否企业的标签ID列表(最多支持100个)
atall否更新整个任务接收人员
agentid是应用的agentid
response_code是更新卡片所需要消费的code,可通过发消息接口和回调接口返回值获取,一个code只能调用一次该接口,且只能在24小时内调用
card_type是模板卡片类型,多项选择型卡片填写 “multiple_interaction”
source否卡片来源样式信息,不需要来源样式可不填写
source.icon_url否来源图片的url
source.desc否来源图片的描述,建议不超过20个字
main_title.title是一级标题,建议不超过36个字
main_title.desc否标题辅助信息,建议不超过160个字
select_list是下拉式的选择器列表,multiple_interaction类型的卡片该字段不可为空,一个消息最多支持 3 个选择器
select_list.question_key是下拉式的选择器题目的key,用户提交选项后,会产生回调事件,回调事件会带上该key值表示该题,最长支持1024字节,不可重复
select_list.title否下拉式的选择器上面的title
select_list.option_list是选项列表,下拉选项不超过 10 个,最少1个
select_list.selected_id否默认选定的id,不填或错填默认第一个
select_list.disable否是否可以选择状态
select_list.option_list.id是下拉式的选择器选项的id,用户提交选项后,会产生回调事件,回调事件会带上该id值表示该选项,最长支持128字节,不可重复
select_list.option_list.text是下拉式的选择器选项的文案,建议不超过16个字
submit_button否提交按钮样式
submit_button.text是按钮文案,建议不超过10个字,不填默认为提交
submit_button.key是提交按钮的key,会产生回调事件将本参数作为EventKey返回,最长支持1024字节
replace_text否按钮替换文案,填写本字段后会展现灰色不可点击按钮
文档ID: 32086
原文档地址:
https://open.work.weixin.qq.com/api/doc/90001/94945
https://open.work.weixin.qq.com/api/doc/90000/94888

请求参数

Query 参数
access_token
string 
调用接口凭证
必需
示例值:
{{accesstoken}}
Body 参数application/json
userids
array[string]
必需
partyids
array[integer]
必需
tagids
array[integer]
必需
atall
integer 
必需
agentid
integer 
必需
response_code
string 
必需
button
object 
必需
replace_name
string 
必需
示例
{
  "userids": [
    "userid1",
    "userid2"
  ],
  "partyids": [
    2,
    3
  ],
  "tagids": [
    44,
    55
  ],
  "atall": 0,
  "agentid": 1,
  "response_code": "response_code",
  "button": {
    "replace_name": "replace_name"
  }
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'http://127.0.0.1/cgi-bin/message/update_template_card?access_token={{accesstoken}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userids": [
        "userid1",
        "userid2"
    ],
    "partyids": [
        2,
        3
    ],
    "tagids": [
        44,
        55
    ],
    "atall": 0,
    "agentid": 1,
    "response_code": "response_code",
    "button": {
        "replace_name": "replace_name"
    }
}'

返回响应

🟢200成功
application/json
Body
errcode
integer 
必需
errmsg
string 
必需
invaliduser
array[string]
必需
不区分大小写,返回的列表都统一转为小写
示例
{
  "errcode": 0,
  "errmsg": "string",
  "invaliduser": [
    "string"
  ]
}
上一页
发送应用消息
下一页
创建成员
Built with