github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/docs/RingOutApi.md (about) 1 # \RingOutApi 2 3 All URIs are relative to *https://platform.devtest.ringcentral.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CancelRingOutCall**](RingOutApi.md#CancelRingOutCall) | **Delete** /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout/{ringoutId} | Cancel RingOut Call 8 [**CancelRingOutCallNew**](RingOutApi.md#CancelRingOutCallNew) | **Delete** /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId} | Cancel RingOut Call 9 [**CreateDirectRingOut**](RingOutApi.md#CreateDirectRingOut) | **Post** /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout/direct | 10 [**CreateDirectRingOutNew**](RingOutApi.md#CreateDirectRingOutNew) | **Post** /restapi/v1.0/account/{accountId}/extension/{extensionId}/direct-ring-out | Make Direct RingOut Call 11 [**GetRingOutCallStatus**](RingOutApi.md#GetRingOutCallStatus) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout/{ringoutId} | Get Status of RingOut Call 12 [**GetRingOutCallStatusNew**](RingOutApi.md#GetRingOutCallStatusNew) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId} | Get Status of RingOut Call 13 [**MakeRingOutCall**](RingOutApi.md#MakeRingOutCall) | **Post** /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout | Make RingOut Call 14 [**MakeRingOutCallNew**](RingOutApi.md#MakeRingOutCallNew) | **Post** /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out | Make RingOut Call 15 16 17 # **CancelRingOutCall** 18 > CancelRingOutCall(ctx, accountId, extensionId, ringoutId) 19 Cancel RingOut Call 20 21 <p style='font-style:italic;'></p><p>Cancels the 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p> 22 23 ### Required Parameters 24 25 Name | Type | Description | Notes 26 ------------- | ------------- | ------------- | ------------- 27 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 28 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 29 **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 ~] 30 **ringoutId** | **int32**| Internal identifier of a RingOut call | 31 32 ### Return type 33 34 (empty response body) 35 36 ### Authorization 37 38 [OAuth2](../README.md#OAuth2) 39 40 ### HTTP request headers 41 42 - **Content-Type**: Not defined 43 - **Accept**: Not defined 44 45 [[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) 46 47 # **CancelRingOutCallNew** 48 > CancelRingOutCallNew(ctx, accountId, extensionId, ringoutId) 49 Cancel RingOut Call 50 51 <p style='font-style:italic;'></p><p>Cancels the 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p> 52 53 ### Required Parameters 54 55 Name | Type | Description | Notes 56 ------------- | ------------- | ------------- | ------------- 57 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 58 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 59 **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 ~] 60 **ringoutId** | **int32**| Internal identifier of a RingOut call | 61 62 ### Return type 63 64 (empty response body) 65 66 ### Authorization 67 68 [OAuth2](../README.md#OAuth2) 69 70 ### HTTP request headers 71 72 - **Content-Type**: Not defined 73 - **Accept**: Not defined 74 75 [[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) 76 77 # **CreateDirectRingOut** 78 > CreateDirectRingOut(ctx, accountId, extensionId, ringOutResource) 79 80 81 ### Required Parameters 82 83 Name | Type | Description | Notes 84 ------------- | ------------- | ------------- | ------------- 85 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 86 **accountId** | **string**| | 87 **extensionId** | **string**| | 88 **ringOutResource** | [**RingOutResource**](RingOutResource.md)| | 89 90 ### Return type 91 92 (empty response body) 93 94 ### Authorization 95 96 [OAuth2](../README.md#OAuth2) 97 98 ### HTTP request headers 99 100 - **Content-Type**: application/json 101 - **Accept**: Not defined 102 103 [[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) 104 105 # **CreateDirectRingOutNew** 106 > CreateDirectRingOutNew(ctx, accountId, extensionId, ringOutResource) 107 Make Direct RingOut Call 108 109 ### Required Parameters 110 111 Name | Type | Description | Notes 112 ------------- | ------------- | ------------- | ------------- 113 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 114 **accountId** | **string**| | 115 **extensionId** | **string**| | 116 **ringOutResource** | [**RingOutResource**](RingOutResource.md)| | 117 118 ### Return type 119 120 (empty response body) 121 122 ### Authorization 123 124 [OAuth2](../README.md#OAuth2) 125 126 ### HTTP request headers 127 128 - **Content-Type**: application/json 129 - **Accept**: Not defined 130 131 [[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) 132 133 # **GetRingOutCallStatus** 134 > GetRingOutStatusResponse GetRingOutCallStatus(ctx, accountId, extensionId, ringoutId) 135 Get Status of RingOut Call 136 137 <p style='font-style:italic;'>Since 1.0.7 (Release 5.16)</p><p>Returns the status of a 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p> 138 139 ### Required Parameters 140 141 Name | Type | Description | Notes 142 ------------- | ------------- | ------------- | ------------- 143 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 144 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 145 **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 ~] 146 **ringoutId** | **int32**| Internal identifier of a RingOut call | 147 148 ### Return type 149 150 [**GetRingOutStatusResponse**](GetRingOutStatusResponse.md) 151 152 ### Authorization 153 154 [OAuth2](../README.md#OAuth2) 155 156 ### HTTP request headers 157 158 - **Content-Type**: Not defined 159 - **Accept**: application/json 160 161 [[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) 162 163 # **GetRingOutCallStatusNew** 164 > GetRingOutStatusResponse GetRingOutCallStatusNew(ctx, accountId, extensionId, ringoutId) 165 Get Status of RingOut Call 166 167 <p style='font-style:italic;'>Since 1.0.7 (Release 5.16)</p><p>Returns the status of a 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p> 168 169 ### Required Parameters 170 171 Name | Type | Description | Notes 172 ------------- | ------------- | ------------- | ------------- 173 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 174 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 175 **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 ~] 176 **ringoutId** | **int32**| Internal identifier of a RingOut call | 177 178 ### Return type 179 180 [**GetRingOutStatusResponse**](GetRingOutStatusResponse.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 # **MakeRingOutCall** 194 > GetRingOutStatusResponseIntId MakeRingOutCall(ctx, accountId, extensionId, makeRingOutRequest) 195 Make RingOut Call 196 197 <p style='font-style:italic;'>Since 1.0.7 (Release 5.16)</p><p>Makes a 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</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 **makeRingOutRequest** | [**MakeRingOutRequest**](MakeRingOutRequest.md)| JSON body | 207 208 ### Return type 209 210 [**GetRingOutStatusResponseIntId**](GetRingOutStatusResponseIntId.md) 211 212 ### Authorization 213 214 [OAuth2](../README.md#OAuth2) 215 216 ### HTTP request headers 217 218 - **Content-Type**: application/json 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 # **MakeRingOutCallNew** 224 > GetRingOutStatusResponse MakeRingOutCallNew(ctx, accountId, extensionId, makeRingOutRequest) 225 Make RingOut Call 226 227 <p style='font-style:italic;'>Since 1.0.7 (Release 5.16)</p><p>Makes a 2-leg RingOut call.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RingOut</td><td>Performing two-legged ring-out phone calls</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 **makeRingOutRequest** | [**MakeRingOutRequest**](MakeRingOutRequest.md)| JSON body | 237 238 ### Return type 239 240 [**GetRingOutStatusResponse**](GetRingOutStatusResponse.md) 241 242 ### Authorization 243 244 [OAuth2](../README.md#OAuth2) 245 246 ### HTTP request headers 247 248 - **Content-Type**: application/json 249 - **Accept**: application/json 250 251 [[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) 252