---
title: "协议脚本调试"
method: POST
path: "/api/v1/things/protocol/script/debug"
tags: ["things/protocol/script", "thingsProtocolScript"]
---

# 协议脚本调试

`POST /api/v1/things/protocol/script/debug`

## Request body

- ProtocolScriptDebugReq
  - `triggerDir` integer, required — 1:up 2:down
  - `triggerTimer` integer, required — 收到前处理1:before 2:after
  - `script` string, required — 脚本内容
  - `req` PublishMsg, required
    - `handle` string — 对应 mqtt topic的第一个 thing ota config 等等
    - `type` string — 操作类型 从topic中提取 物模型下就是 property属性 event事件 action行为
    - `payload` string
    - `timestamp` string — 毫秒时间戳
    - `productID` string
    - `deviceName` string
    - `explain` string — 内部使用的拓展字段
    - `protocolCode` string — 如果有该字段则回复的时候也会带上该字段
  - `resp` PublishMsg
    - `handle` string — 对应 mqtt topic的第一个 thing ota config 等等
    - `type` string — 操作类型 从topic中提取 物模型下就是 property属性 event事件 action行为
    - `payload` string
    - `timestamp` string — 毫秒时间戳
    - `productID` string
    - `deviceName` string
    - `explain` string — 内部使用的拓展字段
    - `protocolCode` string — 如果有该字段则回复的时候也会带上该字段

## Response `200`

A successful response.

- object
  - `code` integer
  - `msg` string
  - `data` ProtocolScriptDebugResp
    - `out` PublishMsg, required
      - `handle` string — 对应 mqtt topic的第一个 thing ota config 等等
      - `type` string — 操作类型 从topic中提取 物模型下就是 property属性 event事件 action行为
      - `payload` string
      - `timestamp` string — 毫秒时间戳
      - `productID` string
      - `deviceName` string
      - `explain` string — 内部使用的拓展字段
      - `protocolCode` string — 如果有该字段则回复的时候也会带上该字段
    - `logs` string[], required

## Changes

- **2025-03-14** `e87dbcac5d9e` — 2 breaking
  - removed the request body
  - removed the media type `application/json` for the response with the status `200`

[Change history](https://skmtc.dev/unitedrhino/apis/things-api/changes/api/v1/things/protocol/script/debug/post.md)

---

[API](https://skmtc.dev/unitedrhino/apis/things-api.md) · [All operations](https://skmtc.dev/unitedrhino/apis/things-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/unitedrhino/things-api/revisions/8ab379ffc97b/schema)