# Conference
Manage your conference.
## List conference servers
> List conference servers
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_servers":{"get":{"tags":["Conference"],"operationId":"listConferenceServers","summary":"List conference servers","description":"List conference servers\n","parameters":[{"name":"filter","in":"query","schema":{"type":"string"},"description":"Use the `filter` query parameter to retrieve just a subset of a collection.\n"},{"name":"search","in":"query","schema":{"type":"string"},"description":"Use the `search` query parameter to restrict the results of a request to match a search criterion.\n"},{"name":"orderby","in":"query","schema":{"type":"string"},"description":"Use the `orderby` query parameter to specify the sort order of the items returned from server. \nThe default order is ascending order.\n"},{"name":"skip","in":"query","schema":{"type":"integer","format":"int32","minimum":0,"default":0},"description":"Use the `skip` query parameter to set the number of items to skip at the start of a collection.\n"},{"name":"top","in":"query","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":100},"description":"Use the `top` query parameter to specify the page size of the result set.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","format":"int64","minimum":0,"description":"Total number of resource.\n"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference server.\n"},"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of conference server.\n"},"enabled":{"type":"boolean","default":true,"description":"The activate status or deactivated status.\n"},"type":{"type":"string","enum":["INTERNAL","EXTERNAL"],"readOnly":true,"description":"Every PortSIP PBX has a built-in conference server marked as `INTERNAL`; \nNewly added conference servers will be marked as \"EXTERNAL\".\n"},"ipv4":{"type":"string","description":"Host IPV4 address.\n"},"ipv6":{"type":"string","description":"Host IPV6 address.\n"},"max_rooms":{"type":"integer","format":"int32","minimum":0,"description":"The maximum number of rooms for conference server.\n"},"max_participants":{"type":"integer","format":"int32","minimum":0,"description":"The maximum number of participants for conference server.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Create a conference server
> Create a conference server. \
> Please note that: at least one of ipv4 or ipv6 must be specified.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_servers":{"post":{"tags":["Conference"],"operationId":"createConferenceServer","summary":"Create a conference server","description":"Create a conference server. \nPlease note that: at least one of ipv4 or ipv6 must be specified.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of conference server.\n"},"enabled":{"type":"boolean","default":true,"description":"The activate status or deactivated status.\n"},"ipv4":{"type":"string","description":"Host IPV4 address.\n"},"ipv6":{"type":"string","description":"Host IPV6 address.\n"},"max_rooms":{"type":"integer","format":"int32","minimum":0,"description":"The maximum number of rooms for conference server.\n"},"max_participants":{"type":"integer","format":"int32","minimum":0,"description":"The maximum number of participants for conference server.\n"}},"required":["name","max_rooms","max_participants"]}}},"description":"Conference room object"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference server.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Retrieve a conference server
> Retrieve a conference server.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_servers/{id}":{"get":{"tags":["Conference"],"operationId":"showConferenceServer","summary":"Retrieve a conference server","description":"Retrieve a conference server.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference server.\n"},"description":"The unique ID of the conference server."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference server.\n"},"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of conference server.\n"},"enabled":{"type":"boolean","default":true,"description":"The activate status or deactivated status.\n"},"type":{"type":"string","enum":["INTERNAL","EXTERNAL"],"readOnly":true,"description":"Every PortSIP PBX has a built-in conference server marked as `INTERNAL`; \nNewly added conference servers will be marked as \"EXTERNAL\".\n"},"ipv4":{"type":"string","description":"Host IPV4 address.\n"},"ipv6":{"type":"string","description":"Host IPV6 address.\n"},"max_rooms":{"type":"integer","format":"int32","minimum":0,"description":"The maximum number of rooms for conference server.\n"},"max_participants":{"type":"integer","format":"int32","minimum":0,"description":"The maximum number of participants for conference server.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Update a conference server
> Update a conference server
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_servers/{id}":{"post":{"tags":["Conference"],"operationId":"updateConferenceServer","summary":"Update a conference server","description":"Update a conference server\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference server.\n"},"description":"The unique ID of the conference server."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","default":true,"description":"The activate status or deactivated status.\n"},"max_rooms":{"type":"integer","format":"int32","minimum":0,"description":"The maximum number of rooms for conference server.\n"},"max_participants":{"type":"integer","format":"int32","minimum":0,"description":"The maximum number of participants for conference server.\n"}}}}},"required":true},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Query conference server status
> Retrieve a conference server's status.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_servers/{id}/status":{"get":{"tags":["Conference"],"operationId":"getConferenceServerStatus","summary":"Query conference server status","description":"Retrieve a conference server's status.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference server.\n"},"description":"The unique ID of the conference server."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","readOnly":true,"properties":{"rooms_count":{"type":"integer","description":"The number of rooms for conference server.\n"},"participants_count":{"type":"integer","description":"The number of participants for conference server.\n"},"cpu_usage":{"type":"integer","description":"CPU usage.\n"},"memory_usage":{"type":"integer","description":"Memory usage.\n"},"status":{"type":"string","enum":["ONLINE","OFFLINE"],"description":"Conference room's status:\n- `ONLINE`: room is online.\n- `OFFLINE`: room is offline.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Delete a conference server
> Delete a conference server
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_servers/{id}/destroy":{"post":{"tags":["Conference"],"operationId":"deleteConferenceServer","summary":"Delete a conference server","description":"Delete a conference server\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference server.\n"},"description":"The unique ID of the conference server."}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid server id supplied"},"404":{"description":"User not found"}}}}}}
```
## List conference rooms
> Retrieve a collection of conference rooms
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms":{"get":{"tags":["Conference"],"operationId":"listConferenceRooms","summary":"List conference rooms","description":"Retrieve a collection of conference rooms\n","parameters":[{"name":"filter","in":"query","schema":{"type":"string"},"description":"Use the `filter` query parameter to retrieve just a subset of a collection.\n"},{"name":"search","in":"query","schema":{"type":"string"},"description":"Use the `search` query parameter to restrict the results of a request to match a search criterion.\n"},{"name":"orderby","in":"query","schema":{"type":"string"},"description":"Use the `orderby` query parameter to specify the sort order of the items returned from server. \nThe default order is ascending order.\n"},{"name":"skip","in":"query","schema":{"type":"integer","format":"int32","minimum":0,"default":0},"description":"Use the `skip` query parameter to set the number of items to skip at the start of a collection.\n"},{"name":"top","in":"query","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":100},"description":"Use the `top` query parameter to specify the page size of the result set.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","format":"int64","minimum":0,"description":"Total number of resource.\n"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"extension_number":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"},"mode":{"type":"string","enum":["AUDIO","VIDEO"],"description":"The conference room mode. \nCan be either: \n- `AUDIO`: audio conference room.\n- `VIDEO`: video conference room.\n"},"control":{"type":"string","enum":["FREE","MASTER"],"default":"FREE","description":"The conference control type. \nCan be either: \n- `FREE`: the free mode. \n- `MASTER`: the master mode.\n"},"height":{"type":"integer","format":"int32","minimum":144,"maximum":1920,"default":720,"description":"The height for video conference room. \nOnly valid in `VIDEO` mode.\n"},"width":{"type":"integer","format":"int32","minimum":144,"maximum":1920,"default":1280,"description":"The width for video conference room. \nOnly valid in `VIDEO` mode.\n"},"bitrate":{"type":"integer","format":"int32","minimum":128,"maximum":10240,"default":1024,"description":"The transmission rate for video conference room. \nOnly valid in `VIDEO` mode.\n"},"framerate":{"type":"integer","minimum":5,"maximum":30,"default":15,"description":"The framerate for video conference room. \nOnly valid in `VIDEO` mode.\n"},"layout":{"type":"string","enum":["LAYOUT0","LAYOUT1","LAYOUT2","LAYOUT3","LAYOUT4","LAYOUT6","LAYOUT9"],"default":"LAYOUT0","description":"The number of grids allowed for video conference room. \nOnly valid in `VIDEO` mode. \nCan be either: \n- LAYOUT0:\n- LAYOUT1:\n- LAYOUT2:\n- LAYOUT3:\n- LAYOUT4:\n- LAYOUT6:\n- LAYOUT9:\n"},"subject":{"type":"string","minLength":1,"maxLength":64,"description":"The subject of conference room.\n"},"language":{"type":"string","description":"BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags).\nA language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags.\nWhen a language tag is comprised of more than one subtag, the subtag values are separated by the \"-\" character.\nYou will most commonly find language tags written with 2 subtags - language and region. For example: en-US.\n"},"capacity":{"type":"integer","format":"int32","minimum":1,"maximum":200,"default":9,"description":"The maximum number of participants allowed in the room.\n"},"admin_pin":{"type":"string","minLength":3,"maxLength":6,"description":"The PIN for admin of the conference room. Only numeric sequences are allowed.\n"},"room_pin":{"type":"string","minLength":3,"maxLength":6,"description":"The PIN for the conference room. Only numeric sequences are allowed.\n"},"enable_recording":{"type":"boolean","default":false,"description":"Whether to enable recording when created.\n"},"enable_prompt":{"type":"boolean","default":true,"description":"Whether to enable voice menu.\n"},"timezone":{"type":"string","description":"The IANA Time Zone names, such as \"Asia/Shanghai\".\n"},"created_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The creation time of conference room.\n"},"scheduled_start_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The scheduled start time of meeting.\n"},"scheduled_end_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The scheduled end time of meeting.\n"},"numbers":{"type":"string","maxLength":128,"description":"Dial from landline/mobile phone to this number.\n"},"internal_invitees":{"type":"array","items":{"allOf":[{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of user.\n"}],"description":"A collection of extension's ID for sending invitation emails.\n"}},"external_invitees":{"type":"string","description":"The invitees to send invitation emails to.\n"},"custom_options":{"type":"string","description":"Some custom configuration options serialized as json string\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Create a conference room
> Create a conference room
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms":{"post":{"tags":["Conference"],"operationId":"createConferenceRoom","summary":"Create a conference room","description":"Create a conference room\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"extension_number":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"},"mode":{"type":"string","enum":["AUDIO","VIDEO"],"description":"The conference room mode. \nCan be either: \n- `AUDIO`: audio conference room.\n- `VIDEO`: video conference room.\n"},"control":{"type":"string","enum":["FREE","MASTER"],"default":"FREE","description":"The conference control type. \nCan be either: \n- `FREE`: the free mode. \n- `MASTER`: the master mode.\n"},"height":{"type":"integer","format":"int32","minimum":144,"maximum":1920,"default":720,"description":"The height for video conference room. \nOnly valid in `VIDEO` mode.\n"},"width":{"type":"integer","format":"int32","minimum":144,"maximum":1920,"default":1280,"description":"The width for video conference room. \nOnly valid in `VIDEO` mode.\n"},"bitrate":{"type":"integer","format":"int32","minimum":128,"maximum":10240,"default":1024,"description":"The transmission rate for video conference room. \nOnly valid in `VIDEO` mode.\n"},"framerate":{"type":"integer","minimum":5,"maximum":30,"default":15,"description":"The framerate for video conference room. \nOnly valid in `VIDEO` mode.\n"},"layout":{"type":"string","enum":["LAYOUT0","LAYOUT1","LAYOUT2","LAYOUT3","LAYOUT4","LAYOUT6","LAYOUT9"],"default":"LAYOUT0","description":"The number of grids allowed for video conference room. \nOnly valid in `VIDEO` mode. \nCan be either: \n- LAYOUT0:\n- LAYOUT1:\n- LAYOUT2:\n- LAYOUT3:\n- LAYOUT4:\n- LAYOUT6:\n- LAYOUT9:\n"},"subject":{"type":"string","minLength":1,"maxLength":64,"description":"The subject of conference room.\n"},"language":{"type":"string","description":"BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags).\nA language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags.\nWhen a language tag is comprised of more than one subtag, the subtag values are separated by the \"-\" character.\nYou will most commonly find language tags written with 2 subtags - language and region. For example: en-US.\n"},"capacity":{"type":"integer","format":"int32","minimum":1,"maximum":200,"default":9,"description":"The maximum number of participants allowed in the room.\n"},"admin_pin":{"type":"string","minLength":3,"maxLength":6,"description":"The PIN for admin of the conference room. Only numeric sequences are allowed.\n"},"room_pin":{"type":"string","minLength":3,"maxLength":6,"description":"The PIN for the conference room. Only numeric sequences are allowed.\n"},"enable_recording":{"type":"boolean","default":false,"description":"Whether to enable recording when created.\n"},"enable_prompt":{"type":"boolean","default":true,"description":"Whether to enable voice menu.\n"},"timezone":{"type":"string","description":"The IANA Time Zone names, such as \"Asia/Shanghai\".\n"},"scheduled_start_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The scheduled start time of meeting.\n"},"scheduled_end_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The scheduled end time of meeting.\n"},"numbers":{"type":"string","maxLength":128,"description":"Dial from landline/mobile phone to this number.\n"},"internal_invitees":{"type":"array","items":{"allOf":[{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of user.\n"}],"description":"A collection of extension's ID for sending invitation emails.\n"}},"external_invitees":{"type":"string","description":"The invitees to send invitation emails to.\n"},"outbound_caller_ids":{"type":"array","items":{"type":"object","properties":{"provider_id":{"allOf":[{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of trunk.\n"}],"description":"The unique ID of trunk.\n"},"caller_id":{"allOf":[{"type":"string","minLength":1,"maxLength":64,"description":"Outbound caller id.\n"}],"description":"The caller ID.\n"},"description":{"type":"string","maxLength":1024,"description":"The descriptive information about this outbound caller id.\n"}}},"description":"A collection of outbound caller IDs.\n"},"custom_options":{"type":"string","description":"Some custom configuration options serialized as json string\n"}},"required":["mode","extension_number","subject","capacity"]}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Retrieve a conference room
> Retrieve a conference room.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}":{"get":{"tags":["Conference"],"operationId":"getConferenceRoom","summary":"Retrieve a conference room","description":"Retrieve a conference room.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"extension_number":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"},"mode":{"type":"string","enum":["AUDIO","VIDEO"],"description":"The conference room mode. \nCan be either: \n- `AUDIO`: audio conference room.\n- `VIDEO`: video conference room.\n"},"control":{"type":"string","enum":["FREE","MASTER"],"default":"FREE","description":"The conference control type. \nCan be either: \n- `FREE`: the free mode. \n- `MASTER`: the master mode.\n"},"height":{"type":"integer","format":"int32","minimum":144,"maximum":1920,"default":720,"description":"The height for video conference room. \nOnly valid in `VIDEO` mode.\n"},"width":{"type":"integer","format":"int32","minimum":144,"maximum":1920,"default":1280,"description":"The width for video conference room. \nOnly valid in `VIDEO` mode.\n"},"bitrate":{"type":"integer","format":"int32","minimum":128,"maximum":10240,"default":1024,"description":"The transmission rate for video conference room. \nOnly valid in `VIDEO` mode.\n"},"framerate":{"type":"integer","minimum":5,"maximum":30,"default":15,"description":"The framerate for video conference room. \nOnly valid in `VIDEO` mode.\n"},"layout":{"type":"string","enum":["LAYOUT0","LAYOUT1","LAYOUT2","LAYOUT3","LAYOUT4","LAYOUT6","LAYOUT9"],"default":"LAYOUT0","description":"The number of grids allowed for video conference room. \nOnly valid in `VIDEO` mode. \nCan be either: \n- LAYOUT0:\n- LAYOUT1:\n- LAYOUT2:\n- LAYOUT3:\n- LAYOUT4:\n- LAYOUT6:\n- LAYOUT9:\n"},"subject":{"type":"string","minLength":1,"maxLength":64,"description":"The subject of conference room.\n"},"language":{"type":"string","description":"BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags).\nA language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags.\nWhen a language tag is comprised of more than one subtag, the subtag values are separated by the \"-\" character.\nYou will most commonly find language tags written with 2 subtags - language and region. For example: en-US.\n"},"capacity":{"type":"integer","format":"int32","minimum":1,"maximum":200,"default":9,"description":"The maximum number of participants allowed in the room.\n"},"admin_pin":{"type":"string","minLength":3,"maxLength":6,"description":"The PIN for admin of the conference room. Only numeric sequences are allowed.\n"},"room_pin":{"type":"string","minLength":3,"maxLength":6,"description":"The PIN for the conference room. Only numeric sequences are allowed.\n"},"enable_recording":{"type":"boolean","default":false,"description":"Whether to enable recording when created.\n"},"enable_prompt":{"type":"boolean","default":true,"description":"Whether to enable voice menu.\n"},"timezone":{"type":"string","description":"The IANA Time Zone names, such as \"Asia/Shanghai\".\n"},"created_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The creation time of conference room.\n"},"scheduled_start_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The scheduled start time of meeting.\n"},"scheduled_end_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The scheduled end time of meeting.\n"},"numbers":{"type":"string","maxLength":128,"description":"Dial from landline/mobile phone to this number.\n"},"internal_invitees":{"type":"array","items":{"allOf":[{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of user.\n"}],"description":"A collection of extension's ID for sending invitation emails.\n"}},"external_invitees":{"type":"string","description":"The invitees to send invitation emails to.\n"},"domain":{"type":"string","minLength":1,"maxLength":280,"description":"The SIP domain of tenant. \nIt is usually a fully qualified domain name (FQDN).\nIf there is no FQDN, you can also use the IP address of the PBX server as the SIP domain.\nThe SIP domain name is only used for SIP message authentication and does not require analysis.\n"},"sbc_host":{"type":"string","description":"The SBC domain.\n"},"sbc_port":{"allOf":[{"type":"integer","format":"int32","minimum":0,"maximum":65535,"description":"A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535.\nFor TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port\n"}],"default":8883,"description":"The SBC web port fot https.\n"},"token":{"type":"string","description":"Access token to be passed as a header\n"},"outbound_caller_ids":{"type":"array","items":{"type":"object","properties":{"provider_id":{"allOf":[{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of trunk.\n"}],"description":"The unique ID of trunk.\n"},"caller_id":{"allOf":[{"type":"string","minLength":1,"maxLength":64,"description":"Outbound caller id.\n"}],"description":"The caller ID.\n"},"description":{"type":"string","maxLength":1024,"description":"The descriptive information about this outbound caller id.\n"}}},"description":"A collection of outbound caller IDs.\n"},"custom_options":{"type":"string","description":"Some custom configuration options serialized as json string\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Update a conference room
> Update a conference room
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}":{"post":{"tags":["Conference"],"operationId":"updateConferenceRoom","summary":"Update a conference room","description":"Update a conference room\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"control":{"type":"string","enum":["FREE","MASTER"],"default":"FREE","description":"The conference control type. \nCan be either: \n- `FREE`: the free mode. \n- `MASTER`: the master mode.\n"},"height":{"type":"integer","format":"int32","minimum":144,"maximum":1920,"default":720,"description":"The height for video conference room. \nOnly valid in `VIDEO` mode.\n"},"width":{"type":"integer","format":"int32","minimum":144,"maximum":1920,"default":1280,"description":"The width for video conference room. \nOnly valid in `VIDEO` mode.\n"},"bitrate":{"type":"integer","format":"int32","minimum":128,"maximum":10240,"default":1024,"description":"The transmission rate for video conference room. \nOnly valid in `VIDEO` mode.\n"},"framerate":{"type":"integer","minimum":5,"maximum":30,"default":15,"description":"The framerate for video conference room. \nOnly valid in `VIDEO` mode.\n"},"layout":{"type":"string","enum":["LAYOUT0","LAYOUT1","LAYOUT2","LAYOUT3","LAYOUT4","LAYOUT6","LAYOUT9"],"default":"LAYOUT0","description":"The number of grids allowed for video conference room. \nOnly valid in `VIDEO` mode. \nCan be either: \n- LAYOUT0:\n- LAYOUT1:\n- LAYOUT2:\n- LAYOUT3:\n- LAYOUT4:\n- LAYOUT6:\n- LAYOUT9:\n"},"subject":{"type":"string","minLength":1,"maxLength":64,"description":"The subject of conference room.\n"},"language":{"type":"string","description":"BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags).\nA language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags.\nWhen a language tag is comprised of more than one subtag, the subtag values are separated by the \"-\" character.\nYou will most commonly find language tags written with 2 subtags - language and region. For example: en-US.\n"},"capacity":{"type":"integer","format":"int32","minimum":1,"maximum":200,"default":9,"description":"The maximum number of participants allowed in the room.\n"},"admin_pin":{"type":"string","minLength":3,"maxLength":6,"description":"The PIN for admin of the conference room. Only numeric sequences are allowed.\n"},"room_pin":{"type":"string","minLength":3,"maxLength":6,"description":"The PIN for the conference room. Only numeric sequences are allowed.\n"},"enable_prompt":{"type":"boolean","default":true,"description":"Whether to enable voice menu.\n"},"timezone":{"type":"string","description":"The IANA Time Zone names, such as \"Asia/Shanghai\".\n"},"scheduled_start_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The scheduled start time of meeting.\n"},"scheduled_end_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The scheduled end time of meeting.\n"},"numbers":{"type":"string","maxLength":128,"description":"Dial from landline/mobile phone to this number.\n"},"internal_invitees":{"type":"array","items":{"allOf":[{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of user.\n"}],"description":"A collection of extension's ID for sending invitation emails.\n"}},"external_invitees":{"type":"string","description":"The invitees to send invitation emails to.\n"},"outbound_caller_ids":{"type":"array","items":{"type":"object","properties":{"provider_id":{"allOf":[{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of trunk.\n"}],"description":"The unique ID of trunk.\n"},"caller_id":{"allOf":[{"type":"string","minLength":1,"maxLength":64,"description":"Outbound caller id.\n"}],"description":"The caller ID.\n"},"description":{"type":"string","maxLength":1024,"description":"The descriptive information about this outbound caller id.\n"}}},"description":"A collection of outbound caller IDs.\n"},"custom_options":{"type":"string","description":"Some custom configuration options serialized as json string\n"}}}}}},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Delete a conference room
> Destroy a conference room
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/destroy":{"post":{"tags":["Conference"],"operationId":"deleteConferenceRoom","summary":"Delete a conference room","description":"Destroy a conference room\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid username supplied"},"404":{"description":"Not found"}}}}}}
```
## Query conference room's status
> Query conference room's status by it's unique ID.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/status":{"get":{"tags":["Conference"],"operationId":"getConferenceRoomStatus","summary":"Query conference room's status","description":"Query conference room's status by it's unique ID.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ONLINE","OFFLINE","ON_CALL"],"description":"The conference room status.\nCan be either: \n- `ONLINE`:\n- `OFFLINE`:\n- `ON_CALL`:\n"},"locked":{"type":"boolean","description":"Whether the conference room was locked.\n"},"muted":{"type":"boolean","description":"Whether the conference room was muted.\n"},"recording":{"type":"boolean","description":"Whether the conference room is recording.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Mute conference room
> Mute conference room.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/mute":{"post":{"tags":["Conference"],"operationId":"muteConferenceRoom","summary":"Mute conference room","description":"Mute conference room.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."}],"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Unmute conference room
> Unmute conference room by it's unique ID.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/unmute":{"post":{"tags":["Conference"],"operationId":"unmuteConferenceRoom","summary":"Unmute conference room","description":"Unmute conference room by it's unique ID.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."}],"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Lock conference room
> Lock conference room by it's unique ID.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/lock":{"post":{"tags":["Conference"],"operationId":"lockConferenceRoom","summary":"Lock conference room","description":"Lock conference room by it's unique ID.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."}],"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Unlock conference room
> Unlock conference room by it's unique ID.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/unlock":{"post":{"tags":["Conference"],"operationId":"unlockConferenceRoom","summary":"Unlock conference room","description":"Unlock conference room by it's unique ID.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."}],"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Start recording in conference room
> Start recording in conference room.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/start_recording":{"post":{"tags":["Conference"],"operationId":"startRecordingInConferenceRoom","summary":"Start recording in conference room","description":"Start recording in conference room.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."}],"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Stop recording in conference room
> Stop recording in conference room.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/stop_recording":{"post":{"tags":["Conference"],"operationId":"stopRecordingInConferenceRoom","summary":"Stop recording in conference room","description":"Stop recording in conference room.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."}],"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## List room participants
> Retrieve a collection of conference room participants.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/participants":{"get":{"tags":["Conference"],"operationId":"listConferenceRoomParticipants","summary":"List room participants","description":"Retrieve a collection of conference room participants.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of conference room."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room participant.\n"},"display_name":{"type":"string","description":"The display name of conference room participant.\n"},"muted":{"type":"boolean","description":"Whether the participant is muted.\n"},"chairman":{"type":"boolean","description":"Indicates whether the user is chairman of the conference room.\n"},"position":{"type":"integer","format":"int32","minimum":-1,"maximum":8,"description":"The position of room member. \nThe member will not be displayed when *-1* is specified.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Update conference room participant layout
> Update conference room participants layout based on room layout.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/participants/layout":{"post":{"tags":["Conference"],"operationId":"updateConferenceRoomParticipantsLayout","summary":"Update conference room participant layout","description":"Update conference room participants layout based on room layout.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room participant.\n"},"description":"A collection of participant's id.\n"}}}}}},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Get room participant details
> Get room participant details.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/participants/{participant_id}":{"get":{"tags":["Conference"],"operationId":"getConferenceRoomParticipant","summary":"Get room participant details","description":"Get room participant details.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of conference room."},{"name":"participant_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room participant.\n"},"description":"The id of the participant."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room participant.\n"},"display_name":{"type":"string","description":"The display name of conference room participant.\n"},"muted":{"type":"boolean","description":"Whether the participant is muted.\n"},"chairman":{"type":"boolean","description":"Indicates whether the user is chairman of the conference room.\n"},"position":{"type":"integer","format":"int32","minimum":-1,"maximum":8,"description":"The position of room member. \nThe member will not be displayed when *-1* is specified.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Invite as room participant
> Invite an user as conference room participant.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/participants/invite":{"post":{"tags":["Conference"],"operationId":"inviteConferenceRoomParticipant","summary":"Invite as room participant","description":"Invite an user as conference room participant.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string","description":"The number of invited participant.\n"}}}}}},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Mute room participant
> Mute conference room participant.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/participants/{participant_id}/mute":{"post":{"tags":["Conference"],"operationId":"muteConferenceRoomParticipant","summary":"Mute room participant","description":"Mute conference room participant.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."},{"name":"participant_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room participant.\n"},"description":"The id of the participant."}],"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Unmute room participant
> Unmute conference room participant.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/participants/{participant_id}/unmute":{"post":{"tags":["Conference"],"operationId":"unmuteConferenceRoomParticipant","summary":"Unmute room participant","description":"Unmute conference room participant.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."},{"name":"participant_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room participant.\n"},"description":"The id of the participant."}],"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Transfer room ownership
> Transfer room ownership to another participant.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/participants/{participant_id}/chairman":{"post":{"tags":["Conference"],"operationId":"transferConferenceRoomOwnership","summary":"Transfer room ownership","description":"Transfer room ownership to another participant.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of room."},{"name":"participant_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room participant.\n"},"description":"The id of the participant."}],"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Set conference room participant position
> Set conference room participant position.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/participants/{participant_id}/position":{"post":{"tags":["Conference"],"operationId":"setConferenceRoomParticipantPosition","summary":"Set conference room participant position","description":"Set conference room participant position.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."},{"name":"participant_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room participant.\n"},"description":"The id of the participant."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"position":{"type":"integer","format":"int32","minimum":-1,"maximum":8,"description":"The position of room member. \nThe member will not be displayed when *-1* is specified.\n"}}}}}},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Kick out room participant
> Kick out conference room participant.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/participants/{participant_id}/destroy":{"post":{"tags":["Conference"],"operationId":"kickOutConferenceRoomParticipant","summary":"Kick out room participant","description":"Kick out conference room participant.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."},{"name":"participant_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room participant.\n"},"description":"The id of the participant."}],"responses":{"204":{"description":"No Content"},"4XX":{"description":"Error"}}}}}}
```
## List conference recordings
> Retrieve a collection of conference room's recordings.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/recordings":{"get":{"tags":["Conference"],"operationId":"listConferenceRecordings","summary":"List conference recordings","description":"Retrieve a collection of conference room's recordings.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","format":"int64","minimum":0,"description":"Total number of resource.\n"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference recording.\n"},"answered_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Time on which the call is answered.\n"},"ended_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Time on which the call is ended.\n"},"duration":{"type":"integer","format":"int32","description":"The playback time (in seconds).\n"},"file_name":{"type":"string","description":"The name of the file.\n"},"file_size":{"type":"integer","format":"int64","minimum":0,"description":"The file size in bytes.\n"},"file_url":{"type":"string","readOnly":true,"description":"The relative path to file url for file downloading.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Delete a conference record
> Delete a conference recording of conference room.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/recordings/{recording_id}/destroy":{"post":{"tags":["Conference"],"operationId":"deleteConferenceRecording","summary":"Delete a conference record","description":"Delete a conference recording of conference room.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."},{"name":"recording_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference recording.\n"},"description":"The unique ID of the conference room recording."}],"responses":{"204":{"description":"No Content"},"4XX":{"description":"Error"}}}}}}
```
## Update conference recording status to read
> Update conference recording status to read
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/recordings/{recording_id}/set_read":{"post":{"tags":["Conference"],"operationId":"setConferenceRecordingRead","summary":"Update conference recording status to read","description":"Update conference recording status to read\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."},{"name":"recording_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference recording.\n"},"description":"The unique ID of the conference room recording."}],"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Update conference recording status to read
> Update conference recording status to read
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Conference","description":"Manage your conference.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/conference_rooms/{id}/recordings/{recording_id}/set_unread":{"post":{"tags":["Conference"],"operationId":"setConferenceRecordingUnRead","summary":"Update conference recording status to read","description":"Update conference recording status to read\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference room.\n"},"description":"The unique ID of the conference room."},{"name":"recording_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of conference recording.\n"},"description":"The unique ID of the conference room recording."}],"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```