구독¶
POST /api/v1/channel/{channel_uuid}/subscribe
개요¶
현재 API 호출 주체의 채널 구독 유형을 설정하거나 취소합니다.
호출 전 및 사용 단계¶
채널 간략 목록에서 대상 UUID를 가져옵니다. type은 responsible, participate, attention 또는 cancel 중에서 선택합니다. 하나의 주체는 동일한 채널에서 하나의 유형만 저장되며, 이후 설정이 기존 유형을 덮어씁니다. 작업은 현재 호출 주체를 대상으로 하며, true가 반환된 후 목록의 subscribeType으로 확인할 수 있습니다.
라우트 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| channel_uuid | string | Y | 현재 워크스페이스의 채널 UUID입니다. 예: chan_example가져오기 또는 입력 방법: 채널 간략 목록의 content[].uuid에서 가져옵니다. |
요청 헤더¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| type | string | Y | responsible 담당자, participate 참여자, attention 팔로워, cancel 구독 취소입니다. null 허용: False 선택 가능 값: ['responsible', 'participate', 'attention', 'cancel'] 예: attention가져오기 또는 입력 방법: 실제 협업 역할에 따라 선택하며, 구독 취소 시 cancel을 사용합니다. |
파라미터 추가 설명¶
취소 후 목록에서 반환되는 subscribeType은 빈 문자열입니다. 다른 API Key 또는 주체를 사용하면 구독 상태가 다를 수 있습니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/channel/chan_example/subscribe' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"type":"attention"}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | boolean | 구독 유형이 저장되면 true입니다. |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반한 경우 | 파라미터 파싱 실패 | 파라미터 위치, 필드명, 유형 및 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않은 경우 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아닌 경우 | 일부 json 파일 형식 오류 | 단일 JSON 객체를 전달합니다. |
| 404 | ft.NotFoundChannel | 대상 채널이 존재하지 않거나, 삭제되었거나, 현재 워크스페이스에 속하지 않은 경우 | 지정한 채널을 찾을 수 없습니다 | 채널 간략 목록에서 유효한 UUID를 다시 가져옵니다. |