목록¶
GET /api/v1/notification_schedule/list
개요¶
현재 워크스페이스의 알림 일정을 조회하거나 날짜별로 알림 대상 캘린더를 확인합니다.
호출 전 및 사용 단계¶
일반 목록은 content.data를 읽고 최상위 pageInfo에서 페이지를 넘깁니다. 캘린더 조회는 scheduleCalendar=true와 scDateRange를 반드시 전달해야 하며, 페이지네이션을 사용하지 않고 페이지 번호 매개변수를 무시합니다. 현재 일광 절약 시간 전환을 가로지르는 여러 날 범위는 종료일이 누락될 수 있습니다. 해당 시간대에서 일별로 나누어 조회한 뒤 병합하면 날짜 범위를 보장할 수 있으며, UTC로 직접 변환하여 비즈니스 날짜 기준을 바꾸지 마십시오. 일정은 최근 업데이트 또는 생성 시간 내림차순으로 정렬됩니다. 알림 대상 목록, 워크스페이스 멤버 목록을 사용하여 대상 필터를 준비할 수 있습니다. 연결 정책 필터는 연결된 일정이 전혀 없을 때 다른 일정이 반환되는 제한이 있으므로, 호출 후 issueNotificationPolicyInfos를 확인해야 하며 필터 조건을 연결 존재의 증거로 간주해서는 안 됩니다.
요청 헤더¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다. |
Query 요청 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| issueNotificationPolicyUUIDs | commaArray | 연결된 알림 정책으로 필터링합니다. 현재 선택한 정책에 일정 연결이 전혀 없으면 적용되지 않을 수 있으므로 각 항목의 연결 결과를 확인해야 합니다. null 허용: False 예: inpy_example획득 또는 입력 방법: 알림 정책 목록의 uuid에서 가져오며, 여러 개는 영문 쉼표로 연결합니다. |
|
| mySchedule | string | 문자열 true/false, 기본값 false. API Key는 wsak 신원에 해당하며 특정 자연인을 대표할 수 없습니다. 특정 멤버를 조회하려면 notifyTargets를 사용하십시오. null 허용: True 선택 가능한 값: ['true', 'false'] 예: false획득 또는 입력 방법: 현재 호출 신원에 연결된 일정을 조회하려면 true, 전체를 조회하려면 false를 입력합니다. |
|
| notificationScheduleUUIDs | commaArray | 쉼표로 구분된 일정 UUID 문자열로, 이 워크스페이스의 대상 일정을 필터링합니다. null 허용: False 예: nsche_example획득 또는 입력 방법: 일정 목록의 content.data[].uuid에서 가져오며, 여러 개는 영문 쉼표로 연결합니다. |
|
| notifyTargets | commaArray | 쉼표로 구분된 문자열이며, 대상 중 하나라도 일치하면 선택됩니다. JSON 배열을 전달할 수 없습니다. null 허용: False 예: notify_example획득 또는 입력 방법: 멤버는 워크스페이스 멤버 목록의 계정 UUID에서, 알림 대상은 알림 대상 목록의 uuid에서 가져오거나 유효한 이메일을 입력합니다. 모두 문자열이어야 합니다. 여러 개는 영문 쉼표로 연결합니다. |
|
| pageIndex | integer | 일반 목록 페이지 번호, 기본값 1, 최소 1; 캘린더 분기에서는 무시됩니다. null 허용: False $minValue: 1 예: 1획득 또는 입력 방법: 첫 페이지는 1이며, 호출할 때마다 1씩 증가합니다. |
|
| pageSize | integer | 일반 목록의 페이지당 개수, 기본값 10; 캘린더 분기에서는 무시됩니다. null 허용: False $maxValue: 100 $minValue: 1 예: 10획득 또는 입력 방법: 읽기 요구에 따라 1~100 사이로 입력합니다. |
|
| scDateRange | string | 캘린더 모드에서 실제로 필수이며, YYYY/MM/DD~YYYY/MM/DD, 최대 50개 날짜, 자동으로 당일로 기본 설정되지 않습니다. 캘린더 날짜 기준으로 양 끝을 포함하는 것을 전제로 합니다. 현재 일광 절약 시간 전환을 가로지르면 종료일이 누락될 수 있으므로 일별로 나누어 조회한 뒤 병합하는 것이 좋습니다. 빈 문자열 허용: False null 허용: False 최대 길이: 48 예: 2026/11/18~2026/11/19획득 또는 입력 방법: 선택한 시간대의 캘린더 날짜로 입력하며, 시작일과 종료일을 모두 포함하는 것을 전제로 합니다. 일광 절약 시간 전환을 가로지르는 경우 일별 조회로 범위를 보장하십시오. |
|
| scTimezone | string | 캘린더 분기에서만 사용되며 기본값은 Asia/Shanghai입니다. null 허용: False 최대 길이: 48 예: Asia/Shanghai획득 또는 입력 방법: 캘린더 날짜를 표시하려는 IANA 시간대로 입력합니다. |
|
| scheduleCalendar | string | 문자열 true/false, 기본값 false. 캘린더 모드에서는 scDateRange를 함께 전달해야 하며 페이지네이션을 사용하지 않습니다. null 허용: True 선택 가능한 값: ['true', 'false'] 예: false획득 또는 입력 방법: 일반 목록은 false, 캘린더 보기는 true를 입력합니다. |
|
| search | string | 이름으로 부분 검색하며, 생략하면 빈 문자열로 필터링하지 않습니다. null 허용: True 예: 生产획득 또는 입력 방법: 일정 이름 키워드를 입력합니다. |
매개변수 추가 설명¶
mySchedule=true는 현재 API 호출 신원을 대상으로 합니다. 사람별로 찾으려면 멤버 계정 UUID를 notifyTargets에 전달하십시오. 캘린더는 날짜 기준으로 계산되므로 현재 HH:MM 시점에 온콜 중인지 판단하는 데 사용할 수 없습니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/notification_schedule/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=10
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | object | 일반 페이지네이션 또는 캘린더 결과 객체이며, scheduleCalendar에 따라 구조가 선택됩니다. |
| content.data | array<object> |
일반 분기의 현재 페이지 일정이며, 빈 목록은 []입니다. |
| content.data[].id | integer | 데이터베이스 레코드 번호입니다. 일정 작업에는 uuid를 사용하십시오. |
| content.data[].uuid | string | 일정 UUID이며, 조회, 수정, 삭제 및 알림 정책 참조에 사용됩니다. |
| content.data[].workspaceUUID | string | 소속 워크스페이스 UUID입니다. |
| content.data[].name | string | 일정 이름입니다. |
| content.data[].timezone | string | 이 일정에서 당일 시간대와 적용 날짜를 해석하는 데 사용하는 IANA 시간대입니다. |
| content.data[].start | string | 당일 시작 시각 HH:MM입니다. |
| content.data[].end | string | 당일 종료 시각 HH:MM이며, 종료 분의 마지막 초까지 유효합니다. |
| content.data[].notifyTargets | array<string> |
순서대로 저장된 멤버, 알림 대상 UUID 또는 이메일입니다. |
| content.data[].notifyTargets[] | string | acnt_ 계정, notify_ 알림 대상 또는 이메일 문자열입니다. |
| content.data[].extend | object | 확장 설정이며, 미설정 시 {}일 수 있습니다. |
| content.data[].extend.enableRotateNotification | boolean | 순환을 활성화할지 여부이며, 기본값은 false입니다. |
| content.data[].extend.rotationCycle | string | 순환을 활성화했을 때의 주기입니다. day는 일별, week는 월요일 기준, month는 달력 월 기준, workDay는 근무일만 일별, weekend는 주말만 일별입니다. 공휴일은 인식하지 않으며, 미설정 시 생략할 수 있습니다. |
| content.data[].extend.effectiveTime | object | 전체 유효 기간이며, 미설정 시 생략할 수 있습니다. |
| content.data[].extend.effectiveTime.start | integer | 유효 기간 시작 Unix 초입니다. 0이거나 생략되면 제한하지 않습니다. |
| content.data[].extend.effectiveTime.end | integer | 유효 기간 종료 Unix 초입니다. 0이거나 생략되면 제한하지 않습니다. |
| content.data[].rotationUpdateAt | integer | 순환 계산의 시작 시간(Unix 초)입니다. 순환 관련 설정을 변경하면 재설정됩니다. |
| content.data[].status | integer | 레코드 상태이며, 활성 레코드는 0입니다. |
| 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[].effectiveTimeInfos | object | 전체 유효 기간의 표시 정보입니다. 목록, 생성, 수정 시에만 반환됩니다. |
| content.data[].effectiveTimeInfos.timeStr | string | 일정 시간대로 YYYY/MM/DD HH:MM:SS~YYYY/MM/DD HH:MM:SS 형식으로 포맷됩니다. 한쪽이 미설정이면 비어 있고, 양쪽 모두 미설정이면 전체가 빈 문자열입니다. |
| content.data[].effectiveTimeInfos.expired | boolean | 현재 시각이 유효 기간 종료를 초과했는지 여부입니다. 종료 제한이 없으면 false입니다. |
| content.data[].notifyTargetsInfos | array<object> |
확인된 알림 대상 정보입니다. 유효하지 않거나 더 이상 존재하지 않는 대상은 반환되지 않을 수 있으며, 필드는 계정, 알림 대상, 이메일 세 가지 유형에 따라 달라집니다. |
| content.data[].notifyTargetsInfos[].uuid | string | 계정/알림 대상 UUID이며, 이메일 대상은 이메일 자체를 UUID로 사용합니다. |
| content.data[].notifyTargetsInfos[].name | string | 대상 표시 이름이며, 이메일 대상은 이메일 주소입니다. |
| content.data[].notifyTargetsInfos[].status | integer | 계정 또는 알림 대상의 레코드 상태이며, 이메일 대상에는 이 필드가 없습니다. |
| content.data[].notifyTargetsInfos[].type | string | 알림 대상에서만 제공되는 객체 유형입니다. |
| content.data[].notifyTargetsInfos[].wsAccountStatus | integer | 계정에서만 제공되는 워크스페이스 내 계정 상태입니다. |
| content.data[].notifyTargetsInfos[].username | string | 계정에서만 제공되는 로그인 사용자 이름입니다. |
| content.data[].notifyTargetsInfos[].iconUrl | string | 계정에서만 제공되는 프로필 이미지 주소입니다. |
| content.data[].notifyTargetsInfos[].email | string | 계정 이메일 또는 이메일 대상 주소이며, 알림 대상에서는 제공되지 않을 수 있습니다. |
| content.data[].notifyTargetsInfos[].mobile | string | 계정에서만 제공되는 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.data[].notifyTargetsInfos[].countryCode | string | 계정에서만 제공되는 휴대폰 번호 국가/지역 코드입니다. |
| content.data[].notifyTargetsInfos[].acntWsNickname | string | 계정에서만 제공되는 워크스페이스 닉네임입니다. |
| content.data[].issueNotificationPolicyInfos | array<object> |
연결된 알림 정책 및 해당 정책을 참조하는 채널입니다. 연결이 없으면 비어 있습니다. |
| content.data[].issueNotificationPolicyInfos[].id | integer | 정책 레코드 번호입니다. |
| content.data[].issueNotificationPolicyInfos[].uuid | string | 알림 정책 UUID입니다. |
| content.data[].issueNotificationPolicyInfos[].workspaceUUID | string | 정책이 속한 워크스페이스입니다. |
| content.data[].issueNotificationPolicyInfos[].name | string | 정책 이름입니다. |
| content.data[].issueNotificationPolicyInfos[].extend | object | 알림 범위 및 에스컬레이션 설정입니다. 전체 설정 의미는 알림 정책 목록을 참조하십시오. |
| content.data[].issueNotificationPolicyInfos[].extend.notifyTypes | array<string> |
알림을 트리거하는 이벤트 유형 목록이며 생략할 수 있습니다. |
| content.data[].issueNotificationPolicyInfos[].extend.notifyTypes[] | string | 예: issue.add, issue.modify, issueReply.add 또는 dailySummary. |
| content.data[].issueNotificationPolicyInfos[].extend.upgradeCfg | object | 에스컬레이션 트리거 유형별로 저장된 설정이며 생략할 수 있습니다. |
| content.data[].issueNotificationPolicyInfos[].extend.upgradeCfg.동적 키 | object | noManager, processTimeout, openProcessTimeout, eventStorm 등 설정된 에스컬레이션 트리거 유형입니다. |
| content.data[].issueNotificationPolicyInfos[].extend.upgradeCfg.동적 키.duration | integer | 대기 또는 판단 시간(초)이며, 실제 트리거 유형에 따라 제공됩니다. |
| content.data[].issueNotificationPolicyInfos[].extend.upgradeCfg.동적 키.기타 필드 | number, boolean, string, array 또는 object | 트리거 유형별 추가 규칙입니다. 알림 정책 상세 및 해당 매개변수 표를 기준으로 하십시오. |
| content.data[].issueNotificationPolicyInfos[].status | integer | 활성 상태는 0입니다. |
| content.data[].issueNotificationPolicyInfos[].creator | string | 생성한 신원입니다. |
| content.data[].issueNotificationPolicyInfos[].updator | string | 업데이트한 신원입니다. |
| content.data[].issueNotificationPolicyInfos[].createAt | integer | 생성 Unix 초입니다. |
| content.data[].issueNotificationPolicyInfos[].updateAt | integer | 업데이트 Unix 초이며, 업데이트되지 않은 경우 -1입니다. |
| content.data[].issueNotificationPolicyInfos[].deleteAt | integer | 삭제 Unix 초이며, 삭제되지 않은 경우 -1입니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos | array<object> |
이 알림 정책을 참조하는 채널 엔터티 목록입니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].id | integer | 데이터베이스 레코드 번호입니다. 채널 작업에는 uuid를 사용하십시오. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].uuid | string | 채널 UUID이며, 수정, 삭제 또는 구독에 사용됩니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].workspaceUUID | string | 채널이 속한 워크스페이스입니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].name | string | 채널 이름입니다. default는 기본 채널을 의미합니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].description | string | 채널 설명입니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].notifyTarget | array<string> |
해당 채널에 직접 설정된 알림 대상 UUID입니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].notifyTarget[] | string | 단일 알림 대상 UUID입니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].notifyUpgradeCfg | object | 에스컬레이션 알림 설정이며, 미설정 시 빈 객체입니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].notifyUpgradeCfg.triggerTime | integer | 에스컬레이션 알림을 트리거하는 대기 시간(초)입니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].notifyUpgradeCfg.notifyTarget | array<string> |
에스컬레이션 알림 대상 UUID 목록입니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].notifyUpgradeCfg.notifyTarget[] | string | 에스컬레이션 알림 대상 UUID입니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].status | integer | 레코드 상태이며, 정상은 0입니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].creator | string | 생성한 호출 신원입니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].updator | string | 최근 업데이트한 신원이며, 업데이트되지 않은 경우 빈 문자열일 수 있습니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].createAt | integer | 생성 시간(Unix 초)입니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].updateAt | integer | 업데이트 시간(Unix 초)이며, 업데이트되지 않은 경우 -1입니다. |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].deleteAt | integer | 삭제 시간(Unix 초)이며, 삭제되지 않은 경우 -1입니다. |
| content.data[].inEffectNotifyTargetsInfos | array<object> |
현재 시각, 일정 시간대, 유효 기간 및 순환을 기준으로 계산된 실제 적용 대상입니다. 적용되지 않으면 []입니다. |
| content.data[].inEffectNotifyTargetsInfos[].uuid | string | 계정/알림 대상 UUID이며, 이메일 대상은 이메일 자체를 UUID로 사용합니다. |
| content.data[].inEffectNotifyTargetsInfos[].name | string | 대상 표시 이름이며, 이메일 대상은 이메일 주소입니다. |
| content.data[].inEffectNotifyTargetsInfos[].status | integer | 계정 또는 알림 대상의 레코드 상태이며, 이메일 대상에는 이 필드가 없습니다. |
| content.data[].inEffectNotifyTargetsInfos[].type | string | 알림 대상에서만 제공되는 객체 유형입니다. |
| content.data[].inEffectNotifyTargetsInfos[].wsAccountStatus | integer | 계정에서만 제공되는 워크스페이스 내 계정 상태입니다. |
| content.data[].inEffectNotifyTargetsInfos[].username | string | 계정에서만 제공되는 로그인 사용자 이름입니다. |
| content.data[].inEffectNotifyTargetsInfos[].iconUrl | string | 계정에서만 제공되는 프로필 이미지 주소입니다. |
| content.data[].inEffectNotifyTargetsInfos[].email | string | 계정 이메일 또는 이메일 대상 주소이며, 알림 대상에서는 제공되지 않을 수 있습니다. |
| content.data[].inEffectNotifyTargetsInfos[].mobile | string | 계정에서만 제공되는 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.data[].inEffectNotifyTargetsInfos[].countryCode | string | 계정에서만 제공되는 휴대폰 번호 국가/지역 코드입니다. |
| content.data[].inEffectNotifyTargetsInfos[].acntWsNickname | string | 계정에서만 제공되는 워크스페이스 닉네임입니다. |
| content.myScheduleCount | integer | 이 워크스페이스에서 현재 호출 신원의 일정 총 개수이며, 이번 검색이나 기타 필터의 영향을 받지 않습니다. |
| content.totalScheduleCount | integer | 이 워크스페이스의 활성 일정 총 개수이며, 이번 검색이나 기타 필터의 영향을 받지 않습니다. |
| content.declaration | object 또는 null | 워크스페이스 공통 선언입니다. |
| pageInfo | object | 일반 분기에서만 반환되는 최상위 페이지네이션 정보입니다. |
| pageInfo.pageIndex | integer | 현재 페이지 번호입니다. |
| pageInfo.pageSize | integer | 페이지당 개수입니다. |
| pageInfo.count | integer | 현재 페이지에서 실제 반환된 개수입니다. |
| pageInfo.totalCount | integer | 이번 필터에 일치하는 총 개수입니다. |
| content.scheduleCalendarInfos | object | 캘린더 분기에서만 반환되며, 키는 scTimezone 기준 YYYY/MM/DD 날짜입니다. 날짜는 생략되거나 빈 배열일 수 있습니다. |
| content.scheduleCalendarInfos.날짜 | array<object> |
해당 캘린더 날짜의 알림 대상 정보이며, 일별로 집계되며 현재 시점의 실시간 온콜 담당자를 의미하지 않습니다. |
| content.scheduleCalendarInfos.날짜[].uuid | string | 계정/알림 대상 UUID이며, 이메일 대상은 이메일 자체를 UUID로 사용합니다. |
| content.scheduleCalendarInfos.날짜[].name | string | 대상 표시 이름이며, 이메일 대상은 이메일 주소입니다. |
| content.scheduleCalendarInfos.날짜[].status | integer | 계정 또는 알림 대상의 레코드 상태이며, 이메일 대상에는 이 필드가 없습니다. |
| content.scheduleCalendarInfos.날짜[].type | string | 알림 대상에서만 제공되는 객체 유형입니다. |
| content.scheduleCalendarInfos.날짜[].wsAccountStatus | integer | 계정에서만 제공되는 워크스페이스 내 계정 상태입니다. |
| content.scheduleCalendarInfos.날짜[].username | string | 계정에서만 제공되는 로그인 사용자 이름입니다. |
| content.scheduleCalendarInfos.날짜[].iconUrl | string | 계정에서만 제공되는 프로필 이미지 주소입니다. |
| content.scheduleCalendarInfos.날짜[].email | string | 계정 이메일 또는 이메일 대상 주소이며, 알림 대상에서는 제공되지 않을 수 있습니다. |
| content.scheduleCalendarInfos.날짜[].mobile | string | 계정에서만 제공되는 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.scheduleCalendarInfos.날짜[].countryCode | string | 계정에서만 제공되는 휴대폰 번호 국가/지역 코드입니다. |
| content.scheduleCalendarInfos.날짜[].acntWsNickname | string | 계정에서만 제공되는 워크스페이스 닉네임입니다. |
| content.scheduleCalendarUpdateInfos | object | 캘린더 분기에서만 반환되며, 일정 설정이 업데이트된 날짜를 표시합니다. |
| content.scheduleCalendarUpdateInfos.날짜 | array<object> |
해당 날짜에 업데이트된 일정의 현재 엔터티 스냅샷이며, 전체 이력 버전이 아닙니다. |
| content.scheduleCalendarUpdateInfos.날짜[].id | integer 또는 null | 데이터베이스 번호이며, 생성 시 아직 할당되지 않았을 수 있습니다. 리소스 작업에는 uuid를 사용하십시오. |
| content.scheduleCalendarUpdateInfos.날짜[].uuid | string | 일정 UUID이며, 조회, 수정, 삭제 및 알림 정책 참조에 사용됩니다. |
| content.scheduleCalendarUpdateInfos.날짜[].workspaceUUID | string | 소속 워크스페이스 UUID입니다. |
| content.scheduleCalendarUpdateInfos.날짜[].name | string | 일정 이름입니다. |
| content.scheduleCalendarUpdateInfos.날짜[].timezone | string | 이 일정에서 당일 시간대와 적용 날짜를 해석하는 데 사용하는 IANA 시간대입니다. |
| content.scheduleCalendarUpdateInfos.날짜[].start | string | 당일 시작 시각 HH:MM입니다. |
| content.scheduleCalendarUpdateInfos.날짜[].end | string | 당일 종료 시각 HH:MM이며, 종료 분의 마지막 초까지 유효합니다. |
| content.scheduleCalendarUpdateInfos.날짜[].notifyTargets | array<string> |
순서대로 저장된 멤버, 알림 대상 UUID 또는 이메일입니다. |
| content.scheduleCalendarUpdateInfos.날짜[].notifyTargets[] | string | acnt_ 계정, notify_ 알림 대상 또는 이메일 문자열입니다. |
| content.scheduleCalendarUpdateInfos.날짜[].extend | object | 확장 설정이며, 미설정 시 {}일 수 있습니다. |
| content.scheduleCalendarUpdateInfos.날짜[].extend.enableRotateNotification | boolean | 순환을 활성화할지 여부이며, 기본값은 false입니다. |
| content.scheduleCalendarUpdateInfos.날짜[].extend.rotationCycle | string | 순환을 활성화했을 때의 주기입니다. day는 일별, week는 월요일 기준, month는 달력 월 기준, workDay는 근무일만 일별, weekend는 주말만 일별입니다. 공휴일은 인식하지 않으며, 미설정 시 생략할 수 있습니다. |
| content.scheduleCalendarUpdateInfos.날짜[].extend.effectiveTime | object | 전체 유효 기간이며, 미설정 시 생략할 수 있습니다. |
| content.scheduleCalendarUpdateInfos.날짜[].extend.effectiveTime.start | integer | 유효 기간 시작 Unix 초입니다. 0이거나 생략되면 제한하지 않습니다. |
| content.scheduleCalendarUpdateInfos.날짜[].extend.effectiveTime.end | integer | 유효 기간 종료 Unix 초입니다. 0이거나 생략되면 제한하지 않습니다. |
| content.scheduleCalendarUpdateInfos.날짜[].rotationUpdateAt | integer | 순환 계산의 시작 시간(Unix 초)입니다. 순환 관련 설정을 변경하면 재설정됩니다. |
| content.scheduleCalendarUpdateInfos.날짜[].status | integer | 레코드 상태이며, 활성 레코드는 0입니다. |
| content.scheduleCalendarUpdateInfos.날짜[].creator | string | 생성한 호출 신원입니다. |
| content.scheduleCalendarUpdateInfos.날짜[].updator | string | 최근 업데이트한 신원이며, 업데이트되지 않은 경우 빈 문자열입니다. |
| content.scheduleCalendarUpdateInfos.날짜[].createAt | integer | 생성 시간(Unix 초)입니다. |
| content.scheduleCalendarUpdateInfos.날짜[].updateAt | integer | 업데이트 시간(Unix 초)이며, 업데이트되지 않은 경우 -1입니다. |
| content.scheduleCalendarUpdateInfos.날짜[].deleteAt | integer | 삭제 시간(Unix 초)이며, 삭제되지 않은 경우 -1입니다. |
| content.totalCount | integer | 캘린더 분기에서만: 일치하는 일정 수이며, 날짜 수나 대상 수가 아닙니다. |
{
"code": 200,
"content": {
"data": [
{
"id": 42,
"uuid": "nsche_example",
"workspaceUUID": "wksp_example",
"name": "生产值班",
"timezone": "Asia/Shanghai",
"start": "09:00",
"end": "18:00",
"notifyTargets": [
"notify_example"
],
"extend": {
"enableRotateNotification": false
},
"rotationUpdateAt": 1785427200,
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"notifyTargetsInfos": [
{
"uuid": "notify_example",
"name": "生产值班群",
"status": 0,
"type": "dingtalk"
}
],
"issueNotificationPolicyInfos": [],
"inEffectNotifyTargetsInfos": [],
"effectiveTimeInfos": {
"timeStr": "",
"expired": false
}
}
],
"myScheduleCount": 0,
"totalScheduleCount": 1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 10,
"count": 1,
"totalCount": 1
}
}
캘린더 분기 호출
curl --get '<Endpoint>/api/v1/notification_schedule/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode scheduleCalendar=true \
--data-urlencode scTimezone=Asia/Shanghai \
--data-urlencode 'scDateRange=2026/11/18~2026/11/19'
캘린더 분기 응답
{
"code": 200,
"content": {
"scheduleCalendarInfos": {
"2026/11/18": [
{
"uuid": "notify_example",
"name": "生产值班群",
"status": 0,
"type": "dingtalk"
}
]
},
"scheduleCalendarUpdateInfos": {},
"totalCount": 1,
"myScheduleCount": 0,
"totalScheduleCount": 1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 선언되지 않은 Query 매개변수를 사용했거나 매개변수가 규칙을 위반함 | 매개변수 파싱 실패 | Query 매개변수 표 및 예시를 확인하십시오. |
| 400 | ft.InvalidDateRange | 캘린더 모드에서 scDateRange를 전달하지 않음, 형식 불일치 또는 날짜 역순 | 유효하지 않은 날짜 범위 | 유효한 날짜 범위를 명시적으로 전달하고 양 끝을 포함합니다. |
| 400 | ft.ExceedMaximumQueryDateRange | 캘린더 범위에 50개를 초과하는 날짜가 포함됨 | 조회 날짜 범위가 너무 큽니다. 최대 50일 범위 조회만 지원합니다 | 각 요청이 최대 50일이 되도록 분할합니다. |
| 500 | ft.InternalServerError | 알 수 없는 IANA 시간대, 유효하지 않은 실제 날짜, 문자열이 아닌 알림 대상 또는 파싱할 수 없는 시각 등으로 인한 내부 실패 | 내부 오류 | 호출 전에 매개변수 표에 따라 시간대, 실제 날짜, HH:MM 및 문자열 배열을 검증하십시오. 쓰기 작업 실패 후에는 먼저 상세 조회로 저장되었는지 확인한 뒤 재시도 여부를 결정하고 traceId를 보존하십시오. |