github.com/twilio/twilio-go@v1.20.1/rest/api/v2010/docs/AccountsConferencesApi.md (about)

     1  # AccountsConferencesApi
     2  
     3  All URIs are relative to *https://api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchConference**](AccountsConferencesApi.md#FetchConference) | **Get** /2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json | 
     8  [**ListConference**](AccountsConferencesApi.md#ListConference) | **Get** /2010-04-01/Accounts/{AccountSid}/Conferences.json | 
     9  [**UpdateConference**](AccountsConferencesApi.md#UpdateConference) | **Post** /2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json | 
    10  
    11  
    12  
    13  ## FetchConference
    14  
    15  > ApiV2010Conference FetchConference(ctx, Sidoptional)
    16  
    17  
    18  
    19  Fetch an instance of a conference
    20  
    21  ### Path Parameters
    22  
    23  
    24  Name | Type | Description
    25  ------------- | ------------- | -------------
    26  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    27  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Conference resource to fetch
    28  
    29  ### Other Parameters
    30  
    31  Other parameters are passed through a pointer to a FetchConferenceParams struct
    32  
    33  
    34  Name | Type | Description
    35  ------------- | ------------- | -------------
    36  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference resource(s) to fetch.
    37  
    38  ### Return type
    39  
    40  [**ApiV2010Conference**](ApiV2010Conference.md)
    41  
    42  ### Authorization
    43  
    44  [accountSid_authToken](../README.md#accountSid_authToken)
    45  
    46  ### HTTP request headers
    47  
    48  - **Content-Type**: Not defined
    49  - **Accept**: application/json
    50  
    51  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    52  [[Back to Model list]](../README.md#documentation-for-models)
    53  [[Back to README]](../README.md)
    54  
    55  
    56  ## ListConference
    57  
    58  > []ApiV2010Conference ListConference(ctx, optional)
    59  
    60  
    61  
    62  Retrieve a list of conferences belonging to the account used to make the request
    63  
    64  ### Path Parameters
    65  
    66  This endpoint does not need any path parameter.
    67  
    68  ### Other Parameters
    69  
    70  Other parameters are passed through a pointer to a ListConferenceParams struct
    71  
    72  
    73  Name | Type | Description
    74  ------------- | ------------- | -------------
    75  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference resource(s) to read.
    76  **DateCreated** | **string** | Only include conferences that were created on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read conferences that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read conferences that were created on or after midnight of this date.
    77  **DateCreatedBefore** | **string** | Only include conferences that were created on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read conferences that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read conferences that were created on or after midnight of this date.
    78  **DateCreatedAfter** | **string** | Only include conferences that were created on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read conferences that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read conferences that were created on or after midnight of this date.
    79  **DateUpdated** | **string** | Only include conferences that were last updated on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were last updated on this date. You can also specify an inequality, such as `DateUpdated<=YYYY-MM-DD`, to read conferences that were last updated on or before midnight of this date, and `DateUpdated>=YYYY-MM-DD` to read conferences that were last updated on or after midnight of this date.
    80  **DateUpdatedBefore** | **string** | Only include conferences that were last updated on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were last updated on this date. You can also specify an inequality, such as `DateUpdated<=YYYY-MM-DD`, to read conferences that were last updated on or before midnight of this date, and `DateUpdated>=YYYY-MM-DD` to read conferences that were last updated on or after midnight of this date.
    81  **DateUpdatedAfter** | **string** | Only include conferences that were last updated on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were last updated on this date. You can also specify an inequality, such as `DateUpdated<=YYYY-MM-DD`, to read conferences that were last updated on or before midnight of this date, and `DateUpdated>=YYYY-MM-DD` to read conferences that were last updated on or after midnight of this date.
    82  **FriendlyName** | **string** | The string that identifies the Conference resources to read.
    83  **Status** | **string** | The status of the resources to read. Can be: `init`, `in-progress`, or `completed`.
    84  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    85  **Limit** | **int** | Max number of records to return.
    86  
    87  ### Return type
    88  
    89  [**[]ApiV2010Conference**](ApiV2010Conference.md)
    90  
    91  ### Authorization
    92  
    93  [accountSid_authToken](../README.md#accountSid_authToken)
    94  
    95  ### HTTP request headers
    96  
    97  - **Content-Type**: Not defined
    98  - **Accept**: application/json
    99  
   100  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   101  [[Back to Model list]](../README.md#documentation-for-models)
   102  [[Back to README]](../README.md)
   103  
   104  
   105  ## UpdateConference
   106  
   107  > ApiV2010Conference UpdateConference(ctx, Sidoptional)
   108  
   109  
   110  
   111  
   112  
   113  ### Path Parameters
   114  
   115  
   116  Name | Type | Description
   117  ------------- | ------------- | -------------
   118  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   119  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Conference resource to update
   120  
   121  ### Other Parameters
   122  
   123  Other parameters are passed through a pointer to a UpdateConferenceParams struct
   124  
   125  
   126  Name | Type | Description
   127  ------------- | ------------- | -------------
   128  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference resource(s) to update.
   129  **Status** | **string** | 
   130  **AnnounceUrl** | **string** | The URL we should call to announce something into the conference. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs.
   131  **AnnounceMethod** | **string** | The HTTP method used to call `announce_url`. Can be: `GET` or `POST` and the default is `POST`
   132  
   133  ### Return type
   134  
   135  [**ApiV2010Conference**](ApiV2010Conference.md)
   136  
   137  ### Authorization
   138  
   139  [accountSid_authToken](../README.md#accountSid_authToken)
   140  
   141  ### HTTP request headers
   142  
   143  - **Content-Type**: application/x-www-form-urlencoded
   144  - **Accept**: application/json
   145  
   146  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   147  [[Back to Model list]](../README.md#documentation-for-models)
   148  [[Back to README]](../README.md)
   149