Skip to content
This repository was archived by the owner on Jun 17, 2021. It is now read-only.

Commit 6ea22d0

Browse files
chao-zhou-zoomchao-zhou-zoom
committed
Chao Oct API update
1 parent bd8015f commit 6ea22d0

File tree

1 file changed

+143
-6
lines changed

1 file changed

+143
-6
lines changed

‎openapi.v2.json‎

Lines changed: 143 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,10 @@
145145
},
146146
"options": {
147147
"$ref": "#/definitions/AccountOptions"
148+
},
149+
"vanity_url": {
150+
"type": "string",
151+
"description": "Account Vanity URL"
148152
}
149153
}
150154
}
@@ -1452,7 +1456,20 @@
14521456
"required": true,
14531457
"description": "Meeting object",
14541458
"schema": {
1455-
"$ref": "#/definitions/Meeting"
1459+
"allOf": [
1460+
{
1461+
"type": "object",
1462+
"properties": {
1463+
"schedule_for": {
1464+
"type": "string",
1465+
"description": "Email or userId if you want to schedule meeting for another user."
1466+
}
1467+
}
1468+
},
1469+
{
1470+
"$ref": "#/definitions/Meeting"
1471+
}
1472+
]
14561473
}
14571474
}
14581475
],
@@ -1492,6 +1509,12 @@
14921509
},
14931510
"404": {
14941511
"description": "User not found"
1512+
},
1513+
"1001": {
1514+
"description": "User {userId} not exist or not belong to this account"
1515+
},
1516+
"1110": {
1517+
"description": "Not assigned scheduler"
14951518
}
14961519
}
14971520
}
@@ -1559,7 +1582,20 @@
15591582
"required": true,
15601583
"description": "Meeting",
15611584
"schema": {
1562-
"$ref": "#/definitions/MeetingUpdate"
1585+
"allOf": [
1586+
{
1587+
"type": "object",
1588+
"properties": {
1589+
"schedule_for": {
1590+
"type": "string",
1591+
"description": "Email or userId if you want to schedule meeting for another user."
1592+
}
1593+
}
1594+
},
1595+
{
1596+
"$ref": "#/definitions/MeetingUpdate"
1597+
}
1598+
]
15631599
}
15641600
}
15651601
],
@@ -1569,6 +1605,12 @@
15691605
},
15701606
"404": {
15711607
"description": "Meeting not found"
1608+
},
1609+
"1001": {
1610+
"description": "User {userId} not exist or not belong to this account"
1611+
},
1612+
"1110": {
1613+
"description": "Not assigned scheduler"
15721614
}
15731615
}
15741616
},
@@ -4239,10 +4281,53 @@
42394281
}
42404282
}
42414283
},
4284+
"/report/cloud_recording": {
4285+
"get": {
4286+
"summary": "Retrieve cloud recording usage report",
4287+
"description": "Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports for the most recent period of 6 months. The date gap between from and to dates should be smaller or equal to 30 days.",
4288+
"tags": [
4289+
"Reports"
4290+
],
4291+
"operationId": "reportCloudRecording",
4292+
"parameters": [
4293+
{
4294+
"$ref": "#/parameters/FromDate"
4295+
},
4296+
{
4297+
"$ref": "#/parameters/ToDate"
4298+
}
4299+
],
4300+
"responses": {
4301+
"200": {
4302+
"description": "Telephone Report Returned",
4303+
"schema": {
4304+
"properties": {
4305+
"date": {
4306+
"type": "string",
4307+
"format": "date-time"
4308+
},
4309+
"usage": {
4310+
"type": "string"
4311+
},
4312+
"plan_usage": {
4313+
"type": "string"
4314+
},
4315+
"free_usage": {
4316+
"type": "string"
4317+
}
4318+
}
4319+
}
4320+
},
4321+
"300": {
4322+
"description": "Only provide report in recent 6 months"
4323+
}
4324+
}
4325+
}
4326+
},
42424327
"/tsp": {
42434328
"get": {
4244-
"summary": "List TSP dial-in numbers",
4245-
"description": "List TSP dial-in numbers under account",
4329+
"summary": "Retrieve account's TSP information",
4330+
"description": "Retrieve TSP information on account level",
42464331
"tags": [
42474332
"TSP"
42484333
],
@@ -4251,11 +4336,16 @@
42514336
],
42524337
"responses": {
42534338
"200": {
4254-
"description": "TSP dial-in numbers returned",
4339+
"description": "TSP account detail returned",
42554340
"schema": {
42564341
"properties": {
42574342
"tsp_provider": {
4258-
"type": "string"
4343+
"type": "string",
4344+
"description": "3rd party audio conferencing provider"
4345+
},
4346+
"enable": {
4347+
"type": "boolean",
4348+
"description": "Enable 3rd party audio conferencing for account users"
42594349
},
42604350
"dial_in_numbers": {
42614351
"type": "array",
@@ -4279,6 +4369,42 @@
42794369
}
42804370
}
42814371
}
4372+
},
4373+
"patch": {
4374+
"summary": "Update account's TSP information",
4375+
"description": "Update TSP information on account level",
4376+
"tags": [
4377+
"TSP"
4378+
],
4379+
"operationId": "tsp",
4380+
"parameters": [
4381+
{
4382+
"in": "body",
4383+
"name": "body",
4384+
"required": true,
4385+
"description": "TSP Account",
4386+
"schema": {
4387+
"properties": {
4388+
"tsp_provider": {
4389+
"type": "string",
4390+
"description": "3rd party audio conferencing provider"
4391+
},
4392+
"enable": {
4393+
"type": "boolean",
4394+
"description": "Enable 3rd party audio conferencing for account users"
4395+
}
4396+
}
4397+
}
4398+
}
4399+
],
4400+
"responses": {
4401+
"204": {
4402+
"description": "TSP Account updated"
4403+
},
4404+
"2024": {
4405+
"description": "Account not enable TSP"
4406+
}
4407+
}
42824408
}
42834409
},
42844410
"/users": {
@@ -4907,6 +5033,12 @@
49075033
},
49085034
"404": {
49095035
"description": "User not found"
5036+
},
5037+
"1120": {
5038+
"description": "Invite not exist"
5039+
},
5040+
"1122": {
5041+
"description": "Only Pro or Corp user can enable {Webinar/Large Meeting} feature"
49105042
}
49115043
}
49125044
}
@@ -9218,6 +9350,11 @@
92189350
"Toll free number <br/>",
92199351
"Media link phone number <br/>"
92209352
]
9353+
},
9354+
"country_label": {
9355+
"type": "string",
9356+
"description": "Country Label, if passed, will display in place of code.",
9357+
"maxLength": 10
92219358
}
92229359
}
92239360
}

0 commit comments

Comments
 (0)