开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
    • 按设备类型浏览
    • 设备能力
      • 通用方法
        • 能力使用
        • device.capability.list(查询可用能力)
        • device.property.get(批量读配置)
        • device.property.set(批量写配置)
        • device.service.invoke(调用一次动作)
      • 侦测与告警
      • 图像
      • 云台
      • 灯光
      • 录像
      • 音频
      • 媒体
      • 网络
      • 电源
      • 隐私
      • 呼叫
      • 存储
      • 系统
      • 算法
      • 设备维护
      • 控制
    • 事件总览
    • 权限码
    • 错误码
    • 告警与能力消息
    • 常见问题
    • 历史能力与推送类型
  • API 参考
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
功能详情
请求地址
最小权限
传入参数说明
样例输入
返回 data 字段说明
样例输出
错误码

device.service.invoke(调用一次动作)

device.service.invoke:调用一次动作

功能详情

调用一个动作。没有持久状态,调一次执行一次,不幂等。超时不代表未执行。填完整 serviceId。动作走本接口,不走 device.property.set。

云台移动填 ptz.aim.relative。入参见 云台。

请求地址

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.service.invoke

最小权限

管理员操作自己绑定的设备不需要权限。操作被分享设备需要该动作所属能力的权限,例如云台动作需要云台权限。子用户绑定不需要。子账号需要该动作所属能力的权限码,例如云台动作为 Ptz。

传入参数说明

参数名参数类型是否必填默认值合法值参数说明
tokenString是管理员、子用户或子账号 accessToken
deviceIdString是设备序列号
productIdString否可省略。传了且与该设备实际型号不一致 → DV2009
channelIdString条件通道号,IPC 常见 "0"。不要传 -1通道级动作必填,设备级不要传
serviceIdString是整段 serviceId,如 ptz.aim.relative一次只调一个服务
inputDataObject条件device.capability.list(或该 serviceId 能力页)返回的 inputData 项中的 field当上述 inputData 数组非空时必填;无入参传 {}。速度类字段常为字符串,例如 "0.5",不要传数字

公共请求字段与签名见 签名约定 与 公共请求负载。

样例输入

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTIPC000012345",
 "channelId": "0",
 "serviceId": "ptz.aim.relative",
 "inputData": {
 "horizontal": "0.5",
 "vertical": "0",
 "zoom": "0",
 "duration": 1000
 }
 }
}

返回 data 字段说明

参数名参数类型参数说明
outputDataObject返回。无出参为 {}。有出参时字段见能力目录该项,例如 ptz.cruise.get

样例输出

无出参时(如 ptz.aim.relative):

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "outputData": {}
 }
 }
}

有出参时(ptz.cruise.get,inputData 传 {}):

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "outputData": {
 "cruiseModel": "1",
 "collection": [
 {
 "name": "门口",
 "stayTime": "15"
 }
 ],
 "cruises": [
 {
 "beginTime": "08:00:00",
 "endTime": "18:00:00",
 "period": "1111100"
 }
 ]
 }
 }
 }
}

错误码

本接口可能返回下列码。

错误码错误码说明下一步
SN1001签名校验异常按 HTTP 开发规范 核对 sign
TK1002token 无效或过期重新获取 accessToken
OP1002缺少必填参数补必填字段
OP1003参数不合法按本页参数表核对
OP1009权限不足核对 token 与设备绑定/分享权限
OP1013接口总次数超限降低调用频率
OP1014接口日限额超限见 接口调用限额
DV1007设备离线等设备上线

更多见 错误码 · OP/SN/TK。

错误码错误码说明下一步
DV2003设备未声明该能力以 device.capability.list 为准
DV2007channelId 与 scope 不符通道级必传,设备级不传
DV2008同请求混用设备级与通道级拆分请求
DV2009productId 与型号不一致省略或改为实际型号
DV2011无能力权限见 权限码

更多见 能力错误码。

device.property.set(批量写配置)
detection.arming.enabled(获取布撤防开关属性)