Query status
Updated
Queries the current status of a cloud recording task.
https://api.sd-rtn.com/v1/apps/{appid}/cloud_recording/resourceid/{resourceid}/sid/{sid}/mode/{mode}/queryAfter starting a recording, call this endpoint to query its current status.
Note
This endpoint is only valid within an active recording session. If the recording was not started successfully or has already ended, the request returns 404.
Path Parameters
appidstringThe App ID of your project.
- For web page recording mode, enter the App ID for which the cloud recording service is enabled.
- For individual and composite recording modes, use the same App ID as the channel to be recorded. Ensure that the cloud recording service has been enabled for this App ID.
resourceidstringThe resource ID obtained from the acquire endpoint.
sidstringThe recording ID obtained from the start endpoint.
modestringThe recording mode:
individual: Individual recording mode.mix: Composite recording mode.web: Web page recording mode.
Header Parameters
Content-Typestringapplication/json.
Response
-
If the returned status code is
200, the request was successful. -
If the returned status code is not
200, the request failed. See Response status codes for troubleshooting.
Response Body
The request succeeded.
cnamestringThe name of the channel to be recorded.
The name of the channel being recorded.
uidstringThe UID used by the cloud recording service in the RTC channel.
resourceIdstringThe cloud recording resource ID. Valid for five minutes; re-request from acquire if expired.
The resource ID used by cloud recording.
sidstringThe recording ID. Uniquely identifies a recording session. Generated after the cloud recording service starts successfully.
The recording ID, identifying the current recording session.
serverResponseobjectThe recording status. The fields returned vary depending on the recording mode and whether screenshot capture is enabled.
statusintegerCurrent status of the cloud service:
0: Not started.1: Initialization complete.2: Components starting.3: Some components ready.4: All components ready.5: In progress.6: Stop requested.7: All components stopped.8: Exited.20: Exited abnormally.
extensionServiceStatearray<object>State of each extension service. Only returned in web page recording mode.
payloadobjectService-specific state.
fileListarray<object>Files generated during recording. Only returned by web_recorder_service.
filenamestringName of the M3U8 or MP4 file.
sliceStartTimeintegerRecording start time of the file, Unix timestamp in seconds.
onholdbooleanWhether recording is paused. true if paused, false if running. Only returned by web_recorder_service.
statestringUpload status:
"init": Initializing."inProgress": Running."exit": Stopped.
outputsarray<object>CDN push output status. Only returned by rtmp_publish_service.
rtmpUrlstringThe CDN address the stream is being pushed to.
statusstringPush status:
"connecting": Connecting to the CDN server."publishing": Push in progress."onhold": Push paused."disconnected": Failed to connect to the CDN server.
serviceNamestringExtension service name:
"web_recorder_service": Web page recording service."rtmp_publish_service": CDN push service.
sliceStartTimeintegerRecording start time, Unix timestamp in milliseconds. Only returned in individual recording mode.
fileListModestringData format of fileList. Only returned in individual and composite recording modes when screenshot capture is not enabled.
"string": In composite recording mode whenavFileTypeis["hls"]."json": WhenavFileTypeis["hls","mp4"]in individual or composite recording mode.
fileListstring | array<object>The recorded files. Only returned in individual and composite recording modes when screenshot capture is not enabled. When fileListMode is "string", this is the filename of the M3U8 file. When fileListMode is "json", this is an array of objects with the following fields:
fileNamestring(array<object>)Name of the M3U8 or MP4 file.
trackTypestring(array<object>)File type:
"audio": Audio only."video": Video only."audio_and_video": Audio and video.
uidstring(array<object>)The UID whose stream is recorded. In composite recording mode, this is "0".
mixedAllUserboolean(array<object>)true if all users are recorded in a single file; false if each user is recorded separately.
isPlayableboolean(array<object>)true if the file can be played online; false if it cannot.
sliceStartTimeinteger(array<object>)Recording start time of the file, Unix timestamp in seconds.
Response example
{
"cname": "httpClient463224",
"uid": "527841",
"resourceId": "JyvK8nXHuV1BE.....",
"sid": "38f8e3c.....",
"serverResponse": {
"status": 0,
"extensionServiceState": [
{
"payload": {
"fileList": [
{
"filename": "xxx.m3u8",
"sliceStartTime": 0
}
],
"onhold": true,
"state": "inProgress"
},
"serviceName": "web_recorder_service"
}
]
}
}
{
"code": 62,
"reason": "request timeout"
}
Request examples
curl --request GET \ --url https://api.sd-rtn.com/v1/apps/{appid}/cloud_recording/resourceid/{resourceid}/sid/{sid}/mode/{mode}/query \ --header 'Authorization: Basic <credentials>'Response example
{ "resourceId": "string", "sid": "string", "serverResponse": { "status": 0, "extensionServiceState": [ { "payload": { "fileList": [ { "filename": "string", "sliceStartTime": 0 } ], "onhold": true, "state": "string" }, "serviceName": "string" } ] }, "cname": "string", "uid": "string"}