Updated on 2023-09-27 GMT+08:00

Stopping Screen Recording

Prerequisites

  • The agent has signed in.

  • The VRC component has been successfully initialized on the agent side.

  • The agent is recording the screen.

Description

This interface is used to stop screen recording for an agent.

Interface Method

The request method must be set to DELETE. This interface supports only the DELETE method.

URI

https://ip:port/agentgateway/resource/recordplay/{agentid}/stoprecordscreen

In the URL, ip indicates the IP address of the agent gateway server, and port indicates the HTTPS port number of the agent gateway server.

Table 1 Parameter in the URI

No.

Parameter

Data Type

Mandatory (Yes/No)

Description

1

agentid

string

Yes

Agent ID. The value ranges from 101 to 59999.

Method Name in Logs

stopRecordScreen

Request Description

  • Message header

    Table 2 Parameters in the request message header

    No.

    Parameter

    Value Type

    Mandatory (Yes/No)

    Description

    1

    Content-Type

    string

    Yes

    Coding mode of the message body. The default value is application/json; charset=UTF-8.

    2

    Guid

    string

    Yes

    GUID returned by the sign-in interface during static authentication (AUTHMODE is set to 1) or GUID returned by the polling event query interface during dynamic authentication (AUTHMODE is set to 2).

  • Message body

    None

Response Description

Table 3 Parameter description

No.

Parameter

Value Type

Description

1

message

string

Description.

2

retcode

string

Error code. The options are as follows:

  • 0: success
  • Other values: failure

Triggered Event

  • AgentMediaEvent_StopRecordScreen_Succ

  • AgentMediaEvent_StopRecordScreen_Fail

Error Code

  • 100-006

  • 100-007

Example

  • Message header
    Content-Type:application/json; charset=UTF-8
    Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • Request parameter

    None

  • Response parameter
    {
      "result": {},
      "message": "success",
      "retcode": "0"
    }