创建日程

在日程子频道创建一个日程。

注意

要求操作人具有管理频道的权限，如果是机器人，则需要将机器人设置为管理员。

使用示例

token := token.BotToken("appid", "token")
api := botgo.NewOpenAPI(token).WithTimeout(3 * time.Second)
ctx := context.Background()

schedule, err := api.CreateSchedule(ctx, channelId, &dto.Schedule{
  Name: "日程表",
  StartTimestamp: "开始时间戳",
  EndTimestamp: "结束时间戳",
  RemindType: "1",
})
if err != nil {
  log.Fatalln("调用 CreateSchedule 接口失败, err = ", err)
}

参数说明

字段名	必填	类型	描述
channelId	是	string	子频道 ID
Schedule	是	Schedule	日程对象

Schedule

字段名	必填	类型	描述
ID	否	string	日程 ID
Name	是	string	日程名称
Description	否	string	日程描述
StartTimestamp	是	string	日程开始时间戳(ms) ，日程开始时间必须大于传当前时间
EndTimestamp	是	string	日程结束时间戳(ms) ，日程结束时间必须大于日程开始时间
Creator	否	Member	创建者
JumpChannelID	否	string	日程开始时跳转到的子频道 ID
RemindType	是	string	日程提醒类型，取值参考RemindType

返回说明

返回 Schedule 对象。

Member

字段名	类型	描述
User	User	用户的频道基础信息，只有成员相关接口中会填充此信息
Nick	string	用户在频道内的昵称
JoinedAt	Timestamp	用户加入频道的时间，是个 ISO8601 timestamp 字符串，例："2021-11-23T15:16:48+08:00"

User

字段名	类型	描述
ID	string	用户 ID
Username	string	用户名
Bot	boolean	是否是机器人

RemindType

提醒类型 id	描述
0	不提醒
1	开始时提醒
2	开始前 5 分钟提醒
3	开始前 15 分钟提醒
4	开始前 30 分钟提醒
5	开始前 60 分钟提醒

返回示例

data：

{
  "id": "xxxxxx",
  "name": "xxxxxx",
  "description": "xxxxxx",
  "start_timestamp": "1641913200000",
  "end_timestamp": "1641916800000",
  "creator": {
    "user": {
      "id": "xxxxxx",
      "username": "xxxxxx",
      "bot": false
    },
    "nick": "",
    "joined_at": "2021-11-24T16:51:35+08:00"
  },
  "jump_channel_id": "0",
  "remind_type": "2"
}