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

     1  # AccountsQueuesApi
     2  
     3  All URIs are relative to *https://api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateQueue**](AccountsQueuesApi.md#CreateQueue) | **Post** /2010-04-01/Accounts/{AccountSid}/Queues.json | 
     8  [**DeleteQueue**](AccountsQueuesApi.md#DeleteQueue) | **Delete** /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json | 
     9  [**FetchQueue**](AccountsQueuesApi.md#FetchQueue) | **Get** /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json | 
    10  [**ListQueue**](AccountsQueuesApi.md#ListQueue) | **Get** /2010-04-01/Accounts/{AccountSid}/Queues.json | 
    11  [**UpdateQueue**](AccountsQueuesApi.md#UpdateQueue) | **Post** /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json | 
    12  
    13  
    14  
    15  ## CreateQueue
    16  
    17  > ApiV2010Queue CreateQueue(ctx, optional)
    18  
    19  
    20  
    21  Create a queue
    22  
    23  ### Path Parameters
    24  
    25  This endpoint does not need any path parameter.
    26  
    27  ### Other Parameters
    28  
    29  Other parameters are passed through a pointer to a CreateQueueParams struct
    30  
    31  
    32  Name | Type | Description
    33  ------------- | ------------- | -------------
    34  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.
    35  **FriendlyName** | **string** | A descriptive string that you created to describe this resource. It can be up to 64 characters long.
    36  **MaxSize** | **int** | The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000.
    37  
    38  ### Return type
    39  
    40  [**ApiV2010Queue**](ApiV2010Queue.md)
    41  
    42  ### Authorization
    43  
    44  [accountSid_authToken](../README.md#accountSid_authToken)
    45  
    46  ### HTTP request headers
    47  
    48  - **Content-Type**: application/x-www-form-urlencoded
    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  ## DeleteQueue
    57  
    58  > DeleteQueue(ctx, Sidoptional)
    59  
    60  
    61  
    62  Remove an empty queue
    63  
    64  ### Path Parameters
    65  
    66  
    67  Name | Type | Description
    68  ------------- | ------------- | -------------
    69  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    70  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Queue resource to delete
    71  
    72  ### Other Parameters
    73  
    74  Other parameters are passed through a pointer to a DeleteQueueParams struct
    75  
    76  
    77  Name | Type | Description
    78  ------------- | ------------- | -------------
    79  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resource to delete.
    80  
    81  ### Return type
    82  
    83   (empty response body)
    84  
    85  ### Authorization
    86  
    87  [accountSid_authToken](../README.md#accountSid_authToken)
    88  
    89  ### HTTP request headers
    90  
    91  - **Content-Type**: Not defined
    92  - **Accept**: Not defined
    93  
    94  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    95  [[Back to Model list]](../README.md#documentation-for-models)
    96  [[Back to README]](../README.md)
    97  
    98  
    99  ## FetchQueue
   100  
   101  > ApiV2010Queue FetchQueue(ctx, Sidoptional)
   102  
   103  
   104  
   105  Fetch an instance of a queue identified by the QueueSid
   106  
   107  ### Path Parameters
   108  
   109  
   110  Name | Type | Description
   111  ------------- | ------------- | -------------
   112  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   113  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Queue resource to fetch
   114  
   115  ### Other Parameters
   116  
   117  Other parameters are passed through a pointer to a FetchQueueParams struct
   118  
   119  
   120  Name | Type | Description
   121  ------------- | ------------- | -------------
   122  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resource to fetch.
   123  
   124  ### Return type
   125  
   126  [**ApiV2010Queue**](ApiV2010Queue.md)
   127  
   128  ### Authorization
   129  
   130  [accountSid_authToken](../README.md#accountSid_authToken)
   131  
   132  ### HTTP request headers
   133  
   134  - **Content-Type**: Not defined
   135  - **Accept**: application/json
   136  
   137  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   138  [[Back to Model list]](../README.md#documentation-for-models)
   139  [[Back to README]](../README.md)
   140  
   141  
   142  ## ListQueue
   143  
   144  > []ApiV2010Queue ListQueue(ctx, optional)
   145  
   146  
   147  
   148  Retrieve a list of queues belonging to the account used to make the request
   149  
   150  ### Path Parameters
   151  
   152  This endpoint does not need any path parameter.
   153  
   154  ### Other Parameters
   155  
   156  Other parameters are passed through a pointer to a ListQueueParams struct
   157  
   158  
   159  Name | Type | Description
   160  ------------- | ------------- | -------------
   161  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resources to read.
   162  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   163  **Limit** | **int** | Max number of records to return.
   164  
   165  ### Return type
   166  
   167  [**[]ApiV2010Queue**](ApiV2010Queue.md)
   168  
   169  ### Authorization
   170  
   171  [accountSid_authToken](../README.md#accountSid_authToken)
   172  
   173  ### HTTP request headers
   174  
   175  - **Content-Type**: Not defined
   176  - **Accept**: application/json
   177  
   178  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   179  [[Back to Model list]](../README.md#documentation-for-models)
   180  [[Back to README]](../README.md)
   181  
   182  
   183  ## UpdateQueue
   184  
   185  > ApiV2010Queue UpdateQueue(ctx, Sidoptional)
   186  
   187  
   188  
   189  Update the queue with the new parameters
   190  
   191  ### Path Parameters
   192  
   193  
   194  Name | Type | Description
   195  ------------- | ------------- | -------------
   196  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   197  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Queue resource to update
   198  
   199  ### Other Parameters
   200  
   201  Other parameters are passed through a pointer to a UpdateQueueParams struct
   202  
   203  
   204  Name | Type | Description
   205  ------------- | ------------- | -------------
   206  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resource to update.
   207  **FriendlyName** | **string** | A descriptive string that you created to describe this resource. It can be up to 64 characters long.
   208  **MaxSize** | **int** | The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000.
   209  
   210  ### Return type
   211  
   212  [**ApiV2010Queue**](ApiV2010Queue.md)
   213  
   214  ### Authorization
   215  
   216  [accountSid_authToken](../README.md#accountSid_authToken)
   217  
   218  ### HTTP request headers
   219  
   220  - **Content-Type**: application/x-www-form-urlencoded
   221  - **Accept**: application/json
   222  
   223  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   224  [[Back to Model list]](../README.md#documentation-for-models)
   225  [[Back to README]](../README.md)
   226