API Interface List

This topic provides a summary list of Yeastar Workplace API interfaces.

Authentication

Function HTTP method API endpoint
Get an Access Token POST /services/openapi/v1.0/authentication/get_token
Refresh an Access Token POST /services/openapi/v1.0/authentication/refresh_token

Meeting Room

Function HTTP method API endpoint
Query Multiple Meeting Rooms GET /services/openapi/v1.0/room/room_list
Query a Specific Meeting Room GET /services/openapi/v1.0/room/room_detail/{roomId}
Create a Meeting Room POST /services/openapi/v1.0/room/room_create
Update a Meeting Room PUT /services/openapi/v1.0/room/room_update
Delete a Meeting Room DELETE /services/openapi/v1.0/room/room_delete/{roomId}

Meeting Schedule

Function HTTP method API endpoint
Query Multiple Meetings GET /services/openapi/v1.0/room/meeting_list
Query a Specific Meetings GET /services/openapi/v1.0/room/meeting_detail
Create a Meeting POST /services/openapi/v1.0/room/meeting_create
Update a meeting PUT

/services/openapi/v1.0/room/meeting_update

Check In to a Meeting POST /services/openapi/v1.0/room/check_in
Extend a meeting POST /services/openapi/v1.0/room/extend
End a Meeting POST /services/openapi/v1.0/room/end
Delete a Meeting DELETE /services/openapi/v1.0/room/meeting_delete

User

Function HTTP method API endpoint
Query Multiple Users GET /services/openapi/v1.0/user/user_list
Query a Specific User GET /services/openapi/v1.0/user/user_detail/{memberId}
Download a User's Face Image GET /services/openapi/v1.0/user/user_image/{memberId}
Create a User POST /services/openapi/v1.0/user/user_create
Update a User PUT /services/openapi/v1.0/user/user_update
Delete a User DELETE /services/openapi/v1.0/user/user_remove/{memberId}

User group

Function HTTP method API endpoint
Query Multiple User Groups GET /services/openapi/v1.0/user/group_list
Query a Specific User Group GET /services/openapi/v1.0/user/group_detail/{groupId}
Create a User Group POST /services/openapi/v1.0/user/group_create
Update a user group PUT /services/openapi/v1.0/user/group_update
Delete a User Group DELETE /services/openapi/v1.0/user/group_delete/{groupId}

Smart device

Function HTTP method API endpoint
Query Meeting Room Access Permission POST /services/openapi/v1.0/device/open_door

Event subscription

Function HTTP method API endpoint
Subscribe to Events POST /services/openapi/v1.0/integration/subscribe
Cancel Event Subscriptions DELETE /services/openapi/v1.0/integration/cancel_subscribe