3Play V3 API API Documentation
Order Live Professional Captioning (Streamless)
POST {{host}}/v3/live_professional_captions/order/?api_key={{api_key}}
Body
PARAM
| Key | Datatype | Required | Description |
api_key
|
string |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status
Curl
curl -X POST 'http://api.3play.com/v3/live_professional_captions/order/?api_key=undefined?api_key=undefined' -F '{"name"=>"media_file_id", "value"=>"10251875", "datatype"=>"number"}=' -F '{"name"=>"start_time", "value"=>"2024-04-11T00:58:10.000-05:00", "datatype"=>"string"}=' -F '{"name"=>"estimated_duration", "value"=>"1800000", "datatype"=>"number"}=' -F '{"name"=>"has_live_stream", "value"=>"false", "datatype"=>"boolean"}=' -F '{"name"=>"meeting_location", "value"=>"https://company.zoom.us/s/1234567", "datatype"=>"string"}=' -F '{"name"=>"static_embed_key_code", "value"=>"cs-513-fall-2023", "datatype"=>"string"}=' -F '{"name"=>"live_event_type", "value"=>"", "datatype"=>"null"}=' -F '{"name"=>"captioner_join_time", "value"=>"2024-02-23T00:58:10-05:00", "datatype"=>"string"}=' -F '{"name"=>"stream_url", "value"=>"https://www.sample-videos.com/video123/mp4/720/big_buck_bunny_720p_1mb.mp4", "datatype"=>"string"}=' -F '{"name"=>"event_wait_time", "value"=>"10", "datatype"=>"number"}=' -F '{"name"=>"event_max_time", "value"=>"60", "datatype"=>"number"}=' -F '{"name"=>"transcoder_id", "value"=>"1", "datatype"=>"number"}=' -F '{"name"=>"latency", "value"=>"2000", "datatype"=>"number"}=' -F '{"name"=>"offensive_words_sensitivity", "value"=>"1", "datatype"=>"number"}=' -F '{"name"=>"stream_reconnection_wait_time", "value"=>"1", "datatype"=>"number"}=' -F '{"name"=>"record_stream", "value"=>"true", "datatype"=>"boolean"}=' -F '{"name"=>"callback", "value"=>"undefined", "datatype"=>"string"}=' -F '{"name"=>"wordlist_file", "value"=>nil, "datatype"=>"null"}=' -F '{"name"=>"fallback_to_automatic_captions", "value"=>"true", "datatype"=>"boolean"}=' -F '{"name"=>"event_description", "value"=>"Test Event", "datatype"=>"string"}=' -F '{"name"=>"speaker_names", "value"=>"[\"Test Speaker\"]", "datatype"=>"string"}=' -F '{"name"=>"additional_instructions", "value"=>"Additional Instructions", "datatype"=>"string"}=' -F '{"name"=>"contact_name", "value"=>"Test Contact", "datatype"=>"string"}=' -F '{"name"=>"contact_email", "value"=>"email@test.com", "datatype"=>"string"}=' -F '{"name"=>"contact_phone_number", "value"=>"00122523354559", "datatype"=>"string"}='
ENDPOINTS