Screenshot: imagecapture

Description

In the H5 video call scenario, this interface is invoked for agents to take a screenshot of users.

Interface Method

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

URI

https://ip:port/agentgateway/resource/mediacall/{agentid}/imagecapture

In the URL, ip indicates the IP address of the CC-Gateway server, and port indicates the HTTPS port number of the CC-Gateway server.

Method Name in Logs

imageCapture

Request Description

• Message header

  Table 2 Parameters in the request message header

  No.	Parameter	Value Type	Mandatory (Yes/No)	Description
  1	Content-Type	String	True	Coding mode of the message body. The default value is application/json; charset=UTF-8.
  2	Guid	String	True	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

  Table 3 Parameters in the message body

  No.	Parameter	Value Type	Mandatory (Yes/No)	Description
  1	userType	String	True	Subscriber type. The default value is user, indicating a user.
  2	callid	String	True	Call ID.

Response Description

Triggered Event

• Screenshot event (AgentEvent_ImageCapture)

Error Code

• 106-011
• 106-015
• 100-007

Example

• Message header

  Content-Type:application/json; charset=UTF-8
  Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1

• Request parameter

  {
  "callid":"1552524689-16797284",
  "userType":"user"
  }

• Response parameter

  {
      "message": "success",
      "retcode": "0"
  }