-
-
Notifications
You must be signed in to change notification settings - Fork 71
/
Copy pathapi_chat_announcement_get.go
89 lines (79 loc) · 6.6 KB
/
api_chat_announcement_get.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
// Code generated by lark_sdk_gen. DO NOT EDIT.
/**
* Copyright 2022 chyroc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package lark
import (
"context"
)
// GetChatAnnouncement 获取会话中的群公告信息, 公告信息格式与[旧版云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。
//
// 注意事项:
// - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)
// - 机器人或授权用户必须在群里
// - 获取内部群信息时, 操作者须与群组在同一租户下
//
// doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/get
// new doc: https://open.feishu.cn/document/server-docs/group/chat-announcement/get
func (r *ChatService) GetChatAnnouncement(ctx context.Context, request *GetChatAnnouncementReq, options ...MethodOptionFunc) (*GetChatAnnouncementResp, *Response, error) {
if r.cli.mock.mockChatGetChatAnnouncement != nil {
r.cli.Log(ctx, LogLevelDebug, "[lark] Chat#GetChatAnnouncement mock enable")
return r.cli.mock.mockChatGetChatAnnouncement(ctx, request, options...)
}
req := &RawRequestReq{
Scope: "Chat",
API: "GetChatAnnouncement",
Method: "GET",
URL: r.cli.openBaseURL + "/open-apis/im/v1/chats/:chat_id/announcement",
Body: request,
MethodOption: newMethodOption(options),
NeedTenantAccessToken: true,
NeedUserAccessToken: true,
}
resp := new(getChatAnnouncementResp)
response, err := r.cli.RawRequest(ctx, req, resp)
return resp.Data, response, err
}
// MockChatGetChatAnnouncement mock ChatGetChatAnnouncement method
func (r *Mock) MockChatGetChatAnnouncement(f func(ctx context.Context, request *GetChatAnnouncementReq, options ...MethodOptionFunc) (*GetChatAnnouncementResp, *Response, error)) {
r.mockChatGetChatAnnouncement = f
}
// UnMockChatGetChatAnnouncement un-mock ChatGetChatAnnouncement method
func (r *Mock) UnMockChatGetChatAnnouncement() {
r.mockChatGetChatAnnouncement = nil
}
// GetChatAnnouncementReq ...
type GetChatAnnouncementReq struct {
ChatID string `path:"chat_id" json:"-"` // 待获取公告的群 ID, 详情参见[群ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description), 注意: 不支持P2P单聊, 示例值: "oc_5ad11d72b830411d72b836c20"
UserIDType *IDType `query:"user_id_type" json:"-"` // 用户 ID 类型, 示例值: open_id, 可选值有: open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多: 如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid), union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的, 在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID, 应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多: 如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id), user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内, 一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多: 如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id), 默认值: `open_id`, 当值为 `user_id`, 字段权限要求: 获取用户 user ID
}
// GetChatAnnouncementResp ...
type GetChatAnnouncementResp struct {
Content string `json:"content,omitempty"` // 云文档序列化信息
Revision string `json:"revision,omitempty"` // 文档当前版本号 纯数字
CreateTime string `json:"create_time,omitempty"` // 文档生成的时间戳（秒）
UpdateTime string `json:"update_time,omitempty"` // 文档更新的时间戳（秒）
OwnerIDType IDType `json:"owner_id_type,omitempty"` // 文档所有者的 ID 类型, 如果所有者是用户, 则与查询参数中的user_id_type 相同；取值为`open_id` `user_id` `union_id` 其中之一, 不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction), 如果所有者是机器人, 为机器人应用的 `app_id`, 详情参见 [获取应用身份访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/g), 可选值有: user_id: 以 user_id 来识别用户, union_id: 以 union_id 来识别用户, open_id: 以 open_id 来识别用户, app_id: 以 app_id 来识别机器人应用
OwnerID string `json:"owner_id,omitempty"` // 文档所有者 ID, ID 值与owner_id_type 中的ID类型对应
ModifierIDType IDType `json:"modifier_id_type,omitempty"` // 文档最新修改者 id 类型, 如果修改者是用户, 则与查询参数中的user_id_type 相同；取值为`open_id` `user_id` `union_id` 其中之一, 不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction), 如果修改者是机器人, 为机器人应用的 `app_id`, 详情参见 [获取应用身份访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/g), 可选值有: user_id: 以 user_id 来识别用户, union_id: 以 union_id 来识别用户, open_id: 以 open_id 来识别用户, app_id: 以 app_id 来识别应用
ModifierID string `json:"modifier_id,omitempty"` // 文档最新修改者 ID, ID 值与modifier_id_type 中的ID类型对应
}
// getChatAnnouncementResp ...
type getChatAnnouncementResp struct {
Code int64 `json:"code,omitempty"` // 错误码, 非 0 表示失败
Msg string `json:"msg,omitempty"` // 错误描述
Data *GetChatAnnouncementResp `json:"data,omitempty"`
Error *ErrorDetail `json:"error,omitempty"`
}