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

     1  # AccountsApplicationsApi
     2  
     3  All URIs are relative to *https://api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateApplication**](AccountsApplicationsApi.md#CreateApplication) | **Post** /2010-04-01/Accounts/{AccountSid}/Applications.json | 
     8  [**DeleteApplication**](AccountsApplicationsApi.md#DeleteApplication) | **Delete** /2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json | 
     9  [**FetchApplication**](AccountsApplicationsApi.md#FetchApplication) | **Get** /2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json | 
    10  [**ListApplication**](AccountsApplicationsApi.md#ListApplication) | **Get** /2010-04-01/Accounts/{AccountSid}/Applications.json | 
    11  [**UpdateApplication**](AccountsApplicationsApi.md#UpdateApplication) | **Post** /2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json | 
    12  
    13  
    14  
    15  ## CreateApplication
    16  
    17  > ApiV2010Application CreateApplication(ctx, optional)
    18  
    19  
    20  
    21  Create a new application within your account
    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 CreateApplicationParams 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  **ApiVersion** | **string** | The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`. The default value is the account's default API version.
    36  **VoiceUrl** | **string** | The URL we should call when the phone number assigned to this application receives a call.
    37  **VoiceMethod** | **string** | The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.
    38  **VoiceFallbackUrl** | **string** | The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.
    39  **VoiceFallbackMethod** | **string** | The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.
    40  **StatusCallback** | **string** | The URL we should call using the `status_callback_method` to send status information to your application.
    41  **StatusCallbackMethod** | **string** | The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`.
    42  **VoiceCallerIdLookup** | **bool** | Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: `true` or `false`.
    43  **SmsUrl** | **string** | The URL we should call when the phone number receives an incoming SMS message.
    44  **SmsMethod** | **string** | The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`.
    45  **SmsFallbackUrl** | **string** | The URL that we should call when an error occurs while retrieving or executing the TwiML from `sms_url`.
    46  **SmsFallbackMethod** | **string** | The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`.
    47  **SmsStatusCallback** | **string** | The URL we should call using a POST method to send status information about SMS messages sent by the application.
    48  **MessageStatusCallback** | **string** | The URL we should call using a POST method to send message status information to your application.
    49  **FriendlyName** | **string** | A descriptive string that you create to describe the new application. It can be up to 64 characters long.
    50  **PublicApplicationConnectEnabled** | **bool** | Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: `true` or `false`.
    51  
    52  ### Return type
    53  
    54  [**ApiV2010Application**](ApiV2010Application.md)
    55  
    56  ### Authorization
    57  
    58  [accountSid_authToken](../README.md#accountSid_authToken)
    59  
    60  ### HTTP request headers
    61  
    62  - **Content-Type**: application/x-www-form-urlencoded
    63  - **Accept**: application/json
    64  
    65  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    66  [[Back to Model list]](../README.md#documentation-for-models)
    67  [[Back to README]](../README.md)
    68  
    69  
    70  ## DeleteApplication
    71  
    72  > DeleteApplication(ctx, Sidoptional)
    73  
    74  
    75  
    76  Delete the application by the specified application sid
    77  
    78  ### Path Parameters
    79  
    80  
    81  Name | Type | Description
    82  ------------- | ------------- | -------------
    83  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    84  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Application resource to delete.
    85  
    86  ### Other Parameters
    87  
    88  Other parameters are passed through a pointer to a DeleteApplicationParams struct
    89  
    90  
    91  Name | Type | Description
    92  ------------- | ------------- | -------------
    93  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resources to delete.
    94  
    95  ### Return type
    96  
    97   (empty response body)
    98  
    99  ### Authorization
   100  
   101  [accountSid_authToken](../README.md#accountSid_authToken)
   102  
   103  ### HTTP request headers
   104  
   105  - **Content-Type**: Not defined
   106  - **Accept**: Not defined
   107  
   108  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   109  [[Back to Model list]](../README.md#documentation-for-models)
   110  [[Back to README]](../README.md)
   111  
   112  
   113  ## FetchApplication
   114  
   115  > ApiV2010Application FetchApplication(ctx, Sidoptional)
   116  
   117  
   118  
   119  Fetch the application specified by the provided sid
   120  
   121  ### Path Parameters
   122  
   123  
   124  Name | Type | Description
   125  ------------- | ------------- | -------------
   126  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   127  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Application resource to fetch.
   128  
   129  ### Other Parameters
   130  
   131  Other parameters are passed through a pointer to a FetchApplicationParams struct
   132  
   133  
   134  Name | Type | Description
   135  ------------- | ------------- | -------------
   136  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resource to fetch.
   137  
   138  ### Return type
   139  
   140  [**ApiV2010Application**](ApiV2010Application.md)
   141  
   142  ### Authorization
   143  
   144  [accountSid_authToken](../README.md#accountSid_authToken)
   145  
   146  ### HTTP request headers
   147  
   148  - **Content-Type**: Not defined
   149  - **Accept**: application/json
   150  
   151  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   152  [[Back to Model list]](../README.md#documentation-for-models)
   153  [[Back to README]](../README.md)
   154  
   155  
   156  ## ListApplication
   157  
   158  > []ApiV2010Application ListApplication(ctx, optional)
   159  
   160  
   161  
   162  Retrieve a list of applications representing an application within the requesting account
   163  
   164  ### Path Parameters
   165  
   166  This endpoint does not need any path parameter.
   167  
   168  ### Other Parameters
   169  
   170  Other parameters are passed through a pointer to a ListApplicationParams struct
   171  
   172  
   173  Name | Type | Description
   174  ------------- | ------------- | -------------
   175  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resources to read.
   176  **FriendlyName** | **string** | The string that identifies the Application resources to read.
   177  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   178  **Limit** | **int** | Max number of records to return.
   179  
   180  ### Return type
   181  
   182  [**[]ApiV2010Application**](ApiV2010Application.md)
   183  
   184  ### Authorization
   185  
   186  [accountSid_authToken](../README.md#accountSid_authToken)
   187  
   188  ### HTTP request headers
   189  
   190  - **Content-Type**: Not defined
   191  - **Accept**: application/json
   192  
   193  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   194  [[Back to Model list]](../README.md#documentation-for-models)
   195  [[Back to README]](../README.md)
   196  
   197  
   198  ## UpdateApplication
   199  
   200  > ApiV2010Application UpdateApplication(ctx, Sidoptional)
   201  
   202  
   203  
   204  Updates the application's properties
   205  
   206  ### Path Parameters
   207  
   208  
   209  Name | Type | Description
   210  ------------- | ------------- | -------------
   211  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   212  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Application resource to update.
   213  
   214  ### Other Parameters
   215  
   216  Other parameters are passed through a pointer to a UpdateApplicationParams struct
   217  
   218  
   219  Name | Type | Description
   220  ------------- | ------------- | -------------
   221  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resources to update.
   222  **FriendlyName** | **string** | A descriptive string that you create to describe the resource. It can be up to 64 characters long.
   223  **ApiVersion** | **string** | The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`. The default value is your account's default API version.
   224  **VoiceUrl** | **string** | The URL we should call when the phone number assigned to this application receives a call.
   225  **VoiceMethod** | **string** | The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.
   226  **VoiceFallbackUrl** | **string** | The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.
   227  **VoiceFallbackMethod** | **string** | The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.
   228  **StatusCallback** | **string** | The URL we should call using the `status_callback_method` to send status information to your application.
   229  **StatusCallbackMethod** | **string** | The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`.
   230  **VoiceCallerIdLookup** | **bool** | Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: `true` or `false`.
   231  **SmsUrl** | **string** | The URL we should call when the phone number receives an incoming SMS message.
   232  **SmsMethod** | **string** | The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`.
   233  **SmsFallbackUrl** | **string** | The URL that we should call when an error occurs while retrieving or executing the TwiML from `sms_url`.
   234  **SmsFallbackMethod** | **string** | The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`.
   235  **SmsStatusCallback** | **string** | Same as message_status_callback: The URL we should call using a POST method to send status information about SMS messages sent by the application. Deprecated, included for backwards compatibility.
   236  **MessageStatusCallback** | **string** | The URL we should call using a POST method to send message status information to your application.
   237  **PublicApplicationConnectEnabled** | **bool** | Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: `true` or `false`.
   238  
   239  ### Return type
   240  
   241  [**ApiV2010Application**](ApiV2010Application.md)
   242  
   243  ### Authorization
   244  
   245  [accountSid_authToken](../README.md#accountSid_authToken)
   246  
   247  ### HTTP request headers
   248  
   249  - **Content-Type**: application/x-www-form-urlencoded
   250  - **Accept**: application/json
   251  
   252  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   253  [[Back to Model list]](../README.md#documentation-for-models)
   254  [[Back to README]](../README.md)
   255