github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/docs/MeetingsApi.md (about)

     1  # \MeetingsApi
     2  
     3  All URIs are relative to *https://platform.devtest.ringcentral.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateMeeting**](MeetingsApi.md#CreateMeeting) | **Post** /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting | Create Meetings
     8  [**DeleteMeeting**](MeetingsApi.md#DeleteMeeting) | **Delete** /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId} | Delete Meeting
     9  [**EndMeeting**](MeetingsApi.md#EndMeeting) | **Post** /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}/end | End Meeting
    10  [**GetLiveMeetings**](MeetingsApi.md#GetLiveMeetings) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting | Get Scheduled Meetings
    11  [**GetMeetingDetails**](MeetingsApi.md#GetMeetingDetails) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId} | Get Meeting Info
    12  [**GetMeetingServiceInfo**](MeetingsApi.md#GetMeetingServiceInfo) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/service-info | Get Meeting Service Info
    13  [**UpdateMeeting**](MeetingsApi.md#UpdateMeeting) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId} | Update Meeting
    14  
    15  
    16  # **CreateMeeting**
    17  > MeetingResponseResource CreateMeeting(ctx, accountId, extensionId, meetingRequestResource)
    18  Create Meetings
    19  
    20  ### Required Parameters
    21  
    22  Name | Type | Description  | Notes
    23  ------------- | ------------- | ------------- | -------------
    24   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    25    **accountId** | **string**|  | 
    26    **extensionId** | **string**|  | 
    27    **meetingRequestResource** | [**MeetingRequestResource**](MeetingRequestResource.md)|  | 
    28  
    29  ### Return type
    30  
    31  [**MeetingResponseResource**](MeetingResponseResource.md)
    32  
    33  ### Authorization
    34  
    35  [OAuth2](../README.md#OAuth2)
    36  
    37  ### HTTP request headers
    38  
    39   - **Content-Type**: application/json
    40   - **Accept**: application/json
    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  # **DeleteMeeting**
    45  > DeleteMeeting(ctx, meetingId, extensionId, accountId)
    46  Delete Meeting
    47  
    48  ### Required Parameters
    49  
    50  Name | Type | Description  | Notes
    51  ------------- | ------------- | ------------- | -------------
    52   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    53    **meetingId** | **string**|  | 
    54    **extensionId** | **string**|  | 
    55    **accountId** | **string**|  | 
    56  
    57  ### Return type
    58  
    59   (empty response body)
    60  
    61  ### Authorization
    62  
    63  [OAuth2](../README.md#OAuth2)
    64  
    65  ### HTTP request headers
    66  
    67   - **Content-Type**: Not defined
    68   - **Accept**: Not defined
    69  
    70  [[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)
    71  
    72  # **EndMeeting**
    73  > EndMeeting(ctx, meetingId, extensionId, accountId)
    74  End Meeting
    75  
    76  ### Required Parameters
    77  
    78  Name | Type | Description  | Notes
    79  ------------- | ------------- | ------------- | -------------
    80   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    81    **meetingId** | **string**|  | 
    82    **extensionId** | **string**|  | 
    83    **accountId** | **string**|  | 
    84  
    85  ### Return type
    86  
    87   (empty response body)
    88  
    89  ### Authorization
    90  
    91  [OAuth2](../README.md#OAuth2)
    92  
    93  ### HTTP request headers
    94  
    95   - **Content-Type**: Not defined
    96   - **Accept**: Not defined
    97  
    98  [[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)
    99  
   100  # **GetLiveMeetings**
   101  > MeetingsResource GetLiveMeetings(ctx, accountId, extensionId)
   102  Get Scheduled Meetings
   103  
   104  ### Required Parameters
   105  
   106  Name | Type | Description  | Notes
   107  ------------- | ------------- | ------------- | -------------
   108   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   109    **accountId** | **string**|  | 
   110    **extensionId** | **string**|  | 
   111  
   112  ### Return type
   113  
   114  [**MeetingsResource**](MeetingsResource.md)
   115  
   116  ### Authorization
   117  
   118  [OAuth2](../README.md#OAuth2)
   119  
   120  ### HTTP request headers
   121  
   122   - **Content-Type**: Not defined
   123   - **Accept**: application/json
   124  
   125  [[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)
   126  
   127  # **GetMeetingDetails**
   128  > MeetingResponseResource GetMeetingDetails(ctx, accountId, extensionId, meetingId)
   129  Get Meeting Info
   130  
   131  ### Required Parameters
   132  
   133  Name | Type | Description  | Notes
   134  ------------- | ------------- | ------------- | -------------
   135   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   136    **accountId** | **string**|  | 
   137    **extensionId** | **string**|  | 
   138    **meetingId** | **string**|  | 
   139  
   140  ### Return type
   141  
   142  [**MeetingResponseResource**](MeetingResponseResource.md)
   143  
   144  ### Authorization
   145  
   146  [OAuth2](../README.md#OAuth2)
   147  
   148  ### HTTP request headers
   149  
   150   - **Content-Type**: Not defined
   151   - **Accept**: application/json
   152  
   153  [[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)
   154  
   155  # **GetMeetingServiceInfo**
   156  > MeetingServiceInfoResource GetMeetingServiceInfo(ctx, extensionId, accountId)
   157  Get Meeting Service Info
   158  
   159  ### Required Parameters
   160  
   161  Name | Type | Description  | Notes
   162  ------------- | ------------- | ------------- | -------------
   163   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   164    **extensionId** | **string**|  | 
   165    **accountId** | **string**|  | 
   166  
   167  ### Return type
   168  
   169  [**MeetingServiceInfoResource**](MeetingServiceInfoResource.md)
   170  
   171  ### Authorization
   172  
   173  [OAuth2](../README.md#OAuth2)
   174  
   175  ### HTTP request headers
   176  
   177   - **Content-Type**: Not defined
   178   - **Accept**: application/json
   179  
   180  [[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)
   181  
   182  # **UpdateMeeting**
   183  > MeetingResponseResource UpdateMeeting(ctx, accountId, extensionId, meetingId, meetingRequestResource)
   184  Update Meeting
   185  
   186  ### Required Parameters
   187  
   188  Name | Type | Description  | Notes
   189  ------------- | ------------- | ------------- | -------------
   190   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   191    **accountId** | **string**|  | 
   192    **extensionId** | **string**|  | 
   193    **meetingId** | **string**|  | 
   194    **meetingRequestResource** | [**MeetingRequestResource**](MeetingRequestResource.md)|  | 
   195  
   196  ### Return type
   197  
   198  [**MeetingResponseResource**](MeetingResponseResource.md)
   199  
   200  ### Authorization
   201  
   202  [OAuth2](../README.md#OAuth2)
   203  
   204  ### HTTP request headers
   205  
   206   - **Content-Type**: application/json
   207   - **Accept**: application/json
   208  
   209  [[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)
   210