---
title: "获取自定义协议详情"
method: POST
path: "/api/v1/things/protocol/info/read"
tags: ["things/protocol/info", "thingsProtocolInfo"]
---

# 获取自定义协议详情

`POST /api/v1/things/protocol/info/read`

## Request body

- WithIDOrCode
  - `code` string
  - `id` integer — id

## Response `200`

A successful response.

- object
  - `code` integer
  - `data` ProtocolInfo
    - `code` string — iThings,iThings-thingsboard,wumei,aliyun,huaweiyun,tuya
    - `configFields` ProtocolConfigField[] — 配置字段列表,没有可以不传
      - `group` string, required
      - `id` integer, required
      - `isRequired` boolean, required
      - `key` string, required
      - `label` string, required
      - `sort` integer, required
    - `configInfos` ProtocolConfigInfo[] — 配置列表
      - `config` object, required
      - `desc` string, required
      - `id` integer, required
    - `desc` string
    - `deviceFields` ProtocolConfigField[] — 设备级的配置字段列表,没有可以不传
      - `group` string, required
      - `id` integer, required
      - `isRequired` boolean, required
      - `key` string, required
      - `label` string, required
      - `sort` integer, required
    - `endpoints` string[]
    - `etcdKey` string
    - `id` integer
    - `isEnableSyncDevice` integer, required — 是否支持主动同步设备信息
    - `isEnableSyncProduct` integer, required — 是否支持主动同步产品信息
    - `name` string
    - `productFields` ProtocolConfigField[] — 产品级的配置字段列表,没有可以不传
      - `group` string, required
      - `id` integer, required
      - `isRequired` boolean, required
      - `key` string, required
      - `label` string, required
      - `sort` integer, required
    - `transProtocol` string — 传输协议: mqtt,tcp,udp
    - `type` string — 协议类型: 普通设备(默认):normal 音视频:media
  - `msg` string

---

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