Read sampled rooms, participants, tracks, dispatches and watch coverage
GET
cookie
vg_session<token>The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.
orgId*stringAuthorised orgId; the server must verify organisation/project ownership before any read.
Length
1 <= lengthprojectId*stringAuthorised projectId; the server must verify organisation/project ownership before any read.
Length
1 <= lengthAuthorised read result. Null means unreported, never zero. Source-specific coverage limits remain visible.
application/json- response
source*stringserver*|nullrooms*array<>windows*array<>sipTrunks*sourceStatus?How fresh a sampled read is. Present when the worker samples the layer; a layer never read successfully answers 503 source_unavailable instead.
Example Request
curl -X GET 'https://example.com/api/v1/org/string/project/string/media-server'Example Response
{ "source": "string", "server": { "edition": "string", "version": "string", "protocol": 0, "region": "string", "nodeId": "string", "joinMs": 0, "url": "string" }, "rooms": [ { "sid": "string", "name": "string", "createdAt": "2019-08-24T14:15:22Z", "firstSeenAt": "2019-08-24T14:15:22Z", "lastSeenAt": "2019-08-24T14:15:22Z", "settings": { "emptyTimeout": 0, "departureTimeout": 0, "maxParticipants": 0, "codecs": [ "string" ], "egressRecording": true }, "dispatches": [ { "id": "string", "agentName": "string", "createdAt": "2019-08-24T14:15:22Z", "jobs": [ { "id": "string", "status": "string", "statuses": [ { "at": "2019-08-24T14:15:22Z", "status": "string" } ], "startedAt": "2019-08-24T14:15:22Z", "workerId": "string", "agentId": "string", "recording": true } ] } ], "participants": [ { "sid": "string", "kind": "string", "region": "string", "joinedAt": "2019-08-24T14:15:22Z", "agentName": "string", "firstSeenAt": "2019-08-24T14:15:22Z", "lastSeenAt": "2019-08-24T14:15:22Z", "states": [ { "at": "2019-08-24T14:15:22Z", "state": "string" } ], "permission": { "canPublish": true, "canSubscribe": true, "canPublishData": true, "hidden": true, "agent": true }, "tracks": [ { "sid": "string", "name": "string", "type": "string", "source": "string", "mime": "string", "versionAt": "2019-08-24T14:15:22Z", "muted": true, "stereo": true, "dtx": true, "red": true, "encryption": "string", "features": [ "string" ] } ], "audioTracks": 0, "sip": { "trunkId": "string", "ruleId": "string", "invitedAt": "2019-08-24T14:15:22Z", "trunkNumber": "string", "twilio": true, "statuses": [ { "at": "2019-08-24T14:15:22Z", "status": "string" } ] } } ], "recording": { "callRoom": "string", "url": "string", "durationS": 0, "startedAt": "2019-08-24T14:15:22Z", "id": "string" } } ], "windows": [ { "start": "2019-08-24T14:15:22Z", "end": "2019-08-24T14:15:22Z", "everySeconds": 0, "detail": true } ], "sipTrunks": { "property1": { "name": "string", "direction": "string", "mediaEncryption": "string", "krispEnabled": true, "numbers": 0, "auth": true, "source": "string" }, "property2": { "name": "string", "direction": "string", "mediaEncryption": "string", "krispEnabled": true, "numbers": 0, "auth": true, "source": "string" } }, "sourceStatus": { "lastReadAt": "2019-08-24T14:15:22Z", "lastGoodReadAt": "2019-08-24T14:15:22Z", "errorClass": "unauthenticated" }}Was this page helpful?