콘텐츠로 이동

조회



GET /api/v1/notification_schedule/{notification_schedule_uuid}/get

개요

지정된 일정의 전체 구성과 확인 가능한 알림 대상을 읽습니다.

호출 전 및 사용 단계

일정 목록에서 UUID를 복사한 후 호출합니다. 이 API는 현재 적용되는 알림 대상과 형식화된 유효 기간을 반환하지 않으므로 일정 목록을 확인해야 합니다. 현재 버전에서는 실제로 정책 참조가 있어도 연결된 알림 정책 목록이 비어 있을 수 있습니다. 연결 정보가 필요하면 목록을 교차 확인해야 하며, 이 빈 배열만으로 연결이 없다고 판단해서는 안 됩니다.

라우트 파라미터

파라미터 이름 유형 필수 설명
notification_schedule_uuid string Y 대상 일정 UUID입니다. 현재 API Key의 워크스페이스에 속해야 합니다.
예: nsche_example
가져오기 또는 입력 방법: 일정 목록에서 반환된 content.data[].uuid에서 가져옵니다.

요청 헤더

파라미터 이름 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

파라미터 추가 설명

이 API가 반환한 name, timezone, start, end, notifyTargets, extend를 복사하면 전체 수정의 기반으로 사용할 수 있습니다. 응답 필드 전체를 그대로 다시 전송하지 마세요.

요청 예시

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

응답

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

필드 유형 설명
content object 대상 일정 구성입니다.
content.id integer 데이터베이스 레코드 번호입니다. 일정 작업에는 uuid를 사용합니다.
content.uuid string 일정 UUID이며, 조회, 수정, 삭제 및 알림 정책 참조에 사용됩니다.
content.workspaceUUID string 소속 워크스페이스 UUID입니다.
content.name string 일정 이름입니다.
content.timezone string 이 일정에서 당일 시간대와 적용 날짜를 해석하는 데 사용하는 IANA 시간대입니다.
content.start string 당일 시작 시각(HH:MM)입니다.
content.end string 당일 종료 시각(HH:MM)이며, 종료 분의 마지막 초까지 유효합니다.
content.notifyTargets array<string> 순서대로 저장된 구성원, 알림 대상 UUID 또는 이메일입니다.
content.notifyTargets[] string acnt_ 계정, notify_ 알림 대상 또는 이메일 문자열입니다.
content.extend object 확장 구성입니다. 구성하지 않으면 {}일 수 있습니다.
content.extend.enableRotateNotification boolean 순환 사용 여부입니다. 기본값은 false입니다.
content.extend.rotationCycle string 순환을 활성화한 경우의 주기입니다. day는 일별, week는 월요일 기준 주별, month는 자연월 기준, workDay는 평일만 일별, weekend는 주말만 일별입니다. 공휴일은 인식하지 않으며, 구성하지 않으면 생략할 수 있습니다.
content.extend.effectiveTime object 전체 유효 기간이며, 구성하지 않으면 생략할 수 있습니다.
content.extend.effectiveTime.start integer 유효 기간 시작 Unix 초입니다. 0이거나 생략하면 제한하지 않습니다.
content.extend.effectiveTime.end integer 유효 기간 종료 Unix 초입니다. 0이거나 생략하면 제한하지 않습니다.
content.rotationUpdateAt integer 순환 계산의 시작 시간(Unix 초)입니다. 순환 관련 구성을 변경하면 재설정됩니다.
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.notifyTargetsInfos array<object> 확인된 알림 대상 정보입니다. 유효하지 않거나 더 이상 존재하지 않는 대상은 반환되지 않을 수 있으며, 필드는 계정, 알림 대상, 이메일 세 가지 유형에 따라 달라집니다.
content.notifyTargetsInfos[].uuid string 계정/알림 대상 UUID입니다. 이메일 대상은 이메일 자체를 UUID로 사용합니다.
content.notifyTargetsInfos[].name string 대상 표시 이름입니다. 이메일 대상은 이메일 주소입니다.
content.notifyTargetsInfos[].status integer 계정 또는 알림 대상의 레코드 상태입니다. 이메일 대상에는 이 필드가 포함되지 않습니다.
content.notifyTargetsInfos[].type string 알림 대상에서만 제공되며, 대상 유형입니다.
content.notifyTargetsInfos[].wsAccountStatus integer 계정에서만 제공되며, 워크스페이스 내 계정 상태입니다.
content.notifyTargetsInfos[].username string 계정에서만 제공되며, 로그인 사용자 이름입니다.
content.notifyTargetsInfos[].iconUrl string 계정에서만 제공되며, 아바타 주소입니다.
content.notifyTargetsInfos[].email string 계정 이메일 또는 이메일 대상 주소입니다. 알림 대상에서는 제공되지 않을 수 있습니다.
content.notifyTargetsInfos[].mobile string 계정에서만 제공되며, 휴대전화 번호이고 비어 있을 수 있습니다.
content.notifyTargetsInfos[].countryCode string 계정에서만 제공되며, 휴대전화 번호의 국가/지역 코드입니다.
content.notifyTargetsInfos[].acntWsNickname string 계정에서만 제공되며, 워크스페이스 닉네임입니다.
content.issueNotificationPolicyInfos array<object> 연결된 알림 정책 및 정책을 참조하는 채널입니다. 연결이 없으면 비어 있습니다.
content.issueNotificationPolicyInfos[].id integer 정책 레코드 번호입니다.
content.issueNotificationPolicyInfos[].uuid string 알림 정책 UUID입니다.
content.issueNotificationPolicyInfos[].workspaceUUID string 정책이 속한 워크스페이스입니다.
content.issueNotificationPolicyInfos[].name string 정책 이름입니다.
content.issueNotificationPolicyInfos[].extend object 알림 범위 및 에스컬레이션 구성입니다. 전체 구성의 의미는 알림 정책 목록을 참조하세요.
content.issueNotificationPolicyInfos[].extend.notifyTypes array<string> 알림을 트리거하는 이벤트 유형 목록이며 생략할 수 있습니다.
content.issueNotificationPolicyInfos[].extend.notifyTypes[] string 예: issue.add, issue.modify, issueReply.add 또는 dailySummary.
content.issueNotificationPolicyInfos[].extend.upgradeCfg object 에스컬레이션 트리거 유형별로 저장되는 구성이며 생략할 수 있습니다.
content.issueNotificationPolicyInfos[].extend.upgradeCfg.동적 키 object noManager, processTimeout, openProcessTimeout, eventStorm 등 구성된 에스컬레이션 트리거 유형입니다.
content.issueNotificationPolicyInfos[].extend.upgradeCfg.동적 키.duration integer 대기 또는 판단 시간(초)입니다. 실제 트리거 유형에 따라 제공됩니다.
content.issueNotificationPolicyInfos[].extend.upgradeCfg.동적 키.기타 필드 number, boolean, string, array 또는 object 트리거 유형별 추가 규칙입니다. 알림 정책 상세 및 해당 파라미터 표를 기준으로 하세요.
content.issueNotificationPolicyInfos[].status integer 활성 상태는 0입니다.
content.issueNotificationPolicyInfos[].creator string 생성 주체입니다.
content.issueNotificationPolicyInfos[].updator string 업데이트 주체입니다.
content.issueNotificationPolicyInfos[].createAt integer 생성 Unix 초입니다.
content.issueNotificationPolicyInfos[].updateAt integer 업데이트 Unix 초이며, 업데이트되지 않은 경우 -1입니다.
content.issueNotificationPolicyInfos[].deleteAt integer 삭제 Unix 초이며, 삭제되지 않은 경우 -1입니다.
content.issueNotificationPolicyInfos[].channelInfos array<object> 이 알림 정책을 참조하는 채널 엔터티 목록입니다.
content.issueNotificationPolicyInfos[].channelInfos[].id integer 데이터베이스 레코드 번호입니다. 채널 작업에는 uuid를 사용하세요.
content.issueNotificationPolicyInfos[].channelInfos[].uuid string 채널 UUID이며, 수정, 삭제 또는 구독에 사용됩니다.
content.issueNotificationPolicyInfos[].channelInfos[].workspaceUUID string 채널이 속한 워크스페이스입니다.
content.issueNotificationPolicyInfos[].channelInfos[].name string 채널 이름입니다. default는 기본 채널을 의미합니다.
content.issueNotificationPolicyInfos[].channelInfos[].description string 채널 설명입니다.
content.issueNotificationPolicyInfos[].channelInfos[].notifyTarget array<string> 해당 채널에 직접 구성된 알림 대상 UUID입니다.
content.issueNotificationPolicyInfos[].channelInfos[].notifyTarget[] string 단일 알림 대상 UUID입니다.
content.issueNotificationPolicyInfos[].channelInfos[].notifyUpgradeCfg object 에스컬레이션 알림 구성이며, 구성하지 않으면 빈 객체입니다.
content.issueNotificationPolicyInfos[].channelInfos[].notifyUpgradeCfg.triggerTime integer 에스컬레이션 알림을 트리거하는 대기 시간(초)입니다.
content.issueNotificationPolicyInfos[].channelInfos[].notifyUpgradeCfg.notifyTarget array<string> 에스컬레이션 알림 대상 UUID 목록입니다.
content.issueNotificationPolicyInfos[].channelInfos[].notifyUpgradeCfg.notifyTarget[] string 에스컬레이션 알림 대상 UUID입니다.
content.issueNotificationPolicyInfos[].channelInfos[].status integer 레코드 상태이며, 정상은 0입니다.
content.issueNotificationPolicyInfos[].channelInfos[].creator string 생성 호출 주체입니다.
content.issueNotificationPolicyInfos[].channelInfos[].updator string 최근 업데이트 주체이며, 업데이트되지 않은 경우 빈 문자열일 수 있습니다.
content.issueNotificationPolicyInfos[].channelInfos[].createAt integer 생성 시간(Unix 초)입니다.
content.issueNotificationPolicyInfos[].channelInfos[].updateAt integer 업데이트 시간(Unix 초)이며, 업데이트되지 않은 경우 -1입니다.
content.issueNotificationPolicyInfos[].channelInfos[].deleteAt integer 삭제 시간(Unix 초)이며, 삭제되지 않은 경우 -1입니다.
content.declaration object 또는 null 워크스페이스 공통 선언입니다.
{
  "code": 200,
  "content": {
    "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": [],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
404 ft.ObjectNotExists 일정이 존재하지 않거나, 삭제되었거나, 현재 워크스페이스에 속하지 않음 지정된 객체가 존재하지 않음 일정 목록에서 유효한 UUID를 다시 복사하세요.
500 ft.InternalServerError 데이터베이스 쿼리 또는 이전 구성 정보 읽기 예외 내부 오류 traceId를 보관하고 재시도하세요. 계속 실패하면 일정 UUID와 민감 정보를 마스킹한 응답을 제공하여 지원팀에 문의하세요.

문서 평가

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