bandwidth-sdk 18.0.0 → 18.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +4 -4
- data/README.md +28 -1
- data/bandwidth.yml +944 -19
- data/coverage/.last_run.json +1 -1
- data/coverage/.resultset.json +784 -152
- data/coverage/index.html +21650 -14800
- data/docs/BrtcError.md +26 -0
- data/docs/BrtcErrorResponse.md +22 -0
- data/docs/BrtcErrorSource.md +24 -0
- data/docs/BrtcLink.md +22 -0
- data/docs/CreateCall.md +2 -2
- data/docs/CreateEndpointRequestBase.md +26 -0
- data/docs/CreateEndpointResponse.md +22 -0
- data/docs/CreateEndpointResponseData.md +32 -0
- data/docs/CreateWebRtcConnectionRequest.md +28 -0
- data/docs/Device.md +24 -0
- data/docs/DeviceStatusEnum.md +15 -0
- data/docs/Endpoint.md +30 -0
- data/docs/EndpointDirectionEnum.md +15 -0
- data/docs/EndpointEvent.md +34 -0
- data/docs/EndpointEventTypeEnum.md +15 -0
- data/docs/EndpointResponse.md +22 -0
- data/docs/EndpointStatusEnum.md +15 -0
- data/docs/EndpointTypeEnum.md +15 -0
- data/docs/Endpoints.md +28 -0
- data/docs/EndpointsApi.md +395 -0
- data/docs/InboundCallback.md +2 -2
- data/docs/ListEndpointsResponse.md +24 -0
- data/docs/LookupResult.md +1 -1
- data/docs/MachineDetectionConfiguration.md +1 -1
- data/docs/MessageRequest.md +1 -1
- data/docs/Page.md +24 -0
- data/docs/RbmActionBase.md +1 -1
- data/docs/RbmSuggestionResponse.md +1 -1
- data/docs/SipConnectionMetadata.md +24 -0
- data/docs/SipCredentials.md +20 -0
- data/docs/StatusCallback.md +1 -1
- data/docs/SyncLookupRequest.md +3 -1
- data/docs/UpdateCall.md +1 -1
- data/docs/WebhookSubscriptionError.md +22 -0
- data/docs/WebhookSubscriptionsListBody.md +1 -1
- data/lib/bandwidth-sdk/api/endpoints_api.rb +397 -0
- data/lib/bandwidth-sdk/configuration.rb +30 -0
- data/lib/bandwidth-sdk/models/brtc_error.rb +219 -0
- data/lib/bandwidth-sdk/models/brtc_error_response.rb +204 -0
- data/lib/bandwidth-sdk/models/brtc_error_source.rb +176 -0
- data/lib/bandwidth-sdk/models/brtc_link.rb +166 -0
- data/lib/bandwidth-sdk/models/create_call.rb +7 -7
- data/lib/bandwidth-sdk/models/create_endpoint_request_base.rb +250 -0
- data/lib/bandwidth-sdk/models/create_endpoint_response.rb +218 -0
- data/lib/bandwidth-sdk/models/create_endpoint_response_data.rb +356 -0
- data/lib/bandwidth-sdk/models/create_web_rtc_connection_request.rb +266 -0
- data/lib/bandwidth-sdk/models/device.rb +258 -0
- data/lib/bandwidth-sdk/models/device_status_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/endpoint.rb +329 -0
- data/lib/bandwidth-sdk/models/endpoint_direction_enum.rb +41 -0
- data/lib/bandwidth-sdk/models/endpoint_event.rb +381 -0
- data/lib/bandwidth-sdk/models/endpoint_event_type_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/endpoint_response.rb +218 -0
- data/lib/bandwidth-sdk/models/endpoint_status_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/endpoint_type_enum.rb +39 -0
- data/lib/bandwidth-sdk/models/endpoints.rb +311 -0
- data/lib/bandwidth-sdk/models/inbound_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/list_endpoints_response.rb +229 -0
- data/lib/bandwidth-sdk/models/lookup_result.rb +1 -1
- data/lib/bandwidth-sdk/models/machine_detection_configuration.rb +1 -1
- data/lib/bandwidth-sdk/models/message_request.rb +1 -1
- data/lib/bandwidth-sdk/models/page.rb +259 -0
- data/lib/bandwidth-sdk/models/sip_connection_metadata.rb +175 -0
- data/lib/bandwidth-sdk/models/sip_credentials.rb +156 -0
- data/lib/bandwidth-sdk/models/status_callback.rb +1 -1
- data/lib/bandwidth-sdk/models/sync_lookup_request.rb +35 -4
- data/lib/bandwidth-sdk/models/update_call.rb +6 -6
- data/lib/bandwidth-sdk/models/webhook_subscription_error.rb +165 -0
- data/lib/bandwidth-sdk/models/webhook_subscriptions_list_body.rb +1 -1
- data/lib/bandwidth-sdk/version.rb +1 -1
- data/lib/bandwidth-sdk.rb +24 -1
- data/spec/smoke/endpoints_api_spec.rb +148 -0
- data/spec/unit/api/endpoints_api_spec.rb +172 -0
- data/spec/unit/api/phone_number_lookup_api_spec.rb +2 -0
- metadata +104 -52
|
@@ -0,0 +1,395 @@
|
|
|
1
|
+
# Bandwidth::EndpointsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_endpoint**](EndpointsApi.md#create_endpoint) | **POST** /accounts/{accountId}/endpoints | Create Endpoint |
|
|
8
|
+
| [**delete_endpoint**](EndpointsApi.md#delete_endpoint) | **DELETE** /accounts/{accountId}/endpoints/{endpointId} | Delete Endpoint |
|
|
9
|
+
| [**get_endpoint**](EndpointsApi.md#get_endpoint) | **GET** /accounts/{accountId}/endpoints/{endpointId} | Get Endpoint |
|
|
10
|
+
| [**list_endpoints**](EndpointsApi.md#list_endpoints) | **GET** /accounts/{accountId}/endpoints | List Endpoints |
|
|
11
|
+
| [**update_endpoint_bxml**](EndpointsApi.md#update_endpoint_bxml) | **PUT** /accounts/{accountId}/endpoints/{endpointId}/bxml | Update Endpoint BXML |
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## create_endpoint
|
|
15
|
+
|
|
16
|
+
> <CreateEndpointResponse> create_endpoint(account_id, body)
|
|
17
|
+
|
|
18
|
+
Create Endpoint
|
|
19
|
+
|
|
20
|
+
Creates a new Endpoint for the specified account.
|
|
21
|
+
|
|
22
|
+
### Examples
|
|
23
|
+
|
|
24
|
+
```ruby
|
|
25
|
+
require 'time'
|
|
26
|
+
require 'bandwidth-sdk'
|
|
27
|
+
# setup authorization
|
|
28
|
+
Bandwidth.configure do |config|
|
|
29
|
+
# Configure HTTP basic authorization: Basic
|
|
30
|
+
config.username = 'YOUR USERNAME'
|
|
31
|
+
config.password = 'YOUR PASSWORD'
|
|
32
|
+
|
|
33
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
34
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
api_instance = Bandwidth::EndpointsApi.new
|
|
38
|
+
account_id = '9900000' # String | Your Bandwidth Account ID.
|
|
39
|
+
body = 3.56 # CreateWebRtcConnectionRequest |
|
|
40
|
+
|
|
41
|
+
begin
|
|
42
|
+
# Create Endpoint
|
|
43
|
+
result = api_instance.create_endpoint(account_id, body)
|
|
44
|
+
p result
|
|
45
|
+
rescue Bandwidth::ApiError => e
|
|
46
|
+
puts "Error when calling EndpointsApi->create_endpoint: #{e}"
|
|
47
|
+
end
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
#### Using the create_endpoint_with_http_info variant
|
|
51
|
+
|
|
52
|
+
This returns an Array which contains the response data, status code and headers.
|
|
53
|
+
|
|
54
|
+
> <Array(<CreateEndpointResponse>, Integer, Hash)> create_endpoint_with_http_info(account_id, body)
|
|
55
|
+
|
|
56
|
+
```ruby
|
|
57
|
+
begin
|
|
58
|
+
# Create Endpoint
|
|
59
|
+
data, status_code, headers = api_instance.create_endpoint_with_http_info(account_id, body)
|
|
60
|
+
p status_code # => 2xx
|
|
61
|
+
p headers # => { ... }
|
|
62
|
+
p data # => <CreateEndpointResponse>
|
|
63
|
+
rescue Bandwidth::ApiError => e
|
|
64
|
+
puts "Error when calling EndpointsApi->create_endpoint_with_http_info: #{e}"
|
|
65
|
+
end
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Parameters
|
|
69
|
+
|
|
70
|
+
| Name | Type | Description | Notes |
|
|
71
|
+
| ---- | ---- | ----------- | ----- |
|
|
72
|
+
| **account_id** | **String** | Your Bandwidth Account ID. | |
|
|
73
|
+
| **body** | **CreateWebRtcConnectionRequest** | | |
|
|
74
|
+
|
|
75
|
+
### Return type
|
|
76
|
+
|
|
77
|
+
[**CreateEndpointResponse**](CreateEndpointResponse.md)
|
|
78
|
+
|
|
79
|
+
### Authorization
|
|
80
|
+
|
|
81
|
+
[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
|
|
82
|
+
|
|
83
|
+
### HTTP request headers
|
|
84
|
+
|
|
85
|
+
- **Content-Type**: application/json
|
|
86
|
+
- **Accept**: application/json
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
## delete_endpoint
|
|
90
|
+
|
|
91
|
+
> delete_endpoint(account_id, endpoint_id)
|
|
92
|
+
|
|
93
|
+
Delete Endpoint
|
|
94
|
+
|
|
95
|
+
Deletes the specified endpoint. If the endpoint is actively streaming media, the media stream will be terminated.
|
|
96
|
+
|
|
97
|
+
### Examples
|
|
98
|
+
|
|
99
|
+
```ruby
|
|
100
|
+
require 'time'
|
|
101
|
+
require 'bandwidth-sdk'
|
|
102
|
+
# setup authorization
|
|
103
|
+
Bandwidth.configure do |config|
|
|
104
|
+
# Configure HTTP basic authorization: Basic
|
|
105
|
+
config.username = 'YOUR USERNAME'
|
|
106
|
+
config.password = 'YOUR PASSWORD'
|
|
107
|
+
|
|
108
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
109
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
api_instance = Bandwidth::EndpointsApi.new
|
|
113
|
+
account_id = '9900000' # String | Your Bandwidth Account ID.
|
|
114
|
+
endpoint_id = 'e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | BRTC Endpoint ID.
|
|
115
|
+
|
|
116
|
+
begin
|
|
117
|
+
# Delete Endpoint
|
|
118
|
+
api_instance.delete_endpoint(account_id, endpoint_id)
|
|
119
|
+
rescue Bandwidth::ApiError => e
|
|
120
|
+
puts "Error when calling EndpointsApi->delete_endpoint: #{e}"
|
|
121
|
+
end
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
#### Using the delete_endpoint_with_http_info variant
|
|
125
|
+
|
|
126
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
127
|
+
|
|
128
|
+
> <Array(nil, Integer, Hash)> delete_endpoint_with_http_info(account_id, endpoint_id)
|
|
129
|
+
|
|
130
|
+
```ruby
|
|
131
|
+
begin
|
|
132
|
+
# Delete Endpoint
|
|
133
|
+
data, status_code, headers = api_instance.delete_endpoint_with_http_info(account_id, endpoint_id)
|
|
134
|
+
p status_code # => 2xx
|
|
135
|
+
p headers # => { ... }
|
|
136
|
+
p data # => nil
|
|
137
|
+
rescue Bandwidth::ApiError => e
|
|
138
|
+
puts "Error when calling EndpointsApi->delete_endpoint_with_http_info: #{e}"
|
|
139
|
+
end
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Parameters
|
|
143
|
+
|
|
144
|
+
| Name | Type | Description | Notes |
|
|
145
|
+
| ---- | ---- | ----------- | ----- |
|
|
146
|
+
| **account_id** | **String** | Your Bandwidth Account ID. | |
|
|
147
|
+
| **endpoint_id** | **String** | BRTC Endpoint ID. | |
|
|
148
|
+
|
|
149
|
+
### Return type
|
|
150
|
+
|
|
151
|
+
nil (empty response body)
|
|
152
|
+
|
|
153
|
+
### Authorization
|
|
154
|
+
|
|
155
|
+
[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
|
|
156
|
+
|
|
157
|
+
### HTTP request headers
|
|
158
|
+
|
|
159
|
+
- **Content-Type**: Not defined
|
|
160
|
+
- **Accept**: application/json
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
## get_endpoint
|
|
164
|
+
|
|
165
|
+
> <EndpointResponse> get_endpoint(account_id, endpoint_id)
|
|
166
|
+
|
|
167
|
+
Get Endpoint
|
|
168
|
+
|
|
169
|
+
Returns information about the specified endpoint.
|
|
170
|
+
|
|
171
|
+
### Examples
|
|
172
|
+
|
|
173
|
+
```ruby
|
|
174
|
+
require 'time'
|
|
175
|
+
require 'bandwidth-sdk'
|
|
176
|
+
# setup authorization
|
|
177
|
+
Bandwidth.configure do |config|
|
|
178
|
+
# Configure HTTP basic authorization: Basic
|
|
179
|
+
config.username = 'YOUR USERNAME'
|
|
180
|
+
config.password = 'YOUR PASSWORD'
|
|
181
|
+
|
|
182
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
183
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
api_instance = Bandwidth::EndpointsApi.new
|
|
187
|
+
account_id = '9900000' # String | Your Bandwidth Account ID.
|
|
188
|
+
endpoint_id = 'e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | BRTC Endpoint ID.
|
|
189
|
+
|
|
190
|
+
begin
|
|
191
|
+
# Get Endpoint
|
|
192
|
+
result = api_instance.get_endpoint(account_id, endpoint_id)
|
|
193
|
+
p result
|
|
194
|
+
rescue Bandwidth::ApiError => e
|
|
195
|
+
puts "Error when calling EndpointsApi->get_endpoint: #{e}"
|
|
196
|
+
end
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
#### Using the get_endpoint_with_http_info variant
|
|
200
|
+
|
|
201
|
+
This returns an Array which contains the response data, status code and headers.
|
|
202
|
+
|
|
203
|
+
> <Array(<EndpointResponse>, Integer, Hash)> get_endpoint_with_http_info(account_id, endpoint_id)
|
|
204
|
+
|
|
205
|
+
```ruby
|
|
206
|
+
begin
|
|
207
|
+
# Get Endpoint
|
|
208
|
+
data, status_code, headers = api_instance.get_endpoint_with_http_info(account_id, endpoint_id)
|
|
209
|
+
p status_code # => 2xx
|
|
210
|
+
p headers # => { ... }
|
|
211
|
+
p data # => <EndpointResponse>
|
|
212
|
+
rescue Bandwidth::ApiError => e
|
|
213
|
+
puts "Error when calling EndpointsApi->get_endpoint_with_http_info: #{e}"
|
|
214
|
+
end
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
### Parameters
|
|
218
|
+
|
|
219
|
+
| Name | Type | Description | Notes |
|
|
220
|
+
| ---- | ---- | ----------- | ----- |
|
|
221
|
+
| **account_id** | **String** | Your Bandwidth Account ID. | |
|
|
222
|
+
| **endpoint_id** | **String** | BRTC Endpoint ID. | |
|
|
223
|
+
|
|
224
|
+
### Return type
|
|
225
|
+
|
|
226
|
+
[**EndpointResponse**](EndpointResponse.md)
|
|
227
|
+
|
|
228
|
+
### Authorization
|
|
229
|
+
|
|
230
|
+
[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
|
|
231
|
+
|
|
232
|
+
### HTTP request headers
|
|
233
|
+
|
|
234
|
+
- **Content-Type**: Not defined
|
|
235
|
+
- **Accept**: application/json
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
## list_endpoints
|
|
239
|
+
|
|
240
|
+
> <ListEndpointsResponse> list_endpoints(account_id, opts)
|
|
241
|
+
|
|
242
|
+
List Endpoints
|
|
243
|
+
|
|
244
|
+
Returns a list of endpoints associated with the specified account.
|
|
245
|
+
|
|
246
|
+
### Examples
|
|
247
|
+
|
|
248
|
+
```ruby
|
|
249
|
+
require 'time'
|
|
250
|
+
require 'bandwidth-sdk'
|
|
251
|
+
# setup authorization
|
|
252
|
+
Bandwidth.configure do |config|
|
|
253
|
+
# Configure HTTP basic authorization: Basic
|
|
254
|
+
config.username = 'YOUR USERNAME'
|
|
255
|
+
config.password = 'YOUR PASSWORD'
|
|
256
|
+
|
|
257
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
258
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
259
|
+
end
|
|
260
|
+
|
|
261
|
+
api_instance = Bandwidth::EndpointsApi.new
|
|
262
|
+
account_id = '9900000' # String | Your Bandwidth Account ID.
|
|
263
|
+
opts = {
|
|
264
|
+
type: Bandwidth::EndpointTypeEnum::WEBRTC, # EndpointTypeEnum | The type of endpoint.
|
|
265
|
+
status: Bandwidth::EndpointStatusEnum::CONNECTED, # EndpointStatusEnum | The status of the endpoint.
|
|
266
|
+
after_cursor: 'TWF5IHRoZSBmb3JjZSBiZSB3aXRoIHlvdQ==', # String | The cursor to use for pagination. This is the value of the `next` link in the previous response.
|
|
267
|
+
limit: 2 # Integer | The maximum number of endpoints to return in the response.
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
begin
|
|
271
|
+
# List Endpoints
|
|
272
|
+
result = api_instance.list_endpoints(account_id, opts)
|
|
273
|
+
p result
|
|
274
|
+
rescue Bandwidth::ApiError => e
|
|
275
|
+
puts "Error when calling EndpointsApi->list_endpoints: #{e}"
|
|
276
|
+
end
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
#### Using the list_endpoints_with_http_info variant
|
|
280
|
+
|
|
281
|
+
This returns an Array which contains the response data, status code and headers.
|
|
282
|
+
|
|
283
|
+
> <Array(<ListEndpointsResponse>, Integer, Hash)> list_endpoints_with_http_info(account_id, opts)
|
|
284
|
+
|
|
285
|
+
```ruby
|
|
286
|
+
begin
|
|
287
|
+
# List Endpoints
|
|
288
|
+
data, status_code, headers = api_instance.list_endpoints_with_http_info(account_id, opts)
|
|
289
|
+
p status_code # => 2xx
|
|
290
|
+
p headers # => { ... }
|
|
291
|
+
p data # => <ListEndpointsResponse>
|
|
292
|
+
rescue Bandwidth::ApiError => e
|
|
293
|
+
puts "Error when calling EndpointsApi->list_endpoints_with_http_info: #{e}"
|
|
294
|
+
end
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
### Parameters
|
|
298
|
+
|
|
299
|
+
| Name | Type | Description | Notes |
|
|
300
|
+
| ---- | ---- | ----------- | ----- |
|
|
301
|
+
| **account_id** | **String** | Your Bandwidth Account ID. | |
|
|
302
|
+
| **type** | [**EndpointTypeEnum**](.md) | The type of endpoint. | [optional] |
|
|
303
|
+
| **status** | [**EndpointStatusEnum**](.md) | The status of the endpoint. | [optional] |
|
|
304
|
+
| **after_cursor** | **String** | The cursor to use for pagination. This is the value of the `next` link in the previous response. | [optional] |
|
|
305
|
+
| **limit** | **Integer** | The maximum number of endpoints to return in the response. | [optional][default to 100] |
|
|
306
|
+
|
|
307
|
+
### Return type
|
|
308
|
+
|
|
309
|
+
[**ListEndpointsResponse**](ListEndpointsResponse.md)
|
|
310
|
+
|
|
311
|
+
### Authorization
|
|
312
|
+
|
|
313
|
+
[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
|
|
314
|
+
|
|
315
|
+
### HTTP request headers
|
|
316
|
+
|
|
317
|
+
- **Content-Type**: Not defined
|
|
318
|
+
- **Accept**: application/json
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
## update_endpoint_bxml
|
|
322
|
+
|
|
323
|
+
> update_endpoint_bxml(account_id, endpoint_id, body)
|
|
324
|
+
|
|
325
|
+
Update Endpoint BXML
|
|
326
|
+
|
|
327
|
+
Updates the BXML for the specified endpoint.
|
|
328
|
+
|
|
329
|
+
### Examples
|
|
330
|
+
|
|
331
|
+
```ruby
|
|
332
|
+
require 'time'
|
|
333
|
+
require 'bandwidth-sdk'
|
|
334
|
+
# setup authorization
|
|
335
|
+
Bandwidth.configure do |config|
|
|
336
|
+
# Configure HTTP basic authorization: Basic
|
|
337
|
+
config.username = 'YOUR USERNAME'
|
|
338
|
+
config.password = 'YOUR PASSWORD'
|
|
339
|
+
|
|
340
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
341
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
342
|
+
end
|
|
343
|
+
|
|
344
|
+
api_instance = Bandwidth::EndpointsApi.new
|
|
345
|
+
account_id = '9900000' # String | Your Bandwidth Account ID.
|
|
346
|
+
endpoint_id = 'e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | BRTC Endpoint ID.
|
|
347
|
+
body = 'body_example' # String |
|
|
348
|
+
|
|
349
|
+
begin
|
|
350
|
+
# Update Endpoint BXML
|
|
351
|
+
api_instance.update_endpoint_bxml(account_id, endpoint_id, body)
|
|
352
|
+
rescue Bandwidth::ApiError => e
|
|
353
|
+
puts "Error when calling EndpointsApi->update_endpoint_bxml: #{e}"
|
|
354
|
+
end
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
#### Using the update_endpoint_bxml_with_http_info variant
|
|
358
|
+
|
|
359
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
360
|
+
|
|
361
|
+
> <Array(nil, Integer, Hash)> update_endpoint_bxml_with_http_info(account_id, endpoint_id, body)
|
|
362
|
+
|
|
363
|
+
```ruby
|
|
364
|
+
begin
|
|
365
|
+
# Update Endpoint BXML
|
|
366
|
+
data, status_code, headers = api_instance.update_endpoint_bxml_with_http_info(account_id, endpoint_id, body)
|
|
367
|
+
p status_code # => 2xx
|
|
368
|
+
p headers # => { ... }
|
|
369
|
+
p data # => nil
|
|
370
|
+
rescue Bandwidth::ApiError => e
|
|
371
|
+
puts "Error when calling EndpointsApi->update_endpoint_bxml_with_http_info: #{e}"
|
|
372
|
+
end
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
### Parameters
|
|
376
|
+
|
|
377
|
+
| Name | Type | Description | Notes |
|
|
378
|
+
| ---- | ---- | ----------- | ----- |
|
|
379
|
+
| **account_id** | **String** | Your Bandwidth Account ID. | |
|
|
380
|
+
| **endpoint_id** | **String** | BRTC Endpoint ID. | |
|
|
381
|
+
| **body** | **String** | | |
|
|
382
|
+
|
|
383
|
+
### Return type
|
|
384
|
+
|
|
385
|
+
nil (empty response body)
|
|
386
|
+
|
|
387
|
+
### Authorization
|
|
388
|
+
|
|
389
|
+
[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
|
|
390
|
+
|
|
391
|
+
### HTTP request headers
|
|
392
|
+
|
|
393
|
+
- **Content-Type**: application/xml
|
|
394
|
+
- **Accept**: application/json
|
|
395
|
+
|
data/docs/InboundCallback.md
CHANGED
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **time** | **Time** | | |
|
|
8
8
|
| **type** | [**InboundCallbackTypeEnum**](InboundCallbackTypeEnum.md) | | |
|
|
9
|
-
| **to** | **String** | The destination phone number the message was sent to.
|
|
9
|
+
| **to** | **String** | The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. | |
|
|
10
10
|
| **description** | **String** | A detailed description of the event described by the callback. | |
|
|
11
11
|
| **message** | [**InboundCallbackMessage**](InboundCallbackMessage.md) | | |
|
|
12
|
-
| **carrier_name** | **String** | The name of the Authorized Message Provider (AMP) that handled this message.
|
|
12
|
+
| **carrier_name** | **String** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Bandwidth::ListEndpointsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **links** | [**Array<BrtcLink>**](BrtcLink.md) | | |
|
|
8
|
+
| **page** | [**Page**](Page.md) | | [optional] |
|
|
9
|
+
| **data** | [**Array<Endpoints>**](Endpoints.md) | | |
|
|
10
|
+
| **errors** | [**Array<BrtcError>**](BrtcError.md) | | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'bandwidth-sdk'
|
|
16
|
+
|
|
17
|
+
instance = Bandwidth::ListEndpointsResponse.new(
|
|
18
|
+
links: null,
|
|
19
|
+
page: null,
|
|
20
|
+
data: null,
|
|
21
|
+
errors: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
data/docs/LookupResult.md
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
| **deactivation_date** | **String** | [DNI-Only](#section/DNI-Only). The datetime the carrier reported a deactivation event. | [optional] |
|
|
14
14
|
| **deactivation_event** | [**DeactivationEventEnum**](DeactivationEventEnum.md) | | [optional] |
|
|
15
15
|
| **latest_message_delivery_status** | [**LatestMessageDeliveryStatusEnum**](LatestMessageDeliveryStatusEnum.md) | | [optional] |
|
|
16
|
-
| **initial_message_delivery_status_date** | **Date** | [DNI-Only](#section/DNI-Only). The date the phone number entered the status described in `latestMessageDeliveryStatus`.
|
|
16
|
+
| **initial_message_delivery_status_date** | **Date** | [DNI-Only](#section/DNI-Only). The date the phone number entered the status described in `latestMessageDeliveryStatus`. Think of this as the \"start time\" for that status. Value resets every time the `latestMessageDeliveryStatus` changes. | [optional] |
|
|
17
17
|
| **latest_message_delivery_status_date** | **Date** | [DNI-Only](#section/DNI-Only). The date bandwidth last received delivery status information for this phone number. Use this field to understand how up-to-date the `latestMessageDeliveryStatus` is. Value resets every time the `latestMessageDeliveryStatus` changes. | [optional] |
|
|
18
18
|
| **rcs_enabled** | **Boolean** | [RCS-Only](#section/RCS-Only). Indicates whether the phone number is capable of receiving RCS messages. Value will be null if account has RCS, but no value was returned. Absent when account does not have RCS. | [optional] |
|
|
19
19
|
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **silence_timeout** | **Float** | If no speech is detected in this period, a callback with a 'silence' result is sent. | [optional][default to 10] |
|
|
10
10
|
| **speech_threshold** | **Float** | When speech has ended and a result couldn't be determined based on the audio content itself, this value is used to determine if the speaker is a machine based on the speech duration. If the length of the speech detected is greater than or equal to this threshold, the result will be 'answering-machine'. If the length of speech detected is below this threshold, the result will be 'human'. | [optional][default to 10] |
|
|
11
11
|
| **speech_end_threshold** | **Float** | Amount of silence (in seconds) before assuming the callee has finished speaking. | [optional][default to 5] |
|
|
12
|
-
| **machine_speech_end_threshold** | **Float** | When an answering machine is detected, the amount of silence (in seconds) before assuming the message has finished playing.
|
|
12
|
+
| **machine_speech_end_threshold** | **Float** | When an answering machine is detected, the amount of silence (in seconds) before assuming the message has finished playing. If not provided it will default to the speechEndThreshold value. | [optional] |
|
|
13
13
|
| **delay_result** | **Boolean** | If set to 'true' and if an answering machine is detected, the 'answering-machine' callback will be delayed until the machine is done speaking, or an end of message tone is detected, or until the 'detectionTimeout' is exceeded. If false, the 'answering-machine' result is sent immediately. | [optional][default to false] |
|
|
14
14
|
| **callback_url** | **String** | The URL to send the 'machineDetectionComplete' webhook when the detection is completed. Only for 'async' mode. | [optional] |
|
|
15
15
|
| **callback_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional][default to 'POST'] |
|
data/docs/MessageRequest.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **application_id** | **String** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | |
|
|
8
8
|
| **to** | **Array<String>** | The phone number(s) the message should be sent to in E164 format. | |
|
|
9
|
-
| **from** | **String** | Either an alphanumeric sender ID or the sender's Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message.
|
|
9
|
+
| **from** | **String** | Either an alphanumeric sender ID or the sender's Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message. Alphanumeric Sender IDs can contain up to 11 characters, upper-case letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &. Alphanumeric Sender IDs must contain at least one letter. | |
|
|
10
10
|
| **text** | **String** | The contents of the text message. Must be 2048 characters or less. | [optional] |
|
|
11
11
|
| **media** | **Array<String>** | A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. | [optional] |
|
|
12
12
|
| **tag** | **String** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] |
|
data/docs/Page.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Bandwidth::Page
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **page_size** | **Integer** | The number of items per page. | |
|
|
8
|
+
| **total_elements** | **Integer** | The total number of items. | [optional] |
|
|
9
|
+
| **total_pages** | **Integer** | The total number of pages. | [optional] |
|
|
10
|
+
| **page_number** | **Integer** | The current page number. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'bandwidth-sdk'
|
|
16
|
+
|
|
17
|
+
instance = Bandwidth::Page.new(
|
|
18
|
+
page_size: 10,
|
|
19
|
+
total_elements: 100,
|
|
20
|
+
total_pages: 10,
|
|
21
|
+
page_number: 0
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
data/docs/RbmActionBase.md
CHANGED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Bandwidth::SipConnectionMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ip_address** | **String** | The IP address of the SIP connection. | [optional] |
|
|
8
|
+
| **port** | **Integer** | The port of the SIP connection. | [optional] |
|
|
9
|
+
| **credentials** | [**SipCredentials**](SipCredentials.md) | | [optional] |
|
|
10
|
+
| **uui_header** | **String** | The User-to-User Information header for the SIP connection. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'bandwidth-sdk'
|
|
16
|
+
|
|
17
|
+
instance = Bandwidth::SipConnectionMetadata.new(
|
|
18
|
+
ip_address: 192.168.0.0,
|
|
19
|
+
port: 5060,
|
|
20
|
+
credentials: null,
|
|
21
|
+
uui_header: my-uui-header
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Bandwidth::SipCredentials
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **username** | **String** | The username for the SIP connection. | [optional] |
|
|
8
|
+
| **password** | **String** | The password for the SIP connection. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'bandwidth-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Bandwidth::SipCredentials.new(
|
|
16
|
+
username: username,
|
|
17
|
+
password: password
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/StatusCallback.md
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
| **description** | **String** | A detailed description of the event described by the callback. | |
|
|
12
12
|
| **message** | [**StatusCallbackMessage**](StatusCallbackMessage.md) | | |
|
|
13
13
|
| **error_code** | **Integer** | Optional error code, applicable only when type is `message-failed`. | [optional] |
|
|
14
|
-
| **carrier_name** | **String** | The name of the Authorized Message Provider (AMP) that handled this message.
|
|
14
|
+
| **carrier_name** | **String** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] |
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
data/docs/SyncLookupRequest.md
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **phone_numbers** | **Array<String>** | Telephone numbers in E.164 format. | |
|
|
8
|
+
| **rcs_agent** | **String** | Override the default RCS sender/agent ID used when checking RCS capabilities. When provided, this value is used as the `sender` in the RCS capability-check request instead of the account default. Must be 1–40 characters and contain only letters, digits, underscores, or hyphens. | [optional] |
|
|
8
9
|
|
|
9
10
|
## Example
|
|
10
11
|
|
|
@@ -12,7 +13,8 @@
|
|
|
12
13
|
require 'bandwidth-sdk'
|
|
13
14
|
|
|
14
15
|
instance = Bandwidth::SyncLookupRequest.new(
|
|
15
|
-
phone_numbers: null
|
|
16
|
+
phone_numbers: null,
|
|
17
|
+
rcs_agent: MyCustomRcsAgent
|
|
16
18
|
)
|
|
17
19
|
```
|
|
18
20
|
|
data/docs/UpdateCall.md
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
| **redirect_fallback_method** | [**RedirectMethodEnum**](RedirectMethodEnum.md) | | [optional][default to 'POST'] |
|
|
14
14
|
| **fallback_username** | **String** | Basic auth username. | [optional] |
|
|
15
15
|
| **fallback_password** | **String** | Basic auth password. | [optional] |
|
|
16
|
-
| **tag** | **String** | A custom string that will be sent with this and all future callbacks unless overwritten by a future `tag` attribute or [`<Tag>`](/docs/voice/bxml/tag) verb, or cleared. May be cleared by setting `tag=\"\"`. Max length
|
|
16
|
+
| **tag** | **String** | A custom string that will be sent with this and all future callbacks unless overwritten by a future `tag` attribute or [`<Tag>`](/docs/voice/bxml/tag) verb, or cleared. May be cleared by setting `tag=\"\"`. Max length 4096 characters. Not allowed if `state` is `completed`. | [optional] |
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Bandwidth::WebhookSubscriptionError
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **Integer** | | [optional] |
|
|
8
|
+
| **description** | **String** | | [optional] |
|
|
9
|
+
| **telephone_numbers** | [**Array<TelephoneNumber>**](TelephoneNumber.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'bandwidth-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Bandwidth::WebhookSubscriptionError.new(
|
|
17
|
+
code: null,
|
|
18
|
+
description: null,
|
|
19
|
+
telephone_numbers: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **links** | [**LinksObject**](LinksObject.md) | | [optional] |
|
|
8
|
-
| **errors** | [**Array<
|
|
8
|
+
| **errors** | [**Array<WebhookSubscriptionError>**](WebhookSubscriptionError.md) | | [optional] |
|
|
9
9
|
| **data** | [**Array<WebhookSubscription>**](WebhookSubscription.md) | | |
|
|
10
10
|
|
|
11
11
|
## Example
|