twilio-rust-openapi 1.0.0

This is the public Twilio REST API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195

# \Api20100401DomainApi

All URIs are relative to *https://api.twilio.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_sip_domain**](Api20100401DomainApi.md#create_sip_domain) | **POST** /2010-04-01/Accounts/{AccountSid}/SIP/Domains.json | 
[**delete_sip_domain**](Api20100401DomainApi.md#delete_sip_domain) | **DELETE** /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json | 
[**fetch_sip_domain**](Api20100401DomainApi.md#fetch_sip_domain) | **GET** /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json | 
[**list_sip_domain**](Api20100401DomainApi.md#list_sip_domain) | **GET** /2010-04-01/Accounts/{AccountSid}/SIP/Domains.json | 
[**update_sip_domain**](Api20100401DomainApi.md#update_sip_domain) | **POST** /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json | 



## create_sip_domain

> models::ApiPeriodV2010PeriodAccountPeriodSipPeriodSipDomain create_sip_domain(account_sid, domain_name, friendly_name, voice_url, voice_method, voice_fallback_url, voice_fallback_method, voice_status_callback_url, voice_status_callback_method, sip_registration, emergency_calling_enabled, secure, byoc_trunk_sid, emergency_caller_sid)


Create a new Domain

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**account_sid** | **String** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. | [required] |
**domain_name** | **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`. | [required] |
**friendly_name** | Option<**String**> | A descriptive string that you created to describe the resource. It can be up to 64 characters long. |  |
**voice_url** | Option<**String**> | The URL we should when the domain receives a call. |  |
**voice_method** | Option<**String**> | The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`. |  |
**voice_fallback_url** | Option<**String**> | The URL that we should call when an error occurs while retrieving or executing the TwiML from `voice_url`. |  |
**voice_fallback_method** | Option<**String**> | The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`. |  |
**voice_status_callback_url** | Option<**String**> | The URL that we should call to pass status parameters (such as call ended) to your application. |  |
**voice_status_callback_method** | Option<**String**> | The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`. |  |
**sip_registration** | Option<**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. |  |
**emergency_calling_enabled** | Option<**bool**> | Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses. |  |
**secure** | Option<**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. |  |
**byoc_trunk_sid** | Option<**String**> | The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with. |  |
**emergency_caller_sid** | Option<**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. |  |

### Return type

[**models::ApiPeriodV2010PeriodAccountPeriodSipPeriodSipDomain**](api.v2010.account.sip.sip_domain.md)

### Authorization

[accountSid_authToken](../README.md#accountSid_authToken)

### HTTP request headers

- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: application/json

[[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)


## delete_sip_domain

> delete_sip_domain(account_sid, sid)


Delete an instance of a Domain

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**account_sid** | **String** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resources to delete. | [required] |
**sid** | **String** | The Twilio-provided string that uniquely identifies the SipDomain resource to delete. | [required] |

### Return type

 (empty response body)

### Authorization

[accountSid_authToken](../README.md#accountSid_authToken)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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)


## fetch_sip_domain

> models::ApiPeriodV2010PeriodAccountPeriodSipPeriodSipDomain fetch_sip_domain(account_sid, sid)


Fetch an instance of a Domain

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**account_sid** | **String** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resource to fetch. | [required] |
**sid** | **String** | The Twilio-provided string that uniquely identifies the SipDomain resource to fetch. | [required] |

### Return type

[**models::ApiPeriodV2010PeriodAccountPeriodSipPeriodSipDomain**](api.v2010.account.sip.sip_domain.md)

### Authorization

[accountSid_authToken](../README.md#accountSid_authToken)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## list_sip_domain

> models::ListSipDomainResponse list_sip_domain(account_sid, page_size, page, page_token)


Retrieve a list of domains belonging to the account used to make the request

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**account_sid** | **String** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resources to read. | [required] |
**page_size** | Option<**i32**> | How many resources to return in each list page. The default is 50, and the maximum is 1000. |  |
**page** | Option<**i32**> | The page index. This value is simply for client state. |  |
**page_token** | Option<**String**> | The page token. This is provided by the API. |  |

### Return type

[**models::ListSipDomainResponse**](ListSipDomainResponse.md)

### Authorization

[accountSid_authToken](../README.md#accountSid_authToken)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## update_sip_domain

> models::ApiPeriodV2010PeriodAccountPeriodSipPeriodSipDomain update_sip_domain(account_sid, sid, friendly_name, voice_fallback_method, voice_fallback_url, voice_method, voice_status_callback_method, voice_status_callback_url, voice_url, sip_registration, domain_name, emergency_calling_enabled, secure, byoc_trunk_sid, emergency_caller_sid)


Update the attributes of a domain

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**account_sid** | **String** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resource to update. | [required] |
**sid** | **String** | The Twilio-provided string that uniquely identifies the SipDomain resource to update. | [required] |
**friendly_name** | Option<**String**> | A descriptive string that you created to describe the resource. It can be up to 64 characters long. |  |
**voice_fallback_method** | Option<**String**> | The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`. |  |
**voice_fallback_url** | Option<**String**> | The URL that we should call when an error occurs while retrieving or executing the TwiML requested by `voice_url`. |  |
**voice_method** | Option<**String**> | The HTTP method we should use to call `voice_url` |  |
**voice_status_callback_method** | Option<**String**> | The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`. |  |
**voice_status_callback_url** | Option<**String**> | The URL that we should call to pass status parameters (such as call ended) to your application. |  |
**voice_url** | Option<**String**> | The URL we should call when the domain receives a call. |  |
**sip_registration** | Option<**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. |  |
**domain_name** | Option<**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`. |  |
**emergency_calling_enabled** | Option<**bool**> | Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses. |  |
**secure** | Option<**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. |  |
**byoc_trunk_sid** | Option<**String**> | The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with. |  |
**emergency_caller_sid** | Option<**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. |  |

### Return type

[**models::ApiPeriodV2010PeriodAccountPeriodSipPeriodSipDomain**](api.v2010.account.sip.sip_domain.md)

### Authorization

[accountSid_authToken](../README.md#accountSid_authToken)

### HTTP request headers

- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: application/json

[[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)