github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/docs/UserContactsApi.md (about) 1 # \UserContactsApi 2 3 All URIs are relative to *https://platform.devtest.ringcentral.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**ContactFavorite**](UserContactsApi.md#ContactFavorite) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite | Get Favorite Contacts 8 [**CreateContact**](UserContactsApi.md#CreateContact) | **Post** /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact | Create Contact 9 [**CreateContacts**](UserContactsApi.md#CreateContacts) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite | Update Favorite Contacts 10 [**DeleteContact**](UserContactsApi.md#DeleteContact) | **Delete** /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId} | Delete Contact(s) by ID 11 [**ListContacts**](UserContactsApi.md#ListContacts) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact | Get Contacts 12 [**LoadContact**](UserContactsApi.md#LoadContact) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId} | Get Contact(s) by ID 13 [**SyncAddressBook**](UserContactsApi.md#SyncAddressBook) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book-sync | Address Book Synchronization 14 [**UpdateContact**](UserContactsApi.md#UpdateContact) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId} | Update Contact(s) by ID 15 16 17 # **ContactFavorite** 18 > ContactFavorite(ctx, accountId, extensionId) 19 Get Favorite Contacts 20 21 ### Required Parameters 22 23 Name | Type | Description | Notes 24 ------------- | ------------- | ------------- | ------------- 25 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 26 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 27 **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~] 28 29 ### Return type 30 31 (empty response body) 32 33 ### Authorization 34 35 [OAuth2](../README.md#OAuth2) 36 37 ### HTTP request headers 38 39 - **Content-Type**: Not defined 40 - **Accept**: Not defined 41 42 [[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) 43 44 # **CreateContact** 45 > PersonalContactResource CreateContact(ctx, accountId, extensionId, optional) 46 Create Contact 47 48 <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Contacts</td><td>Creating, viewing, editing and deleting user personal contacts</td></tr><tr><td class='code'>ReadContacts</td><td>Viewing user personal contacts</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p> 49 50 ### Required Parameters 51 52 Name | Type | Description | Notes 53 ------------- | ------------- | ------------- | ------------- 54 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 55 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 56 **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~] 57 **optional** | ***CreateContactOpts** | optional parameters | nil if no parameters 58 59 ### Optional Parameters 60 Optional parameters are passed through a pointer to a CreateContactOpts struct 61 62 Name | Type | Description | Notes 63 ------------- | ------------- | ------------- | ------------- 64 65 66 **personalContactResource** | [**optional.Interface of PersonalContactResource**](PersonalContactResource.md)| | 67 68 ### Return type 69 70 [**PersonalContactResource**](PersonalContactResource.md) 71 72 ### Authorization 73 74 [OAuth2](../README.md#OAuth2) 75 76 ### HTTP request headers 77 78 - **Content-Type**: application/json 79 - **Accept**: application/json 80 81 [[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) 82 83 # **CreateContacts** 84 > CreateContacts(ctx, accountId, extensionId, optional) 85 Update Favorite Contacts 86 87 ### Required Parameters 88 89 Name | Type | Description | Notes 90 ------------- | ------------- | ------------- | ------------- 91 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 92 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 93 **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~] 94 **optional** | ***CreateContactsOpts** | optional parameters | nil if no parameters 95 96 ### Optional Parameters 97 Optional parameters are passed through a pointer to a CreateContactsOpts struct 98 99 Name | Type | Description | Notes 100 ------------- | ------------- | ------------- | ------------- 101 102 103 **favoriteCollection** | [**optional.Interface of FavoriteCollection**](FavoriteCollection.md)| | 104 105 ### Return type 106 107 (empty response body) 108 109 ### Authorization 110 111 [OAuth2](../README.md#OAuth2) 112 113 ### HTTP request headers 114 115 - **Content-Type**: application/json 116 - **Accept**: Not defined 117 118 [[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) 119 120 # **DeleteContact** 121 > DeleteContact(ctx, accountId, extensionId, contactId) 122 Delete Contact(s) by ID 123 124 <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Contacts</td><td>Creating, viewing, editing and deleting user personal contacts</td></tr><tr><td class='code'>ReadContacts</td><td>Viewing user personal contacts</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p> 125 126 ### Required Parameters 127 128 Name | Type | Description | Notes 129 ------------- | ------------- | ------------- | ------------- 130 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 131 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 132 **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~] 133 **contactId** | **int32**| Internal identifier of a contact record in the RingCentral database | 134 135 ### Return type 136 137 (empty response body) 138 139 ### Authorization 140 141 [OAuth2](../README.md#OAuth2) 142 143 ### HTTP request headers 144 145 - **Content-Type**: Not defined 146 - **Accept**: Not defined 147 148 [[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) 149 150 # **ListContacts** 151 > ContactList ListContacts(ctx, accountId, extensionId, optional) 152 Get Contacts 153 154 <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadContacts</td><td>Viewing user personal contacts</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p> 155 156 ### Required Parameters 157 158 Name | Type | Description | Notes 159 ------------- | ------------- | ------------- | ------------- 160 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 161 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 162 **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~] 163 **optional** | ***ListContactsOpts** | optional parameters | nil if no parameters 164 165 ### Optional Parameters 166 Optional parameters are passed through a pointer to a ListContactsOpts struct 167 168 Name | Type | Description | Notes 169 ------------- | ------------- | ------------- | ------------- 170 171 172 **startsWith** | **optional.String**| If specified, only contacts whose First name or Last name start with the mentioned substring are returned. Case-insensitive | 173 **sortBy** | [**optional.Interface of []string**](string.md)| Sorts results by the specified property. The default is 'First Name' | 174 **page** | **optional.Int32**| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | 175 **perPage** | **optional.Int32**| Indicates the page size (number of items). If not specified, the value is '100' by default | 176 **phoneNumber** | [**optional.Interface of []string**](string.md)| | 177 178 ### Return type 179 180 [**ContactList**](ContactList.md) 181 182 ### Authorization 183 184 [OAuth2](../README.md#OAuth2) 185 186 ### HTTP request headers 187 188 - **Content-Type**: Not defined 189 - **Accept**: application/json 190 191 [[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) 192 193 # **LoadContact** 194 > PersonalContactResource LoadContact(ctx, accountId, extensionId, contactId) 195 Get Contact(s) by ID 196 197 <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadContacts</td><td>Viewing user personal contacts</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p> 198 199 ### Required Parameters 200 201 Name | Type | Description | Notes 202 ------------- | ------------- | ------------- | ------------- 203 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 204 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 205 **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~] 206 **contactId** | **int32**| Internal identifier of a contact record in the RingCentral database | 207 208 ### Return type 209 210 [**PersonalContactResource**](PersonalContactResource.md) 211 212 ### Authorization 213 214 [OAuth2](../README.md#OAuth2) 215 216 ### HTTP request headers 217 218 - **Content-Type**: Not defined 219 - **Accept**: application/json 220 221 [[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) 222 223 # **SyncAddressBook** 224 > AddressBookSync SyncAddressBook(ctx, accountId, extensionId, optional) 225 Address Book Synchronization 226 227 <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadContacts</td><td>Viewing user personal contacts</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p> 228 229 ### Required Parameters 230 231 Name | Type | Description | Notes 232 ------------- | ------------- | ------------- | ------------- 233 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 234 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 235 **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~] 236 **optional** | ***SyncAddressBookOpts** | optional parameters | nil if no parameters 237 238 ### Optional Parameters 239 Optional parameters are passed through a pointer to a SyncAddressBookOpts struct 240 241 Name | Type | Description | Notes 242 ------------- | ------------- | ------------- | ------------- 243 244 245 **syncType** | [**optional.Interface of []string**](string.md)| Type of synchronization. The default value is 'FSync' | 246 **syncToken** | **optional.String**| Value of syncToken property of the last sync request response | 247 **perPage** | **optional.Int32**| Number of records per page to be returned. The max number of records is 250, which is also the default. For FSync ??? if the number of records exceeds the parameter value (either specified or default), all of the pages can be retrieved in several requests. For ISync ??? if the number of records exceeds the page size, the number of incoming changes to this number is limited | 248 **pageId** | **optional.Int32**| Internal identifier of a page. It can be obtained from the 'nextPageId' parameter passed in response body | 249 250 ### Return type 251 252 [**AddressBookSync**](AddressBookSync.md) 253 254 ### Authorization 255 256 [OAuth2](../README.md#OAuth2) 257 258 ### HTTP request headers 259 260 - **Content-Type**: Not defined 261 - **Accept**: application/json 262 263 [[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) 264 265 # **UpdateContact** 266 > PersonalContactResource UpdateContact(ctx, accountId, extensionId, contactId, optional) 267 Update Contact(s) by ID 268 269 <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Contacts</td><td>Creating, viewing, editing and deleting user personal contacts</td></tr><tr><td class='code'>ReadContacts</td><td>Viewing user personal contacts</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p> 270 271 ### Required Parameters 272 273 Name | Type | Description | Notes 274 ------------- | ------------- | ------------- | ------------- 275 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 276 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 277 **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~] 278 **contactId** | **int32**| Internal identifier of a contact record in the RingCentral database | 279 **optional** | ***UpdateContactOpts** | optional parameters | nil if no parameters 280 281 ### Optional Parameters 282 Optional parameters are passed through a pointer to a UpdateContactOpts struct 283 284 Name | Type | Description | Notes 285 ------------- | ------------- | ------------- | ------------- 286 287 288 289 **personalContactResource** | [**optional.Interface of PersonalContactResource**](PersonalContactResource.md)| | 290 291 ### Return type 292 293 [**PersonalContactResource**](PersonalContactResource.md) 294 295 ### Authorization 296 297 [OAuth2](../README.md#OAuth2) 298 299 ### HTTP request headers 300 301 - **Content-Type**: application/json 302 - **Accept**: application/json 303 304 [[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) 305