삭제¶
POST /api/v1/channel/{channel_uuid}/delete
개요¶
지정된 채널을 삭제하고 구독 및 에스컬레이션 트리거 설정을 정리합니다.
호출 전 및 사용 단계¶
먼저 채널 간단 목록에서 삭제할 UUID를 확인합니다. 성공하면 채널이 목록에서 제거되며, 구독 및 연결된 참조, 에스컬레이션 트리거 설정도 정리됩니다. 기본 채널은 삭제할 수 없습니다. 이미 존재하지 않는 채널을 반복해서 삭제해도 여전히 true를 성공적으로 반환할 수 있습니다.
경로 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| channel_uuid | string | Y | 현재 워크스페이스의 채널 UUID입니다. 예시: chan_example가져오기 또는 입력 방법: 채널 간단 목록의 content[].uuid에서 가져옵니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
파라미터 추가 설명¶
이 POST에는 요청 본문이 필요하지 않습니다. 호출 시간 초과 후에는 먼저 목록을 확인하여 대상이 여전히 존재하는지 확인합니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/channel/chan_example/delete' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | boolean | 삭제 처리가 성공하면 true입니다. |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 400 | ft.ForbidDeleteDefaultChannel | 기본 채널 default 삭제 시도 | 기본 채널 삭제 금지 | 기본 채널을 유지하고 실제로 삭제해야 하는 사용자 지정 채널을 선택합니다. |