Query Conference Password

Query the participants password or moderator password of a specific scheduled conference.

Request URL

GET {base_url}/{api_path}/conference/viewpassword?access_token={access_token}

Request parameters

Parameter Required Type Description
id Yes Integer The ID of a scheduled conference.
Note: You can query conference ID using Search Specific Scheduled Conferences.
type Yes String Password type.
Valid value:
  • partic_password: Participant password.
  • moderator_password: Moderator password.

Response parameters

Table 1.
Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
password String The queried password.

Examples

Request example

GET /openapi/v1.0/conference/viewpassword?id=1&access_token=eoyIdaFRYbXUQ0KuP2BGH9ICYbxDgCYf&type=moderator_password HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "password": "75437"
}