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

     1  # AccountsSIPDomainsApi
     2  
     3  All URIs are relative to *https://api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateSipDomain**](AccountsSIPDomainsApi.md#CreateSipDomain) | **Post** /2010-04-01/Accounts/{AccountSid}/SIP/Domains.json | 
     8  [**DeleteSipDomain**](AccountsSIPDomainsApi.md#DeleteSipDomain) | **Delete** /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json | 
     9  [**FetchSipDomain**](AccountsSIPDomainsApi.md#FetchSipDomain) | **Get** /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json | 
    10  [**ListSipDomain**](AccountsSIPDomainsApi.md#ListSipDomain) | **Get** /2010-04-01/Accounts/{AccountSid}/SIP/Domains.json | 
    11  [**UpdateSipDomain**](AccountsSIPDomainsApi.md#UpdateSipDomain) | **Post** /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json | 
    12  
    13  
    14  
    15  ## CreateSipDomain
    16  
    17  > ApiV2010SipDomain CreateSipDomain(ctx, optional)
    18  
    19  
    20  
    21  Create a new Domain
    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 CreateSipDomainParams 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  **DomainName** | **string** | The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and \\\"-\\\" and must end with `sip.twilio.com`.
    36  **FriendlyName** | **string** | A descriptive string that you created to describe the resource. It can be up to 64 characters long.
    37  **VoiceUrl** | **string** | The URL we should when the domain receives a call.
    38  **VoiceMethod** | **string** | The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.
    39  **VoiceFallbackUrl** | **string** | The URL that we should call when an error occurs while retrieving or executing the TwiML from `voice_url`.
    40  **VoiceFallbackMethod** | **string** | The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.
    41  **VoiceStatusCallbackUrl** | **string** | The URL that we should call to pass status parameters (such as call ended) to your application.
    42  **VoiceStatusCallbackMethod** | **string** | The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`.
    43  **SipRegistration** | **bool** | Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not.
    44  **EmergencyCallingEnabled** | **bool** | Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.
    45  **Secure** | **bool** | Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.
    46  **ByocTrunkSid** | **string** | The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.
    47  **EmergencyCallerSid** | **string** | Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.
    48  
    49  ### Return type
    50  
    51  [**ApiV2010SipDomain**](ApiV2010SipDomain.md)
    52  
    53  ### Authorization
    54  
    55  [accountSid_authToken](../README.md#accountSid_authToken)
    56  
    57  ### HTTP request headers
    58  
    59  - **Content-Type**: application/x-www-form-urlencoded
    60  - **Accept**: application/json
    61  
    62  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    63  [[Back to Model list]](../README.md#documentation-for-models)
    64  [[Back to README]](../README.md)
    65  
    66  
    67  ## DeleteSipDomain
    68  
    69  > DeleteSipDomain(ctx, Sidoptional)
    70  
    71  
    72  
    73  Delete an instance of a Domain
    74  
    75  ### Path Parameters
    76  
    77  
    78  Name | Type | Description
    79  ------------- | ------------- | -------------
    80  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    81  **Sid** | **string** | The Twilio-provided string that uniquely identifies the SipDomain resource to delete.
    82  
    83  ### Other Parameters
    84  
    85  Other parameters are passed through a pointer to a DeleteSipDomainParams struct
    86  
    87  
    88  Name | Type | Description
    89  ------------- | ------------- | -------------
    90  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resources to delete.
    91  
    92  ### Return type
    93  
    94   (empty response body)
    95  
    96  ### Authorization
    97  
    98  [accountSid_authToken](../README.md#accountSid_authToken)
    99  
   100  ### HTTP request headers
   101  
   102  - **Content-Type**: Not defined
   103  - **Accept**: Not defined
   104  
   105  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   106  [[Back to Model list]](../README.md#documentation-for-models)
   107  [[Back to README]](../README.md)
   108  
   109  
   110  ## FetchSipDomain
   111  
   112  > ApiV2010SipDomain FetchSipDomain(ctx, Sidoptional)
   113  
   114  
   115  
   116  Fetch an instance of a Domain
   117  
   118  ### Path Parameters
   119  
   120  
   121  Name | Type | Description
   122  ------------- | ------------- | -------------
   123  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   124  **Sid** | **string** | The Twilio-provided string that uniquely identifies the SipDomain resource to fetch.
   125  
   126  ### Other Parameters
   127  
   128  Other parameters are passed through a pointer to a FetchSipDomainParams struct
   129  
   130  
   131  Name | Type | Description
   132  ------------- | ------------- | -------------
   133  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resource to fetch.
   134  
   135  ### Return type
   136  
   137  [**ApiV2010SipDomain**](ApiV2010SipDomain.md)
   138  
   139  ### Authorization
   140  
   141  [accountSid_authToken](../README.md#accountSid_authToken)
   142  
   143  ### HTTP request headers
   144  
   145  - **Content-Type**: Not defined
   146  - **Accept**: application/json
   147  
   148  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   149  [[Back to Model list]](../README.md#documentation-for-models)
   150  [[Back to README]](../README.md)
   151  
   152  
   153  ## ListSipDomain
   154  
   155  > []ApiV2010SipDomain ListSipDomain(ctx, optional)
   156  
   157  
   158  
   159  Retrieve a list of domains belonging to the account used to make the request
   160  
   161  ### Path Parameters
   162  
   163  This endpoint does not need any path parameter.
   164  
   165  ### Other Parameters
   166  
   167  Other parameters are passed through a pointer to a ListSipDomainParams struct
   168  
   169  
   170  Name | Type | Description
   171  ------------- | ------------- | -------------
   172  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resources to read.
   173  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   174  **Limit** | **int** | Max number of records to return.
   175  
   176  ### Return type
   177  
   178  [**[]ApiV2010SipDomain**](ApiV2010SipDomain.md)
   179  
   180  ### Authorization
   181  
   182  [accountSid_authToken](../README.md#accountSid_authToken)
   183  
   184  ### HTTP request headers
   185  
   186  - **Content-Type**: Not defined
   187  - **Accept**: application/json
   188  
   189  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   190  [[Back to Model list]](../README.md#documentation-for-models)
   191  [[Back to README]](../README.md)
   192  
   193  
   194  ## UpdateSipDomain
   195  
   196  > ApiV2010SipDomain UpdateSipDomain(ctx, Sidoptional)
   197  
   198  
   199  
   200  Update the attributes of a domain
   201  
   202  ### Path Parameters
   203  
   204  
   205  Name | Type | Description
   206  ------------- | ------------- | -------------
   207  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   208  **Sid** | **string** | The Twilio-provided string that uniquely identifies the SipDomain resource to update.
   209  
   210  ### Other Parameters
   211  
   212  Other parameters are passed through a pointer to a UpdateSipDomainParams struct
   213  
   214  
   215  Name | Type | Description
   216  ------------- | ------------- | -------------
   217  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resource to update.
   218  **FriendlyName** | **string** | A descriptive string that you created to describe the resource. It can be up to 64 characters long.
   219  **VoiceFallbackMethod** | **string** | The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.
   220  **VoiceFallbackUrl** | **string** | The URL that we should call when an error occurs while retrieving or executing the TwiML requested by `voice_url`.
   221  **VoiceMethod** | **string** | The HTTP method we should use to call `voice_url`
   222  **VoiceStatusCallbackMethod** | **string** | The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`.
   223  **VoiceStatusCallbackUrl** | **string** | The URL that we should call to pass status parameters (such as call ended) to your application.
   224  **VoiceUrl** | **string** | The URL we should call when the domain receives a call.
   225  **SipRegistration** | **bool** | Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not.
   226  **DomainName** | **string** | The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and \\\"-\\\" and must end with `sip.twilio.com`.
   227  **EmergencyCallingEnabled** | **bool** | Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.
   228  **Secure** | **bool** | Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.
   229  **ByocTrunkSid** | **string** | The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.
   230  **EmergencyCallerSid** | **string** | Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.
   231  
   232  ### Return type
   233  
   234  [**ApiV2010SipDomain**](ApiV2010SipDomain.md)
   235  
   236  ### Authorization
   237  
   238  [accountSid_authToken](../README.md#accountSid_authToken)
   239  
   240  ### HTTP request headers
   241  
   242  - **Content-Type**: application/x-www-form-urlencoded
   243  - **Accept**: application/json
   244  
   245  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   246  [[Back to Model list]](../README.md#documentation-for-models)
   247  [[Back to README]](../README.md)
   248