查询日程列表

接口说明

请求URL：http[s]://{网关地址}/casp-cal/queryCalList

请求方式： POST

请求内容类型： application/json

响应内容类型： application/json

请求说明

请求头

字段名	参数名	必填	类型	描述
应用ID	appId	M	String(128)	接入网关的应用ID
Token	accessToken	M	String	接入网关的accessToken

请求体

字段名	参数名	必填	类型	描述
用户工号	userAccount	M	String(20)
startTime 开始时间 格式yyyy-MM-dd	startTime	M	String(10)
endTime 结束时间 格式yyyy-MM-dd 开始时间 格式yyyy-MM-dd	endTime	M	String(10)
是否在日程中展示校历事件	showSchoolCal	O	Boolean
学期code（如果校历是空，并且在开始和结束时间范围内有多个学期，优先选择创建时间早的校历事件返回）	termCode	O	String

请求示例

{
"userAccount":"ampadmin",
"startTime":"2022-09-01",
"endTime":"2022-09-30"
}

响应说明

响应体

字段名	类型	描述
errcode	String	返回码，0 成功
errmsg	String	返回码描述
data	Map<String,List<CalVo>>	对应日期和日程CalVo列表

CalVo

字段名	类型	描述
calWid	String	日历id 1：个人 2：群组
eventId	String	日程id
userAccount	string	用户工号
eventTitle	string	日程标题
startTime	string	日程开始时间
startDate	string	日程开始日期
endTime	string	日程结束时间
location	string	日程地点
eventDesc	string	日程描述
linkUrl	string	日程链接详情
repeatType	int	日程重复类型 0不重复 1每天 2每周 3每月第N天 4每年 5(按月-周重复) 第n周的n个星期几
endTimeOrigin	string	原始日程结束时间
remindChannel	string	提醒通道 多个用分割~ INBOX 收件箱 CAMPUSHOY 今日校园 EMAIL 邮箱 SMS 短信 QYWECHAT 企业微信 DINGTALK 钉钉 WeChatService 微信服务号 WELINK 华为weilink
remindTime	List<long>	提醒时间，表示日程开始前多久提醒
eventRepeatData	int	重复间隔(重复类型时这个必填)，
startTimeOrigin	string	原始开始时间
isAllDay	int	是否是全天日程 1：是 0：否
dingSeriesMasterId	string	钉钉上住日程的id
dayOfMonth	int	每个月第几天 eventRepeatType 为3时使用
dayOfWeek	int	英文小写单词指定星期几，如果有多个值逗号分割。eventRepeatType 为3时使用,可以传多个；eventRepeatType 为5时使用,只能传1个
weekIndex	string	当重复类型是每周，用于指定每月第几周（first second third fourth last ） eventRepeatType 为5时使用
rangeType	string	循环范围类型： noEnd：永不结束 endDate：循环至指定日期结束 numbered：循环指定次数后结束
rangeNum	int	循环次数(rangTye 是numbered )
originalEventWid	string	父日程的wid
isDingdingCal	int	是否是从钉钉同步过来的日程 1：是 0否
isOrganizer	int	是否是创建人 1：是 0：否
deadline	string	日程截至日期 yyyy-MM-dd
dubboCalGroupReceiver	GroupReceiver	群组接收人
creatorAccount	string	创建人工号--在群组日程有效
userName	string	创建人姓名--在群组日程有效
isInGroup	int	是否在创建者组里面 1：在创建组，表示该用户可以创建群组 0：否 不可以创建组
holidayDateTime	string	yyyy-MM-dd HH:mm:ss 节日时间
dayType	int	日期类型 0：默认类型 1：节假日中的节日 2：节假日的假期（1的优先级高于2）
festivalType	int	节日类型 0 放假 1不放假
workDays	list	补班日期
inviteOthers	String	是否能邀请其他人员加入 0：否 1：是
isParticipant	int	创建人是否参与此日程 0 否 1是
creatorOrg	string	创建者的行政机构（群组日程使用）

GroupReceiver(返回)

字段名	类型	描述
userInfo	List	参与人信息

UserInfo

字段名	类型	描述
userAccount	string	参与人账号
wid	string	wid
userName	string	参与人姓名

响应示例

{
  "errcode": "0",
  "errmsg": "success",
  "data": {
    "2022-09-03": [
      {
        "calWid": "1",
        "eventId": "1015276769579487232_1662134400000",
        "userAccount": "ampadmin",
        "eventTitle": "zjs09-01 每周56重复",
        "startTime": "2022-09-03T00:00:00",
        "startDate": "2022-09-03",
        "endTime": "2022-09-03T00:00:00",
        "location": "12323",
        "eventDesc": "描述",
        "linkUrl": "http://www.baidu.com",
        "eventAlarm": null,
        "repeatEventWid": null,
        "repeatType": 2,
        "endTimeOrigin": "2022-09-03T00:00:00",
        "remindChannel": "INBOX",
        "remindTime": [
          15
        ],
        "eventRepeatData": 1,
        "startTimeOrigin": "2022-09-03T00:00:00",
        "isAllDay": 0,
        "dingSeriesMasterId": null,
        "dayOfMonth": null,
        "dayOfWeek": "friday,saturday",
        "weekIndex": null,
        "rangeType": "noEnd",
        "rangeNum": null,
        "originalEventWid": "1015276769579487232",
        "isDingdingCal": 0,
        "isOrganizer": 1,
        "deadline": null,
        "dubboCalGroupReceiver": null,
        "creatorAccount": null,
        "userName": null,
        "isInGroup": 0
      }
    ],
    "2022-09-26": [
      {
        "calWid": "2",
        "eventId": "1008795029549731840_1664150400000",
        "userAccount": "ampadmin",
        "eventTitle": "群组01每周1",
        "startTime": "2022-09-26T08:00:00",
        "startDate": "2022-09-26",
        "endTime": "2022-09-26T09:00:00",
        "location": "",
        "eventDesc": "",
        "linkUrl": "",
        "eventAlarm": null,
        "repeatEventWid": null,
        "repeatType": 2,
        "endTimeOrigin": "2022-09-26T09:00:00",
        "remindChannel": "INBOX",
        "remindTime": [
          15
        ],
        "eventRepeatData": 1,
        "startTimeOrigin": "2022-09-26T08:00:00",
        "isAllDay": 0,
        "dingSeriesMasterId": null,
        "dayOfMonth": null,
        "dayOfWeek": "monday",
        "weekIndex": null,
        "rangeType": "noEnd",
        "rangeNum": null,
        "originalEventWid": "1008795029549731840",
        "isDingdingCal": 0,
        "isOrganizer": 1,
        "deadline": null,
        "dubboCalGroupReceiver": {
          "orgs": [],
          "userGroups": [],
          "userInfos": []
        },
        "creatorAccount": "ampadmin",
        "userName": "超级管理员",
        "isInGroup": 1
      },
      {
        "calWid": "2",
        "eventId": "1008799159445999616_1664187060000",
        "userAccount": "ampadmin",
        "eventTitle": "群组提醒【6】",
        "startTime": "2022-09-26T18:11:00",
        "startDate": "2022-09-26",
        "endTime": "2022-09-26T18:11:00",
        "location": "",
        "eventDesc": "",
        "linkUrl": "",
        "eventAlarm": null,
        "repeatEventWid": null,
        "repeatType": 2,
        "endTimeOrigin": "2022-09-26T18:11:00",
        "remindChannel": "INBOX",
        "remindTime": [
          0
        ],
        "eventRepeatData": 1,
        "startTimeOrigin": "2022-09-26T18:11:00",
        "isAllDay": 0,
        "dingSeriesMasterId": null,
        "dayOfMonth": null,
        "dayOfWeek": "monday",
        "weekIndex": null,
        "rangeType": "noEnd",
        "rangeNum": null,
        "originalEventWid": "1008799159445999616",
        "isDingdingCal": 0,
        "isOrganizer": 1,
        "deadline": null,
        "dubboCalGroupReceiver": {
          "orgs": [],
          "userGroups": [],
          "userInfos": []
        },
        "creatorAccount": "ampadmin",
        "userName": "超级管理员",
        "isInGroup": 1
      },
      {
        "calWid": "2",
        "eventId": "1008802763351379968_1664187660000",
        "userAccount": "ampadmin",
        "eventTitle": "群组【7】",
        "startTime": "2022-09-26T18:21:00",
        "startDate": "2022-09-26",
        "endTime": "2022-09-26T19:21:00",
        "location": "",
        "eventDesc": "",
        "linkUrl": "",
        "eventAlarm": null,
        "repeatEventWid": null,
        "repeatType": 2,
        "endTimeOrigin": "2022-09-26T19:21:00",
        "remindChannel": "INBOX",
        "remindTime": [
          15
        ],
        "eventRepeatData": 1,
        "startTimeOrigin": "2022-09-26T18:21:00",
        "isAllDay": 0,
        "dingSeriesMasterId": null,
        "dayOfMonth": null,
        "dayOfWeek": "monday",
        "weekIndex": null,
        "rangeType": "noEnd",
        "rangeNum": null,
        "originalEventWid": "1008802763351379968",
        "isDingdingCal": 0,
        "isOrganizer": 1,
        "deadline": null,
        "dubboCalGroupReceiver": {
          "orgs": [],
          "userGroups": [],
          "userInfos": []
        },
        "creatorAccount": "ampadmin",
        "userName": "超级管理员",
        "isInGroup": 1
      }
    ]
  },
  "traceId": "OpenV2Api_1015278311691313152"
}

错误码

错误码	描述
999	统一错误码，详细描述信息参见接口返回

Demo

java

// 创建客户端
Client client = new DefaultClient(BASE_URL, APP_ID,APP_SECRET);
// 创建请求对象
QueryCalListRequest request = new QueryCalListRequest();
request.setUserAccount("ampadmin");
request.setStartTime("2024-07-30");
request.setEndTime("2024-08-01");
QueryCalListResponse response = client.execute(request);
//调用成功，则处理业务逻辑
if (response.isSuccess()) {
//.....
}