The ProCONF Admin Dashboard server is used to handle Admin-level functionality, like get/set configuration, get server statistics. Getter setter API for session details, participant's details. All the APIs are built using REST conventions. They use many standard HTTP features, including methods (POST, GET, PUT, DELETE) and error response codes. All responses return standard JSON.
Version: 1.0
Authentication
/api/login
POST
Description
This api is used to authenticate the user with username and password, Once verified, it will return the JWT token.
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Invalid credentials |
/api/logout
POST
Description
This api is used to logout the user.
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Not authorized |
Security
| Security Schema | Scopes |
|---|
| bearerAuth | |
/api/token
POST
Description
This api returns the JWT token with configuration details for the given room and participant name.
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Server error |
SDK
/api/configuration
POST
Description
This api is used to get the configuration details in the features key.
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Not authorized |
Security
| Security Schema | Scopes |
|---|
| bearerAuth | |
GET
Description
This api is used to get the configuration details.
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Not authorized |
Security
| Security Schema | Scopes |
|---|
| bearerAuth | |
PUT
Description
This api is used to update the configuration details.
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Not authorized |
Security
| Security Schema | Scopes |
|---|
| bearerAuth | |
/api/meetings
GET
Description
This api is used to get the all-session list that has ended.
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Not authorized |
/api/proconf-token
POST
Description
This api is used to get the ProCONF token. This token is used to join the meeting.
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Not authorized |
/api/meeting-time
GET
Description
This api is used to get the max meeting time in seconds.
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Not authorized |
/api/call-summary/{room_name}
GET
Description
This api is used to get the S3 file url which contains a call summary.
Parameters
| Name | Located in | Description | Required | Schema |
|---|
| room_name | path | | Yes | string |
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Not authorized |
/api/call-catchup/{room_name}
GET
Description
This api is used to get call catch up summary of the running meeting.
Parameters
| Name | Located in | Description | Required | Schema |
|---|
| room_name | path | | Yes | string |
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Not authorized |
/api/call-status/{room_name}
GET
Description
This api is used to get the current call status. Like transcript and recording status.
Parameters
| Name | Located in | Description | Required | Schema |
|---|
| room_name | path | | Yes | string |
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Not authorized |
Configuration
/api/configuration
POST
Description
This api is used to get the configuration details in the features key.
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Not authorized |
Security
| Security Schema | Scopes |
|---|
| bearerAuth | |
GET
Description
This api is used to get the configuration details.
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Not authorized |
Security
| Security Schema | Scopes |
|---|
| bearerAuth | |
PUT
Description
This api is used to update the configuration details.
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Not authorized |
Security
| Security Schema | Scopes |
|---|
| bearerAuth | |
Dashboard
/api/statistics
GET
Description
This api is used to get the statistics details.
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Not authorized |
Security
| Security Schema | Scopes |
|---|
| bearerAuth | |
/api/instances
GET
Description
This api is used to get the media server and turn server details.
Responses
| Code | Description |
|---|
| 200 | Successful response |
| 401 | Not authorized |
Security
| Security Schema | Scopes |
|---|
| bearerAuth | |