Read video preparation progress for a workspace

GET

https://api.channelautomation.com/api/livechat/video/prepare/{runId}

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

runId
string
required

Query parameters

workspaceId
string
required

Returns

200

Processing, ready or failed

JSON

status
optional
processing
or
ready
or
failed
url
optional
string
path
optional
string
bytes
optional
integer
durationSeconds
optional
number
error
optional
string

400

Invalid workspace or run ID

401

Verified session required

403

Workspace membership required

404

Run not in this workspace or not a video preparation

503

Progress unavailable

Read video preparation progress for a workspace

curl --request GET \
  --url 'https://api.channelautomation.com/api/livechat/video/prepare/<runId>?workspaceId=string' \
  --header 'Authorization: Bearer <token>'

const url = 'https://api.channelautomation.com/api/livechat/video/prepare/<runId>?workspaceId=string';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/livechat/video/prepare/<runId>?workspaceId=string"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "status": "processing",
  "url": "string",
  "path": "string",
  "bytes": 0,
  "durationSeconds": 0,
  "error": "string"
}