controlLocationPTZ: PTZ positioning

Function details

PTZ positioning interface.

Note: PTZ related functions require the device to have a PT or PTZ PTZ capability set

Request address

https://openapi-[DataCenter].easy4ip.com/openapi/controlLocationPTZ

Minimum permissions required for sub-account token request

"Permission":"Ptz" "Resource":"cam:serial number:channel number"

Incoming parameter description

Parameter name	Parameter type	Required or not	Legal value	Parameter description
token	String	Yes		Administrator or sub-account accessToken
deviceId	String	Yes		Device serial number
channelId	String	Yes		Channel ID
h	Double	Yes	Take [-1,1]	Horizontal operation parameters
v	Double	Yes	Take [-1,1]	Vertical operation parameters
z	Double	Yes	Take [0,1] where 0 means shrink to the smallest, 1 means to maximize	Zoom parameter

Sample input

{
    "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
    "system":{
        "ver":"1.0",
        "appId":"lcdxxxxxxxxx",
        "sign":"74bc756ebd53e9eef2836f8cf1730c10",
        "time":1599031074,
        "nonce":"8ec8a7bd1d1c95420de20d92422d457d"
    },
    "params":{
        "token":"At_00006acr3456d12312d3grf60147de7ec",
        "deviceId":"TESTQWERXXXX",
        "channelId":"0",
        "h":0.5,
        "v":0.5,
        "z":0
    }
}

Return data field description

No data returned

Sample output

{
  "result":{
    "msg":"The operation was successful.",
    "code":"0"
  },
  "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af"
}