第三方应用开发 服务端API 效率工具 日程 日历接口
日历接口

目录

  • 创建日历
  • 更新日历
  • 获取日历详情
  • 删除日历
  • 创建日历

    该接口用于通过应用在企业内创建一个日历。

    注: 企业微信需要更新到3.0.2及以上版本

    请求方式: POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/oa/calendar/add?access_token=ACCESS_TOKEN

    请求包体:

    {
        "calendar" : {
            "organizer" : "userid1",
            "readonly" : 1,
            "set_as_default" : 1,
            "summary" : "test_summary",
            "color" : "#FF3030",
            "description" : "test_describe",
            "shares" : [
                {
                    "userid" : "userid2"
                },
                {
                    "userid" : "userid3",
                    "readonly" : 1
                }
            ]
        },
        "agentid" : 1000014
    }

    参数说明:

    参数是否必须说明
    calendar日历信息
    organizer指定的组织者userid。注意该字段指定后不可更新
    readonly日历组织者对日历是否只读权限(即不可编辑日历,不可在日历上添加日程,仅可作为组织者删除日历)。
    0-否;1-是。默认为1,即只读
    set_as_default是否将该日历设置为组织者的默认日历。
    0-否;1-是。默认为0,即不设为默认日历
    第三方应用不支持使用该参数
    summary日历标题。1 ~ 128 字符
    color日历在终端上显示的颜色,RGB颜色编码16进制表示,例如:"#0000FF" 表示纯蓝色
    description日历描述。0 ~ 512 字符
    shares日历共享成员列表。最多2000人
    shares.userid日历共享成员的id
    shares.readonly共享成员对日历是否只读权限(即不可编辑日历,不可在日历上添加日程,仅可以退出日历)。
    0-否;1-是。默认为1,即只读
    agentid授权方安装的应用agentid。仅旧的第三方多应用套件需要填此参数

     

    返回结果:

    { 
    	"errcode": 0,
    	"errmsg" : "ok",
    	"cal_id":"wcjgewCwAAqeJcPI1d8Pwbjt7nttzAAA"
    }

    参数说明:

    参数说明
    errcode错误码
    errmsg错误码说明
    cal_id日历ID

    更新日历

    该接口用于修改指定日历的信息。

    注意,更新操作是覆盖式,而不是增量式
    企业微信需要更新到3.0.2及以上版本

    请求方式: POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/oa/calendar/update?access_token=ACCESS_TOKEN

     

    请求包体:

    {
        "calendar" : {
            "cal_id":"wcjgewCwAAqeJcPI1d8Pwbjt7nttzAAA",
            "readonly" : 1,
            "summary" : "test_summary",
            "color" : "#FF3030",
            "description" : "test_describe_1",
            "shares" : [
                {
                    "userid" : "userid1"
                },
                {
                    "userid" : "userid2",
                    "readonly" : 1
                }
            ]
        }
    }

    参数说明:

    参数是否必须说明
    calendar日历信息
    cal_id日历ID
    readonly日历组织者对日历是否只读权限(即不可编辑日历,不可在日历上添加日程,仅可作为组织者删除日历)。
    0-否;1-是。默认为1,即只读
    summary日历标题。1 ~ 128 字符
    color日历颜色,RGB颜色编码16进制表示,例如:"#0000FF" 表示纯蓝色
    description日历描述。0 ~ 512 字符
    shares日历共享成员列表。最多2000人
    shares.userid日历共享成员的id
    shares.readonly共享成员对日历是否只读权限(即不可编辑日历,不可在日历上添加日程,仅可以退出日历)。
    0-否;1-是。默认为1,即只读

    注意, 不可更新组织者。

    返回结果:

    { 
    	"errcode": 0,
    	"errmsg" : "ok"
    }

    参数说明:

    参数说明
    errcode错误码
    errmsg错误码说明

    获取日历详情

    该接口用于获取应用在企业内创建的日历信息。

    注: 企业微信需要更新到3.0.2及以上版本

    请求方式: POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/oa/calendar/get?access_token=ACCESS_TOKEN

     

    请求包体:

    { 
    	"cal_id_list": ["wcjgewCwAAqeJcPI1d8Pwbjt7nttzAAA"]
    }

    参数说明:

    参数是否必须说明
    cal_id_list日历ID列表,调用创建日历接口后获得。一次最多可获取1000条

     

    返回结果:

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"calendar_list": [{
    		"cal_id": "wcjgewCwAAqeJcPI1d8Pwbjt7nttzAAA",
    		"organizer": "userid1",
    		"readonly": 1,
    		"summary": "test_summary",
    		"color": "#FF3030",
    		"description": "test_describe_1",
    		"shares": [
    			{
    				"userid": "userid2"
    			},
    			{
    				"userid": "userid1",
    				"readonly" : 1
    			}
    		]
    	}]
    }

    参数说明:

    参数说明
    errcode错误码
    errmsg错误码说明
    calendar_list日历列表
    cal_id日历ID
    organizer指定的组织者userid
    readonly日历组织者对日历是否只读权限。0-否;1-是;
    summary日历标题。1 ~ 128 字符
    color日历颜色,RGB颜色编码16进制表示,例如:"#0000FF" 表示纯蓝色
    description日历描述。0 ~ 512 字符
    shares日历共享成员列表。最多2000人
    shares.userid日历共享成员的id
    shares.readonly共享成员对日历是否只读权限。0-否;1-是;

    删除日历

    该接口用于删除指定日历。

    注: 企业微信需要更新到3.0.2及以上版本

    请求方式: POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/oa/calendar/del?access_token=ACCESS_TOKEN

     

    请求包体:

    { 
    	"cal_id":"wcjgewCwAAqeJcPI1d8Pwbjt7nttzAAA"
    }

    参数说明:

    参数是否必须说明
    cal_id日历ID

     

    返回结果:

    { 
    	"errcode": 0,
    	"errmsg" : "ok"
    }

    参数说明:

    参数说明
    errcode错误码
    errmsg错误码说明
    上一篇
    概述
    下一篇
    日程接口