获取订阅列表 - 伙伴云OpenAPI

请求参数

Header 参数

Open-Authorization

string

必需

授权的 API Key

默认值:

Bearer {{API_KEY}}

Body 参数application/json

source_id

string

订阅的对象ID

可选

source_type

string

订阅的对象类型

可选

目前仅支持“table”表格

limit

integer

每页条数

可选

默认 20 条，最大 100 条

offset

integer

分页偏移量

可选

默认为 0

示例

{
  "source_id": "{{TABLE_ID}}",
  "source_type": "table"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.huoban.com/openapi/v1/event/list' \
--header 'Open-Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "source_id": "",
    "source_type": "table"
}'

返回响应

🟢200成功

application/json

Body

code

integer

错误码

必需

0 为成功，小于 10000 为系统异常，其他为业务异常

message

string

错误信息

必需

具体的错误原因，code 为 0 时返回“success”

data

object

返回数据

必需

返回具体数据的结构

total

integer

必需

subscribes

array[object (订阅) {4}]

必需

meta

object

元数据

必需

用来描述返回数据原始信息

trace_id

string

请求ID

必需

每次请求接口会返回唯一的ID

示例

{
  "code": 0,
  "message": "success",
  "data": {
    "total": 1,
    "subscribes": [
      {
        "source_id": "2100000014303340",
        "source_type": "table",
        "events": [
          "item.update",
          "item.create"
        ],
        "state": 1
      }
    ]
  },
  "meta": {
    "trace_id": "1652588571980470"
  }
}