콘텐츠로 이동

목록



GET /api/v1/channel/quick_list

개요

현재 워크스페이스의 채널 간략 정보 및 현재 호출 주체의 구독 상태를 조회합니다.

호출 전 준비 및 사용 단계

대상 워크스페이스에서 이 인터페이스 권한이 있는 API Key로 호출하며, Query 매개변수는 필요하지 않습니다. 결과는 content 배열에 직접 포함되며 페이지네이션되지 않습니다. 기본 채널이 먼저 표시되며, 나머지는 현재 주체의 상단 고정 시간 내림차순으로 정렬한 다음 생성 시간 내림차순으로 정렬됩니다.

요청 헤더

매개변수명 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예: <DF-API-KEY>
획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다.

매개변수 추가 설명

목록에서 반환된 uuid는 이 모듈의 수정, 삭제 및 구독 인터페이스에 직접 사용할 수 있습니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/channel/quick_list' \
  -H 'DF-API-KEY: <DF-API-KEY>'

응답

HTTP 200, application/json입니다. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content array<object> 채널 목록이며, 결과가 없으면 빈 배열입니다.
content[].id integer 데이터베이스 레코드 번호입니다. 채널을 조작하려면 uuid를 사용하십시오.
content[].uuid string 채널 UUID이며, 수정, 삭제 또는 구독에 사용됩니다.
content[].workspaceUUID string 채널이 속한 워크스페이스입니다.
content[].name string 채널 이름입니다. default는 기본 채널을 의미합니다.
content[].description string 채널 설명입니다.
content[].notifyTarget array<string> 해당 채널에 직접 구성된 알림 대상 UUID입니다.
content[].notifyTarget[] string 개별 알림 대상 UUID입니다.
content[].notifyUpgradeCfg object 업그레이드 알림 구성이며, 구성되지 않은 경우 빈 객체입니다.
content[].notifyUpgradeCfg.triggerTime integer 업그레이드 알림을 트리거할 때까지의 대기 시간(단위: 초)입니다.
content[].notifyUpgradeCfg.notifyTarget array<string> 업그레이드 알림 대상 UUID 목록입니다.
content[].notifyUpgradeCfg.notifyTarget[] string 업그레이드 알림 대상 UUID입니다.
content[].status integer 레코드 상태이며 정상은 0입니다.
content[].creator string 생성한 호출 주체입니다.
content[].updator string 최근 업데이트한 주체이며, 업데이트되지 않은 경우 빈 문자열일 수 있습니다.
content[].createAt integer 생성 시간(Unix 초)입니다.
content[].updateAt integer 업데이트 시간(Unix 초)이며, 업데이트되지 않은 경우 -1입니다.
content[].deleteAt integer 삭제 시간(Unix 초)이며, 삭제되지 않은 경우 -1입니다.
content[].pinnedAt integer 현재 호출 주체의 상단 고정 시간(Unix 초)이며, 상단 고정되지 않은 경우 -1입니다.
content[].subscribeType string 현재 주체의 구독 유형: responsible 책임자, participate 참여자, attention 관심자; 구독하지 않았거나 구독을 취소한 경우 빈 문자열입니다.
content[].declaration object 또는 null 워크스페이스의 공개 선언입니다.
{
  "code": 200,
  "content": [
    {
      "id": 42,
      "uuid": "chan_example",
      "workspaceUUID": "wksp_example",
      "name": "生产异常",
      "description": "生产异常协作频道",
      "notifyTarget": [
        "notify_example"
      ],
      "notifyUpgradeCfg": {
        "triggerTime": 300,
        "notifyTarget": [
          "notify_example"
        ]
      },
      "status": 0,
      "creator": "wsak_example",
      "updator": "",
      "createAt": 1785427200,
      "updateAt": -1,
      "deleteAt": -1,
      "pinnedAt": -1,
      "subscribeType": "",
      "declaration": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.

채널이 없으면 성공 시 빈 배열을 반환합니다. 이 인터페이스에는 추가 비즈니스 Query 선언이 없으며, 인증 및 속도 제한 오류는 공통 오류를 참조하십시오.

문서 평가

이 페이지가 도움이 되었나요?