diff --git a/openapi.json b/openapi.json index 5ce1585014c..bb841b336b7 100644 --- a/openapi.json +++ b/openapi.json @@ -12697,7 +12697,7 @@ } }, "501": { - "description": "", + "description": "SIP dial-out is not configured", "content": { "application/json": { "schema": { @@ -14596,6 +14596,162 @@ } } }, + "/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/verify-dialout": { + "get": { + "operationId": "room-get-participant-by-dial-out-number", + "summary": "Get a participant by their dial-out number (SIP bridge)", + "tags": [ + "room" + ], + "security": [ + {}, + { + "bearer_auth": [] + }, + { + "basic_auth": [] + } + ], + "parameters": [ + { + "name": "number", + "in": "query", + "description": "E164 formatted phone number", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "options", + "in": "query", + "description": "Additional details to verify the validity of the request", + "schema": { + "type": "string" + } + }, + { + "name": "apiVersion", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "v4" + ], + "default": "v4" + } + }, + { + "name": "token", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^[a-z0-9]{4,30}$" + } + }, + { + "name": "OCS-APIRequest", + "in": "header", + "description": "Required to be true for the API request to pass", + "required": true, + "schema": { + "type": "boolean", + "default": true + } + } + ], + "responses": { + "200": { + "description": "Participant created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "$ref": "#/components/schemas/Room" + } + } + } + } + } + } + } + }, + "400": { + "description": "Phone number and details could not be confirmed", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": {} + } + } + } + } + } + } + }, + "401": { + "description": "SIP request invalid", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": {} + } + } + } + } + } + } + } + } + } + }, "/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/notify": { "post": { "operationId": "room-set-notification-level",