github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/docs/GlipApi.md (about) 1 # \GlipApi 2 3 All URIs are relative to *https://platform.devtest.ringcentral.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateGlipFile**](GlipApi.md#CreateGlipFile) | **Post** /restapi/v1.0/glip/files | Upload File 8 [**CreateGroup**](GlipApi.md#CreateGroup) | **Post** /restapi/v1.0/glip/groups | Create Group 9 [**CreatePost**](GlipApi.md#CreatePost) | **Post** /restapi/v1.0/glip/groups/{groupId}/posts | Create Post 10 [**LoadCompany**](GlipApi.md#LoadCompany) | **Get** /restapi/v1.0/glip/companies/{companyId} | Get Company Info 11 [**LoadGlipFile**](GlipApi.md#LoadGlipFile) | **Get** /restapi/v1.0/glip/files/{fileId} | Get File Info 12 [**LoadGroup**](GlipApi.md#LoadGroup) | **Get** /restapi/v1.0/glip/groups/{groupId} | Get Group 13 [**LoadGroupList**](GlipApi.md#LoadGroupList) | **Get** /restapi/v1.0/glip/groups | Get User Groups 14 [**LoadPerson**](GlipApi.md#LoadPerson) | **Get** /restapi/v1.0/glip/persons/{personId} | Get Person 15 [**LoadPosts**](GlipApi.md#LoadPosts) | **Get** /restapi/v1.0/glip/groups/{groupId}/posts | Get Posts 16 [**LoadUnreadMessageCount**](GlipApi.md#LoadUnreadMessageCount) | **Get** /restapi/v1.0/glip/profile | Glip Unread Message Count 17 [**UpdateGroup**](GlipApi.md#UpdateGroup) | **Post** /restapi/v1.0/glip/groups/{groupId}/bulk-assign | Edit Group Members 18 19 20 # **CreateGlipFile** 21 > PostGlipFile CreateGlipFile(ctx, body, optional) 22 Upload File 23 24 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Posts a file.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Heavy</p> 25 26 ### Required Parameters 27 28 Name | Type | Description | Notes 29 ------------- | ------------- | ------------- | ------------- 30 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 31 **body** | ***os.File*****os.File**| The file to upload | 32 **optional** | ***CreateGlipFileOpts** | optional parameters | nil if no parameters 33 34 ### Optional Parameters 35 Optional parameters are passed through a pointer to a CreateGlipFileOpts struct 36 37 Name | Type | Description | Notes 38 ------------- | ------------- | ------------- | ------------- 39 40 **groupId** | **optional.String**| Internal identifier of a group the post with file attached will be added to | 41 **name** | **optional.String**| Name of a file attached | 42 43 ### Return type 44 45 [**PostGlipFile**](PostGlipFile.md) 46 47 ### Authorization 48 49 [OAuth2](../README.md#OAuth2) 50 51 ### HTTP request headers 52 53 - **Content-Type**: multipart/form-data 54 - **Accept**: application/json 55 56 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 57 58 # **CreateGroup** 59 > GlipGroupInfo CreateGroup(ctx, glipCreateGroup) 60 Create Group 61 62 <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Creates a group.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 63 64 ### Required Parameters 65 66 Name | Type | Description | Notes 67 ------------- | ------------- | ------------- | ------------- 68 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 69 **glipCreateGroup** | [**GlipCreateGroup**](GlipCreateGroup.md)| JSON body | 70 71 ### Return type 72 73 [**GlipGroupInfo**](GlipGroupInfo.md) 74 75 ### Authorization 76 77 [OAuth2](../README.md#OAuth2) 78 79 ### HTTP request headers 80 81 - **Content-Type**: application/json 82 - **Accept**: application/json 83 84 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 85 86 # **CreatePost** 87 > GlipPostInfo CreatePost(ctx, groupId, glipCreatePost) 88 Create Post 89 90 <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Creates a post.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Light</p> 91 92 ### Required Parameters 93 94 Name | Type | Description | Notes 95 ------------- | ------------- | ------------- | ------------- 96 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 97 **groupId** | **string**| Id of a group to send post | 98 **glipCreatePost** | [**GlipCreatePost**](GlipCreatePost.md)| JSON body | 99 100 ### Return type 101 102 [**GlipPostInfo**](GlipPostInfo.md) 103 104 ### Authorization 105 106 [OAuth2](../README.md#OAuth2) 107 108 ### HTTP request headers 109 110 - **Content-Type**: application/json 111 - **Accept**: application/json 112 113 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 114 115 # **LoadCompany** 116 > GlipCompany LoadCompany(ctx, companyId) 117 Get Company Info 118 119 <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns a company by ID.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Light</p> 120 121 ### Required Parameters 122 123 Name | Type | Description | Notes 124 ------------- | ------------- | ------------- | ------------- 125 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 126 **companyId** | **string**| Internal identifier of an RC account/Glip company, or tilde (~) to indicate a company the current user belongs to | 127 128 ### Return type 129 130 [**GlipCompany**](GlipCompany.md) 131 132 ### Authorization 133 134 [OAuth2](../README.md#OAuth2) 135 136 ### HTTP request headers 137 138 - **Content-Type**: Not defined 139 - **Accept**: application/json 140 141 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 142 143 # **LoadGlipFile** 144 > PostGlipFile LoadGlipFile(ctx, fileId) 145 Get File Info 146 147 <p style='font-style:italic;'>Since 1.0.31 (Release 9.2)</p><p>Returns a file.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 148 149 ### Required Parameters 150 151 Name | Type | Description | Notes 152 ------------- | ------------- | ------------- | ------------- 153 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 154 **fileId** | **string**| Internal identifier of file. | 155 156 ### Return type 157 158 [**PostGlipFile**](PostGlipFile.md) 159 160 ### Authorization 161 162 [OAuth2](../README.md#OAuth2) 163 164 ### HTTP request headers 165 166 - **Content-Type**: Not defined 167 - **Accept**: application/json 168 169 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 170 171 # **LoadGroup** 172 > GlipGroupInfo LoadGroup(ctx, groupId) 173 Get Group 174 175 <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns a group or few groups by ID(s). Batch request is supported.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Light</p> 176 177 ### Required Parameters 178 179 Name | Type | Description | Notes 180 ------------- | ------------- | ------------- | ------------- 181 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 182 **groupId** | **string**| Internal identifier of a group to be returned, the maximum number of IDs is 30 | 183 184 ### Return type 185 186 [**GlipGroupInfo**](GlipGroupInfo.md) 187 188 ### Authorization 189 190 [OAuth2](../README.md#OAuth2) 191 192 ### HTTP request headers 193 194 - **Content-Type**: Not defined 195 - **Accept**: application/json 196 197 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 198 199 # **LoadGroupList** 200 > GlipGroupList LoadGroupList(ctx, optional) 201 Get User Groups 202 203 <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns the list of groups associated with the user.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 204 205 ### Required Parameters 206 207 Name | Type | Description | Notes 208 ------------- | ------------- | ------------- | ------------- 209 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 210 **optional** | ***LoadGroupListOpts** | optional parameters | nil if no parameters 211 212 ### Optional Parameters 213 Optional parameters are passed through a pointer to a LoadGroupListOpts struct 214 215 Name | Type | Description | Notes 216 ------------- | ------------- | ------------- | ------------- 217 **type_** | [**optional.Interface of []string**](string.md)| Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future | 218 **pageToken** | **optional.String**| Token of a page to be returned, see Glip Navigation Info | 219 **recordCount** | **optional.Int64**| Max numbers of records to be returned. The default/maximum value is 250 | 220 221 ### Return type 222 223 [**GlipGroupList**](GlipGroupList.md) 224 225 ### Authorization 226 227 [OAuth2](../README.md#OAuth2) 228 229 ### HTTP request headers 230 231 - **Content-Type**: Not defined 232 - **Accept**: application/json 233 234 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 235 236 # **LoadPerson** 237 > GlipPersonInfo LoadPerson(ctx, personId) 238 Get Person 239 240 <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns a user or few users by ID(s). Batch request is supported.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Light</p> 241 242 ### Required Parameters 243 244 Name | Type | Description | Notes 245 ------------- | ------------- | ------------- | ------------- 246 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 247 **personId** | **string**| Internal identifier of a user to be returned, the maximum number of IDs is 30 | 248 249 ### Return type 250 251 [**GlipPersonInfo**](GlipPersonInfo.md) 252 253 ### Authorization 254 255 [OAuth2](../README.md#OAuth2) 256 257 ### HTTP request headers 258 259 - **Content-Type**: Not defined 260 - **Accept**: application/json 261 262 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 263 264 # **LoadPosts** 265 > GlipPosts LoadPosts(ctx, groupId, optional) 266 Get Posts 267 268 <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns list of posts.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Light</p> 269 270 ### Required Parameters 271 272 Name | Type | Description | Notes 273 ------------- | ------------- | ------------- | ------------- 274 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 275 **groupId** | **string**| Identifier of a group to filter posts | 276 **optional** | ***LoadPostsOpts** | optional parameters | nil if no parameters 277 278 ### Optional Parameters 279 Optional parameters are passed through a pointer to a LoadPostsOpts struct 280 281 Name | Type | Description | Notes 282 ------------- | ------------- | ------------- | ------------- 283 284 **pageToken** | **optional.String**| Token of a page to be returned, see Glip Navigation Info | 285 **recordCount** | **optional.Int64**| Max numbers of records to be returned. The default/maximum value is 250 | 286 287 ### Return type 288 289 [**GlipPosts**](GlipPosts.md) 290 291 ### Authorization 292 293 [OAuth2](../README.md#OAuth2) 294 295 ### HTTP request headers 296 297 - **Content-Type**: Not defined 298 - **Accept**: application/json 299 300 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 301 302 # **LoadUnreadMessageCount** 303 > GlipUnreadMessageCount LoadUnreadMessageCount(ctx, optional) 304 Glip Unread Message Count 305 306 <p style='font-style:italic;'>Since 1.0.30 (Release 9.1)</p><p>Returns Glip unread message count.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Light</p> 307 308 ### Required Parameters 309 310 Name | Type | Description | Notes 311 ------------- | ------------- | ------------- | ------------- 312 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 313 **optional** | ***LoadUnreadMessageCountOpts** | optional parameters | nil if no parameters 314 315 ### Optional Parameters 316 Optional parameters are passed through a pointer to a LoadUnreadMessageCountOpts struct 317 318 Name | Type | Description | Notes 319 ------------- | ------------- | ------------- | ------------- 320 **fields** | **optional.String**| List of attributes to be returned. To return unread message count 'unreadPostsCount' and 'tooManyUnreadPosts' should be specified | 321 322 ### Return type 323 324 [**GlipUnreadMessageCount**](GlipUnreadMessageCount.md) 325 326 ### Authorization 327 328 [OAuth2](../README.md#OAuth2) 329 330 ### HTTP request headers 331 332 - **Content-Type**: Not defined 333 - **Accept**: application/json 334 335 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 336 337 # **UpdateGroup** 338 > GlipGroupInfo UpdateGroup(ctx, groupId, editGroupRequest) 339 Edit Group Members 340 341 <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Updates group members. Please note: Only groups of 'Team' type can be updated. Currently only one operation at a time (either adding or removal) is supported.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Glip</td><td>Availability of Glip</td></tr></tbody></table><h4>API Group</h4><p>Medium</p> 342 343 ### Required Parameters 344 345 Name | Type | Description | Notes 346 ------------- | ------------- | ------------- | ------------- 347 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 348 **groupId** | **string**| Internal identifier of a group to be edited | 349 **editGroupRequest** | [**EditGroupRequest**](EditGroupRequest.md)| JSON body | 350 351 ### Return type 352 353 [**GlipGroupInfo**](GlipGroupInfo.md) 354 355 ### Authorization 356 357 [OAuth2](../README.md#OAuth2) 358 359 ### HTTP request headers 360 361 - **Content-Type**: application/json 362 - **Accept**: application/json 363 364 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 365