-
Notifications
You must be signed in to change notification settings - Fork 34
Expand file tree
/
Copy path_spec_.yaml
More file actions
345 lines (339 loc) · 12.3 KB
/
Copy path_spec_.yaml
File metadata and controls
345 lines (339 loc) · 12.3 KB
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
openapi: 3.0.3
info:
version: 1.0.0
title: Voice API
description: >-
An API to programmatically access information about SignalWire Voice
activity.
termsOfService: https://signalwire.com/legal/signalwire-cloud-agreement
externalDocs:
url: https://developers.signalwire.com
description: Find more information about this and other SignalWire APIs.
servers:
- url: https://{space_name}.signalwire.com/api/voice
variables:
space_name:
default: YOUR_SPACE
description: Your SignalWire Space's subdomain.
security:
- basic_auth: []
components:
securitySchemes:
basic_auth:
type: http
scheme: basic
schemas:
pagination:
type: object
properties:
self:
type: string
first:
type: string
next:
type: string
prev:
type: string
tags:
- name: Logs
paths:
/logs:
get:
operationId: list_logs
summary: List Logs
description: |
List the available logs.
#### Permissions
The API token must include the following scopes: _Voice_.
tags:
- Logs
parameters:
- name: include_deleted
in: query
description: Include logs for deleted activity.
required: false
schema:
type: boolean
example: false
- name: created_before
in: query
description: Return logs for activity prior to this date.
required: false
schema:
type: string
example: '2022-04-30'
- name: created_on
in: query
description: Return logs for activity on this date.
required: false
schema:
type: string
example: '2022-04-30'
- name: created_after
in: query
description: Return logs for activity after this date.
required: false
schema:
type: string
example: '2022-04-30'
- name: page_size
in: query
description: >-
Specify the number of results to return on a single page. The
default page size is `50` and the maximum is `1000`.
required: false
schema:
type: integer
example: 20
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
links:
type: object
properties:
self:
type: string
first:
type: string
next:
type: string
prev:
type: string
data:
type: array
items:
allOf:
- type: object
properties:
id:
type: string
format: uuid
description: A unique identifier for the log.
- type: object
properties:
from:
type: string
description: The origin phone number.
example: '+12065551212'
to:
type: string
description: The destination phone number.
example: '+12065553434'
direction:
type: string
description: The direction of the voice activity.
example: inbound
status:
type: string
description: The status of the voice activity.
example: initiated
duration:
type: integer
description: The duration of the voice activity in seconds.
duration_ms:
type: integer
description: >-
The duration of the voice activity in
milliseconds.
billing_ms:
type: integer
description: >-
The billable duration of the voice activity in
seconds.
source:
type: string
description: Source of this log entry.
example: laml
type:
type: string
description: Type of this log entry.
example: laml_call
url:
type: string
description: >-
URL for the resource associated with this log
entry (if available)
charge:
type: number
description: The charge in dollars.
example: '0.01'
charge_details:
type: array
description: Details on charges associated with this log.
items:
type: object
properties:
description:
type: string
description: Description for this charge.
charge:
type: number
description: Charged amount.
example: []
- type: object
properties:
created_at:
type: string
format: date-time
/logs/{id}:
get:
operationId: get_log
summary: Find a Log by ID
description: |
Find a log by ID.
#### Permissions
The API token must include the following scopes: _Voice_.
tags:
- Logs
parameters:
- name: id
in: path
description: >-
Unique ID of the log. This is the segment_id you can find in Relay
call details in your Dashboard UI or in return objects when using
the SDK.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- type: object
properties:
id:
type: string
format: uuid
description: A unique identifier for the log.
- type: object
properties:
from:
type: string
description: The origin phone number.
example: '+12065551212'
to:
type: string
description: The destination phone number.
example: '+12065553434'
direction:
type: string
description: The direction of the voice activity.
example: inbound
status:
type: string
description: The status of the voice activity.
example: initiated
duration:
type: integer
description: The duration of the voice activity in seconds.
duration_ms:
type: integer
description: The duration of the voice activity in milliseconds.
billing_ms:
type: integer
description: >-
The billable duration of the voice activity in
seconds.
source:
type: string
description: Source of this log entry.
example: laml
type:
type: string
description: Type of this log entry.
example: laml_call
url:
type: string
description: >-
URL for the resource associated with this log entry
(if available)
charge:
type: number
description: The charge in dollars.
example: '0.01'
charge_details:
type: array
description: Details on charges associated with this log.
items:
type: object
properties:
description:
type: string
description: Description for this charge.
charge:
type: number
description: Charged amount.
example: []
- type: object
properties:
created_at:
type: string
format: date-time
/logs/{id}/events:
get:
operationId: Logs_listEvents
summary: List Log Events
description: |-
List all events for a specific log.
#### Permissions
The API token must include the following scopes: _Voice_.
tags:
- Logs
parameters:
- name: id
in: path
description: >-
Unique ID of the log. This is the segment_id you can find in Relay
call details in your Dashboard UI or in return objects when using
the SDK.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
allOf:
- type: object
properties:
event_at:
type: string
format: date-time
description: Timestamp when the event occurred
level:
type: string
description: The log level of the event
example: "info"
name:
type: string
description: The name of the event
example: "calling_call_initiated"
details:
type: object
description: Additional details about the event if present. Structure varies by event type.
example: {}
log_id:
type: string
format: uuid
description: A unique identifier for the log
project_id:
type: string
format: uuid
description: A unique identifier for the project.