Caption Control API
The Caption Control API provides users with complete control over the captions being generated in Verbit. It allows users to retrieve session information and manage various aspects of the session, including upstream control, caption placement, changing connection plan templates, session duration extension, and ending a session immediately.
Key Features
- Session Information: Retrieve full details of a specific session, including session ID, name, status, customer details, user details, scheduling information, and the current state.
- Upstream Control: Manage whether captions are sent or blocked during a session.
- Caption Placement: Set the placement of captions on the screen, including options like top, bottom, or middle.
- Connection Plan Template: Change the connection plan template for a session.
- Session Extension: Extend the duration of an existing session.
- End Session: End the session immediately.
Important Note
The Caption Control API capabilities are relevant only for connection plan template sessions.
Authentication
Authentication details for using Verbit's API are already outlined in the Authentication page. Please refer to that page for comprehensive instructions.
Note: Only users associated with the customer who ordered the session, or admins, can access session details and control the session. Unauthorized users will not have access to these capabilities.
Updated 13 days ago