목록 조회¶
GET /api/v1/issue/notification_policy/list
개요¶
현재 워크스페이스의 삭제되지 않은 알림 정책과 연관된 일정, 채널 및 계정 정보를 페이지네이션으로 조회합니다.
호출 전 및 사용 단계¶
기본값은 pageIndex=1, pageSize=10이며, 최종 업데이트 시간 기준 내림차순으로 정렬합니다. 아직 업데이트되지 않은 정책은 생성 시간으로 비교합니다. 목록에는 활성화 및 비활성화된 정책이 포함되며 status로 구분합니다. 정책 배열은 content.data에, 페이지 정보는 최상위 pageInfo에 있습니다. 저장 후 반환된 uuid는 상세 조회, 수정 또는 삭제에 사용합니다. 정책은 콘솔에서 대상 채널에 연결하고 유효한 알림 일정에 연결해야 합니다. 실제 수신자는 일정의 시간대, 당일 시간대, 유효 기간, 순환 및 알림 대상에 따라 결정됩니다. 정책 저장 자체만으로는 테스트 알림이 즉시 발송되지 않습니다.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다. |
Query 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| pageIndex | integer | 페이지 번호, 기본값 1, 최소 1. null 허용: False $minValue: 1 예: 1획득 또는 입력 방법: 1부터 페이지를 하나씩 증가시키며 검색 조건을 동일하게 유지합니다. |
|
| pageSize | integer | 페이지당 항목 수, 기본값 10. null 허용: False $maxValue: 100 $minValue: 1 예: 10획득 또는 입력 방법: 필요에 따라 1~100의 정수를 입력합니다. |
|
| search | string | 선택적 이름 부분 검색이며, 서버에서 앞뒤 공백을 제거합니다. null을 전달하지 마세요. null 허용: True 예: 生产획득 또는 입력 방법: 정책 이름의 일부 텍스트를 입력합니다. 생략하거나 빈 문자열이면 필터링하지 않습니다. |
파라미터 추가 설명¶
반환된 연관 일정 설정은 현재 시점의 실제 수신자 명단이 아닙니다. 실제 대상은 일정의 유효 기간, 시간대 및 순환에 따라 추가로 계산해야 합니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/issue/notification_policy/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=10
응답¶
HTTP 200, application/json입니다. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.data | array<object> |
현재 페이지의 정책이며, 결과가 없으면 []입니다. |
| content.data[].id | integer | 저장된 정책의 레코드 번호이며, 작업에는 uuid를 사용합니다. |
| content.data[].uuid | string | 알림 정책 UUID이며, inpy_로 시작합니다. |
| content.data[].workspaceUUID | string | 소속 워크스페이스 UUID입니다. |
| content.data[].name | string | 정책 이름입니다. |
| content.data[].status | integer | 레코드 상태이며 0은 활성화, 2는 비활성화, 3은 삭제입니다. 목록에는 삭제되지 않은 활성화 및 비활성화 정책이 포함됩니다. |
| content.data[].creator | string | 생성 호출 주체입니다. |
| content.data[].updator | string | 최근 업데이트 주체이며, 업데이트되지 않은 경우 빈 문자열입니다. |
| content.data[].createAt | integer | 생성 시간, Unix 초입니다. |
| content.data[].updateAt | integer | 업데이트 시간, Unix 초이며, 업데이트되지 않은 경우 -1입니다. |
| content.data[].deleteAt | integer | 삭제 시간, Unix 초이며, 삭제되지 않은 경우 -1입니다. |
| content.data[].extend | object | 저장된 알림 범위 및 에스컬레이션 규칙이며 {}일 수 있습니다. |
| content.data[].extend.notifyTypes | array<string> |
활성화된 액션 유형입니다. |
| content.data[].extend.notifyTypes[] | string | 단일 액션 유형이며, 구체적인 역할은 파라미터 표를 참조하세요. |
| content.data[].extend.upgradeCfg | object | 트리거 유형별로 저장된 규칙입니다. |
| content.data[].extend.upgradeCfg.noManager | object | Issue 생성 시 유효한 담당자가 없어 담당자 없음 후보로 진입하고 상태가 Open/Working/Pending인 경우, Issue 생성 시점부터 대기합니다. 기존 Issue는 담당자만 제거해도 후보로 다시 진입하는 것이 보장되지 않습니다. 양의 정수 초 단위로 60의 배수를 입력합니다. 활성화 유형은 issueUpgrade.noManager이며, 설정되지 않은 경우 생략됩니다. |
| content.data[].extend.upgradeCfg.noManager.duration | integer | 최초 대기 시간(초)입니다. |
| content.data[].extend.upgradeCfg.noManager.notifyType | string | once 또는 cycle이며, 이 값이 저장되지 않은 경우 once로 간주합니다. |
| content.data[].extend.upgradeCfg.noManager.cycleDuration | integer | 순환 간격(초)이며 cycle 모드에서 사용합니다. |
| content.data[].extend.upgradeCfg.noManager.cycleTimes | integer | 순환 트리거 총 횟수 상한이며 1~30이고 최초 트리거를 포함합니다. |
| content.data[].extend.upgradeCfg.processTimeout | object | Issue가 Open/Working 상태로 지속적으로 미완료된 시간입니다. 최초에는 생성 시점부터 타이머를 시작합니다. Pending/Resolved/Closed에서 처리 상태로 다시 진입하면 재진입 후 상태가 기록된 시점부터 타이머를 시작합니다. 활성화 유형은 issueUpgrade.processTimeout이며, 설정되지 않은 경우 생략됩니다. |
| content.data[].extend.upgradeCfg.processTimeout.duration | integer | 최초 대기 시간(초)입니다. |
| content.data[].extend.upgradeCfg.processTimeout.notifyType | string | once 또는 cycle이며, 이 값이 저장되지 않은 경우 once로 간주합니다. |
| content.data[].extend.upgradeCfg.processTimeout.cycleDuration | integer | 순환 간격(초)이며 cycle 모드에서 사용합니다. |
| content.data[].extend.upgradeCfg.processTimeout.cycleTimes | integer | 순환 트리거 총 횟수 상한이며 1~30이고 최초 트리거를 포함합니다. |
| content.data[].extend.upgradeCfg.openProcessTimeout | object | Issue가 Open 상태를 유지할 때만 적용되며, 마지막 상태 변경 시점부터 타이머를 시작합니다. 상태 기록이 없으면 생성 시간부터 타이머를 시작합니다. 활성화 유형은 issueUpgrade.processTimeout이며, 설정되지 않은 경우 생략됩니다. |
| content.data[].extend.upgradeCfg.openProcessTimeout.duration | integer | 최초 대기 시간(초)입니다. |
| content.data[].extend.upgradeCfg.openProcessTimeout.notifyType | string | once 또는 cycle이며, 이 값이 저장되지 않은 경우 once로 간주합니다. |
| content.data[].extend.upgradeCfg.openProcessTimeout.cycleDuration | integer | 순환 간격(초)이며 cycle 모드에서 사용합니다. |
| content.data[].extend.upgradeCfg.openProcessTimeout.cycleTimes | integer | 순환 트리거 총 횟수 상한이며 1~30이고 최초 트리거를 포함합니다. |
| content.data[].extend.upgradeCfg.eventStorm | object | Issue에 기록된 eventCount가 exceedTimes를 엄격히 초과하면 트리거됩니다. Open/Working 상태로 제한하지 않으며, 완료된 Issue도 수량 조건을 충족할 수 있습니다. 활성화 유형은 issueUpgrade.eventStorm이며, 설정되지 않은 경우 생략됩니다. |
| content.data[].extend.upgradeCfg.eventStorm.exceedTimes | integer | 수량 임계값이며 eventCount가 이를 엄격히 초과해야 트리거됩니다. |
| content.data[].extend.upgradeCfg.eventStorm.notifyType | string | once 또는 cycle이며, 이 값이 저장되지 않은 경우 once로 간주합니다. |
| content.data[].extend.upgradeCfg.eventStorm.cycleDuration | integer | 순환 간격(초)이며 cycle 모드에서 사용합니다. |
| content.data[].extend.upgradeCfg.eventStorm.cycleTimes | integer | 순환 트리거 총 횟수 상한이며 1~30이고 최초 트리거를 포함합니다. |
| content.data[].extend.其他字段 | JSON | 소스에서 저장된 기타 확장 필드이며, 모두가 알림 동작을 제어할 수 있는 것은 아닙니다. |
| content.data[].relNotificationScheduleInfos | array<object> |
연결된 유효 일정 객체입니다. 목록에는 서식화된 유효 기간이 추가로 포함되며, 상세 조회에는 원시 일정 설정만 포함됩니다. |
| content.data[].relNotificationScheduleInfos[].id | integer | 데이터베이스 레코드 번호이며, 일정 작업에는 uuid를 사용합니다. |
| content.data[].relNotificationScheduleInfos[].uuid | string | 일정 UUID이며, 조회, 수정, 삭제 및 알림 정책 참조에 사용됩니다. |
| content.data[].relNotificationScheduleInfos[].workspaceUUID | string | 소속 워크스페이스 UUID입니다. |
| content.data[].relNotificationScheduleInfos[].name | string | 일정 이름입니다. |
| content.data[].relNotificationScheduleInfos[].timezone | string | 이 일정에서 당일 시간대와 적용 날짜를 해석하는 데 사용하는 IANA 시간대입니다. |
| content.data[].relNotificationScheduleInfos[].start | string | 당일 시작 시각 HH:MM입니다. |
| content.data[].relNotificationScheduleInfos[].end | string | 당일 종료 시각 HH:MM이며, 종료 분의 마지막 초까지 유효합니다. |
| content.data[].relNotificationScheduleInfos[].notifyTargets | array<string> |
순서대로 저장된 구성원, 알림 대상 UUID 또는 이메일입니다. |
| content.data[].relNotificationScheduleInfos[].notifyTargets[] | string | acnt_ 계정, notify_ 알림 대상 또는 이메일 문자열입니다. |
| content.data[].relNotificationScheduleInfos[].extend | object | 확장 설정이며, 설정되지 않은 경우 {}일 수 있습니다. |
| content.data[].relNotificationScheduleInfos[].extend.enableRotateNotification | boolean | 순환 사용 여부이며, 기본값은 false로 간주합니다. |
| content.data[].relNotificationScheduleInfos[].extend.rotationCycle | string | 순환 사용 시 주기: day는 일별, week는 월요일 기준 주별, month는 자연월, workDay는 근무일만 일별, weekend는 주말만 일별입니다. 공휴일은 인식하지 않으며, 설정되지 않은 경우 생략할 수 있습니다. |
| content.data[].relNotificationScheduleInfos[].extend.effectiveTime | object | 전체 유효 기간이며, 설정되지 않은 경우 생략할 수 있습니다. |
| content.data[].relNotificationScheduleInfos[].extend.effectiveTime.start | integer | 유효 기간 시작 Unix 초이며, 0 또는 생략 시 제한하지 않습니다. |
| content.data[].relNotificationScheduleInfos[].extend.effectiveTime.end | integer | 유효 기간 종료 Unix 초이며, 0 또는 생략 시 제한하지 않습니다. |
| content.data[].relNotificationScheduleInfos[].rotationUpdateAt | integer | 순환 계산의 시작 시간(Unix 초)입니다. 순환 관련 설정을 변경하면 재설정됩니다. |
| content.data[].relNotificationScheduleInfos[].status | integer | 레코드 상태이며 활성 레코드는 0입니다. |
| content.data[].relNotificationScheduleInfos[].creator | string | 생성 호출 주체입니다. |
| content.data[].relNotificationScheduleInfos[].updator | string | 최근 업데이트 주체이며, 업데이트되지 않은 경우 빈 문자열입니다. |
| content.data[].relNotificationScheduleInfos[].createAt | integer | 생성 시간, Unix 초입니다. |
| content.data[].relNotificationScheduleInfos[].updateAt | integer | 업데이트 시간, Unix 초이며, 업데이트되지 않은 경우 -1입니다. |
| content.data[].relNotificationScheduleInfos[].deleteAt | integer | 삭제 시간, Unix 초이며, 삭제되지 않은 경우 -1입니다. |
| content.data[].relChannelInfos | array<object> |
이 정책을 참조하는 채널 객체입니다. |
| content.data[].relChannelInfos[].id | integer | 채널 레코드 번호입니다. |
| content.data[].relChannelInfos[].uuid | string | 채널 UUID이며, 수정, 삭제 또는 구독에 사용합니다. |
| content.data[].relChannelInfos[].workspaceUUID | string | 채널이 속한 워크스페이스입니다. |
| content.data[].relChannelInfos[].name | string | 채널 이름입니다. default는 기본 채널을 의미합니다. |
| content.data[].relChannelInfos[].description | string | 채널 설명입니다. |
| content.data[].relChannelInfos[].notifyTarget | array<string> |
이 채널에 직접 설정된 알림 대상 UUID입니다. |
| content.data[].relChannelInfos[].notifyTarget[] | string | 단일 알림 대상 UUID입니다. |
| content.data[].relChannelInfos[].notifyUpgradeCfg | object | 에스컬레이션 알림 설정이며, 설정되지 않은 경우 빈 객체입니다. |
| content.data[].relChannelInfos[].notifyUpgradeCfg.triggerTime | integer | 에스컬레이션 알림을 트리거할 때까지의 대기 시간(초)입니다. |
| content.data[].relChannelInfos[].notifyUpgradeCfg.notifyTarget | array<string> |
에스컬레이션 알림 대상 UUID 목록입니다. |
| content.data[].relChannelInfos[].notifyUpgradeCfg.notifyTarget[] | string | 에스컬레이션 알림 대상 UUID입니다. |
| content.data[].relChannelInfos[].status | integer | 레코드 상태이며 정상은 0입니다. |
| content.data[].relChannelInfos[].creator | string | 생성 호출 주체입니다. |
| content.data[].relChannelInfos[].updator | string | 최근 업데이트 주체이며, 업데이트되지 않은 경우 빈 문자열일 수 있습니다. |
| content.data[].relChannelInfos[].createAt | integer | 생성 시간, Unix 초입니다. |
| content.data[].relChannelInfos[].updateAt | integer | 업데이트 시간, Unix 초이며, 업데이트되지 않은 경우 -1입니다. |
| content.data[].relChannelInfos[].deleteAt | integer | 삭제 시간, Unix 초이며, 삭제되지 않은 경우 -1입니다. |
| content.data[].relNotificationScheduleInfos[].effectiveTimeInfos | object | 목록에서 보충된 일정 전체 유효 기간 표시 정보입니다. |
| content.data[].relNotificationScheduleInfos[].effectiveTimeInfos.timeStr | string | 서식화된 유효 기간이며 빈 문자열일 수 있습니다. |
| content.data[].relNotificationScheduleInfos[].effectiveTimeInfos.expired | boolean | 전체 유효 기간이 종료되었는지 여부입니다. |
| content.data[].creatorInfo | object 또는 null | 생성/업데이트 주체의 확인 가능한 계정 정보입니다. API Key는 자연인 구성원이 아니므로 목록에서는 null을 반환할 수 있고, 상세 조회에서는 빈 객체일 수 있습니다. 다음 필드는 주체에 따라 선택적으로 제공됩니다. |
| content.data[].creatorInfo.id | integer | 계정 레코드 번호입니다. |
| content.data[].creatorInfo.uuid | string | 계정 UUID입니다. |
| content.data[].creatorInfo.name | string | 계정 이름입니다. |
| content.data[].creatorInfo.username | string | 로그인 이름입니다. |
| content.data[].creatorInfo.email | string | 계정 이메일입니다. |
| content.data[].creatorInfo.source | string | 계정 소스입니다. |
| content.data[].creatorInfo.userIconUrl | string | 아바타 URL입니다. |
| content.data[].creatorInfo.exterId | string | 외부 신원 식별자입니다. |
| content.data[].creatorInfo.mobile | string | 휴대폰 번호입니다. |
| content.data[].creatorInfo.countryCode | string | 국가/지역 코드입니다. |
| content.data[].creatorInfo.namespace | string | 신원 네임스페이스입니다. |
| content.data[].creatorInfo.attributes | object 또는 array | 소스에서 제공한 계정 속성입니다. |
| content.data[].creatorInfo.attributes.自定义字段 | JSON | 신원 소스에서 정의한 속성입니다. |
| content.data[].creatorInfo.customAttributes | object 또는 array | 사용자 정의 계정 속성입니다. |
| content.data[].creatorInfo.customAttributes.自定义字段 | JSON | 사용자 정의 계정 속성 값입니다. |
| content.data[].creatorInfo.acntWsNickname | string | 워크스페이스 닉네임입니다. |
| content.data[].creatorInfo.defaultWebhook | object | 일부 에이전트 계정의 기본 Webhook 정보이며 생략할 수 있습니다. |
| content.data[].creatorInfo.defaultWebhook.自定义字段 | JSON | 계정 소스에 따라 설정된 Webhook 필드입니다. |
| content.data[].updatorInfo | object 또는 null | 생성/업데이트 주체의 확인 가능한 계정 정보입니다. API Key는 자연인 구성원이 아니므로 목록에서는 null을 반환할 수 있고, 상세 조회에서는 빈 객체일 수 있습니다. 다음 필드는 주체에 따라 선택적으로 제공됩니다. |
| content.data[].updatorInfo.id | integer | 계정 레코드 번호입니다. |
| content.data[].updatorInfo.uuid | string | 계정 UUID입니다. |
| content.data[].updatorInfo.name | string | 계정 이름입니다. |
| content.data[].updatorInfo.username | string | 로그인 이름입니다. |
| content.data[].updatorInfo.email | string | 계정 이메일입니다. |
| content.data[].updatorInfo.source | string | 계정 소스입니다. |
| content.data[].updatorInfo.userIconUrl | string | 아바타 URL입니다. |
| content.data[].updatorInfo.exterId | string | 외부 신원 식별자입니다. |
| content.data[].updatorInfo.mobile | string | 휴대폰 번호입니다. |
| content.data[].updatorInfo.countryCode | string | 국가/지역 코드입니다. |
| content.data[].updatorInfo.namespace | string | 신원 네임스페이스입니다. |
| content.data[].updatorInfo.attributes | object 또는 array | 소스에서 제공한 계정 속성입니다. |
| content.data[].updatorInfo.attributes.自定义字段 | JSON | 신원 소스에서 정의한 속성입니다. |
| content.data[].updatorInfo.customAttributes | object 또는 array | 사용자 정의 계정 속성입니다. |
| content.data[].updatorInfo.customAttributes.自定义字段 | JSON | 사용자 정의 계정 속성 값입니다. |
| content.data[].updatorInfo.acntWsNickname | string | 워크스페이스 닉네임입니다. |
| content.data[].updatorInfo.defaultWebhook | object | 일부 에이전트 계정의 기본 Webhook 정보이며 생략할 수 있습니다. |
| content.data[].updatorInfo.defaultWebhook.自定义字段 | JSON | 계정 소스에 따라 설정된 Webhook 필드입니다. |
| content.declaration | object 또는 null | 워크스페이스 공통 선언입니다. |
| pageInfo | object | 최상위 페이지 정보입니다. |
| pageInfo.pageIndex | integer | 페이지 번호입니다. |
| pageInfo.pageSize | integer | 페이지 크기입니다. |
| pageInfo.count | integer | 현재 페이지의 실제 수량입니다. |
| pageInfo.totalCount | integer | 일치하는 정책의 총 개수입니다. |
{
"code": 200,
"content": {
"data": [
{
"id": 42,
"uuid": "inpy_example",
"workspaceUUID": "wksp_example",
"name": "生产异常通知",
"extend": {
"notifyTypes": [
"issue.add",
"issue.modify",
"issueReply.add",
"issueUpgrade.noManager",
"issueUpgrade.processTimeout",
"issueUpgrade.eventStorm"
],
"upgradeCfg": {
"noManager": {
"duration": 600,
"notifyType": "once"
},
"processTimeout": {
"duration": 1800,
"notifyType": "cycle",
"cycleDuration": 600,
"cycleTimes": 3
},
"openProcessTimeout": {
"duration": 900,
"notifyType": "once"
},
"eventStorm": {
"exceedTimes": 60,
"notifyType": "once"
}
}
},
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785430800,
"updateAt": -1,
"deleteAt": -1,
"relNotificationScheduleInfos": [],
"relChannelInfos": [],
"creatorInfo": null,
"updatorInfo": null
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 10,
"count": 1,
"totalCount": 1
}
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 | 매개변수 파싱 실패 | 매개변수 위치, 필드 이름, 유형 및 값을 확인하세요. |
| 500 | ft.InternalServerError | 정책 또는 연관 정보 읽기 실패 | 내부 오류 | 잠시 후 다시 시도하세요. 계속 실패하면 traceId를 제공하세요. |