|
32 | 32 | "Calls" |
33 | 33 | ], |
34 | 34 | "summary": "List Calls", |
35 | | - "description": "Retrieves all call logs for an app. The response may include participants and recordings details when available.", |
| 35 | + "description": "lists all the calls that are available in the app. It can include participants, and recordings property in the response (if present).", |
36 | 36 | "operationId": "list-calls", |
37 | 37 | "parameters": [ |
38 | 38 | { |
|
41 | 41 | { |
42 | 42 | "name": "type", |
43 | 43 | "in": "query", |
44 | | - "description": "Filter by call type. Values: voice, video.", |
| 44 | + "description": "It includes the type of the call, possible values: audio & video", |
45 | 45 | "schema": { |
46 | 46 | "type": "string", |
47 | 47 | "enum": [ |
48 | | - "voice", |
| 48 | + "audio", |
49 | 49 | "video" |
50 | 50 | ] |
51 | 51 | } |
52 | 52 | }, |
53 | | - { |
54 | | - "name": "types", |
55 | | - "in": "query", |
56 | | - "description": "Filter calls by multiple types. Accepts comma-separated values or array notation. Values: voice, video.", |
57 | | - "style": "form", |
58 | | - "explode": false, |
59 | | - "schema": { |
60 | | - "type": "array", |
61 | | - "items": { |
62 | | - "type": "string" |
63 | | - } |
64 | | - } |
65 | | - }, |
66 | 53 | { |
67 | 54 | "name": "mode", |
68 | 55 | "in": "query", |
|
84 | 71 | "type": "integer" |
85 | 72 | } |
86 | 73 | }, |
87 | | - { |
88 | | - "name": "initiatedAt", |
89 | | - "in": "query", |
90 | | - "description": "Filter by call initiation time. Value is a 10-digit unix timestamp. Supports bracket notation operators: eq, gt, gte, lt, lte.\nFormat: initiatedAt[operator]=value.\nExample: initiatedAt[gte]=1692368168", |
91 | | - "schema": { |
92 | | - "type": "integer" |
93 | | - } |
94 | | - }, |
95 | 74 | { |
96 | 75 | "name": "startedAt", |
97 | 76 | "in": "query", |
98 | | - "description": "Filter by call start time. Value is a 10-digit unix timestamp. Supports bracket notation operators: eq, gt, gte, lt, lte.\nFormat: startedAt[operator]=value.\nExample: startedAt[gte]=1692368180", |
| 77 | + "description": "It represents when the call was started. It's 10 digit unix timestamp.", |
99 | 78 | "schema": { |
100 | 79 | "type": "integer" |
101 | 80 | } |
102 | 81 | }, |
103 | 82 | { |
104 | 83 | "name": "status", |
105 | 84 | "in": "query", |
106 | | - "description": "Filter by call status. Values: initiated, cancelled, unanswered, rejected, busy, ongoing, ended.", |
| 85 | + "description": "It indicates the status of the call. Possible values are unanswered, rejected, ongoing, ended.", |
107 | 86 | "schema": { |
108 | 87 | "type": "string", |
109 | 88 | "enum": [ |
110 | | - "initiated", |
111 | | - "cancelled", |
112 | | - "unanswered", |
113 | 89 | "rejected", |
114 | | - "busy", |
115 | 90 | "ongoing", |
116 | 91 | "ended" |
117 | 92 | ] |
118 | 93 | } |
119 | 94 | }, |
120 | | - { |
121 | | - "name": "statuses", |
122 | | - "in": "query", |
123 | | - "description": "Filter calls by multiple statuses. Accepts comma-separated values or array notation. Values: initiated, cancelled, unanswered, rejected, busy, ongoing, ended.", |
124 | | - "style": "form", |
125 | | - "explode": false, |
126 | | - "schema": { |
127 | | - "type": "array", |
128 | | - "items": { |
129 | | - "type": "string" |
130 | | - } |
131 | | - } |
132 | | - }, |
133 | 95 | { |
134 | 96 | "name": "receiverType", |
135 | 97 | "in": "query", |
|
145 | 107 | { |
146 | 108 | "name": "endedAt", |
147 | 109 | "in": "query", |
148 | | - "description": "Filter by call end time. Value is a 10-digit unix timestamp. Supports bracket notation operators: eq, gt, gte, lt, lte.\nFormat: endedAt[operator]=value.\nExample: endedAt[lte]=1692368199", |
| 110 | + "description": "It represents when the call was ended.", |
149 | 111 | "schema": { |
150 | 112 | "type": "integer" |
151 | 113 | } |
152 | 114 | }, |
153 | | - { |
154 | | - "name": "duration", |
155 | | - "in": "query", |
156 | | - "description": "Filter by total call duration in minutes (decimal). Supports bracket notation operators: eq, gt, gte, lt, lte.\nFormat: duration[operator]=value.\nExample: duration[gte]=1.5", |
157 | | - "schema": { |
158 | | - "type": "number" |
159 | | - } |
160 | | - }, |
161 | | - { |
162 | | - "name": "totalParticipants", |
163 | | - "in": "query", |
164 | | - "description": "Filter by the number of participants in the call (integer). Supports bracket notation operators: eq, gt, gte, lt, lte.\nFormat: totalParticipants[operator]=value.\nExample: totalParticipants[gt]=2", |
165 | | - "schema": { |
166 | | - "type": "integer" |
167 | | - } |
168 | | - }, |
169 | | - { |
170 | | - "name": "voiceMinutes", |
171 | | - "in": "query", |
172 | | - "description": "Filter by total audio minutes consumed in the call (decimal). Supports bracket notation operators: eq, gt, gte, lt, lte.\nFormat: voiceMinutes[operator]=value.\nExample: voiceMinutes[eq]=0.75", |
173 | | - "schema": { |
174 | | - "type": "number" |
175 | | - } |
176 | | - }, |
177 | | - { |
178 | | - "name": "videoMinutes", |
179 | | - "in": "query", |
180 | | - "description": "Filter by total video minutes consumed in the call (decimal). Supports bracket notation operators: eq, gt, gte, lt, lte.\nFormat: videoMinutes[operator]=value.\nExample: videoMinutes[lte]=5", |
181 | | - "schema": { |
182 | | - "type": "number" |
183 | | - } |
184 | | - }, |
185 | 115 | { |
186 | 116 | "name": "hasRecording", |
187 | 117 | "in": "query", |
|
0 commit comments