Domain name for API request: iss.intl.tencentcloudapi.com.
Used for device channel panning control, including turn, zoom scale, zoom, and aperture.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ControlDevicePTZ. |
| Version | Yes | String | Common Params. The value used for this API: 2023-05-17. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ChannelId | Yes | String | Channel ID (obtain from the channel query API DescribeDeviceChannel) |
| Type | Yes | String | Command type (up, down, left, right). Upper left: leftup, upper right: rightup, lower left: leftdown, lower right: rightdown Zoom in: zoom in, zoom out: zoom out Focus far: focusfar, focus near: focusnear Iris in: enlarge aperture, iris out: shrink aperture) |
| Speed | Yes | Integer | Command description (speed range: 1-8) |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ControlDevicePTZ
<Common request parameters>
{
"ChannelId": "12345678-abcd-efgh-ijkl-1234567890abcd",
"Type": "left",
"Speed": 1
}{
"Response": {
"RequestId": "e2fb0bfd-4484-4a2e-8ed9-b4e0ebd0c4aa"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.DeviceResponseTimeOut | timeout for the device |
| FailedOperation.DeviceResultTimeOut | timeout for the device response |
| InvalidParameterValue | Invalid parameter value |
| InvalidParameterValue.InvalidChannelId | Invalid channel ID |
| InvalidParameterValue.UnSupportedAccessType | Unsupported access type |
| InvalidParameterValue.UnSupportedPTZCMD | Unsupported gimbal control command. |
| InvalidParameterValue.UnSupportedScaleParam | Unsupported playback speed parameter |
| ResourceNotFound | Resource does not exist. |
| ResourceUnavailable.ChannelOffline | Channel offline |
| ResourceUnavailable.DevDisable | Device disabled |
| ResourceUnavailable.DevNoRegister | Device not registered. |
| ResourceUnavailable.DevOffline | Device offline |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback