업무시간 조회 API
1. API 개요
업무시간 조회
설정된 업무시간 및 운영 상태를 조회하는 API입니다.
지정한 날짜 기준으로 다음 정보를 확인할 수 있습니다.
•
운영 상태
•
업무시간 여부
•
휴일 여부
•
업무시간 정보
date 파라미터를 입력하지 않으면 오늘 날짜 기준으로 조회됩니다.
2. 사전 조건 / 권한
•
콜브릿지 계정 필수
•
API Access Token 발급 필요
3. API 정보
Method / Endpoint
Header
이름 | 타입 | 필수 | 기본값 | 설명 |
Authorization | string | O | Bearer {ACCESS_TOKEN} 형식으로 전달 |
4. Request
Query Parameters
이름 | 타입 | 필수 | 기본값 | 설명 |
date | String (yyyy-MM-dd) | X | 오늘 날짜 | 조회 날짜 (예: 2024-01-15). 미입력 시 오늘 날짜 기준 조회 |
Request Example
cURL
curl -X GET "https://bnd.happytalk.io/api/openapi/operating-hours?date=2024-01-15" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
JavaScript
복사
5. Response
Response 정보
•
Status Code: 200 OK
•
Content-Type: application/json
Response Body Example
json
운영중
{
"code": "OK",
"timestamp": 1705388400,
"message": "업무시간 조회 성공",
"data": {
"status": "OPERATING",
"date": "2024-01-15",
"dayOfWeek": "MONDAY",
"isHoliday": false,
"isWithinWorkingHours": true,
"workingHours": {
"startTime": "09:00",
"endTime": "18:00"
}
}
}
업무시간 외
{
"code": "OK",
"timestamp": 1705388400,
"message": "업무시간 조회 성공",
"data": {
"status": "OFF",
"date": "2024-01-15",
"dayOfWeek": "MONDAY",
"isHoliday": false,
"isWithinWorkingHours": false,
"workingHours": {
"startTime": "09:00",
"endTime": "18:00"
}
}
}
휴일
{
"code": "OK",
"timestamp": 1705388400,
"message": "업무시간 조회 성공",
"data": {
"status": "HOLIDAY",
"date": "2024-01-01",
"dayOfWeek": "MONDAY",
"isHoliday": true,
"holidayInfo": {
"type": "PUBLIC_HOLIDAY",
"name": "신정"
},
"isWithinWorkingHours": false
}
}
JavaScript
복사
Resonse Field명
Response Body
이름 | 타입 | 필수 | 기본값 | 설명 |
code | String | O | - | 응답 코드 (예: "OK") |
timestamp | Long | O | - | 응답 일시 (Unix timestamp) |
message | String | X | - | 응답 메시지 |
data | Object | O | - | 업무시간 조회 결과 |
data (OperatingStatusDto)
이름 | 타입 | 필수 | 기본값 | 설명 |
status | String | O | - | 운영 상태 (OPERATING: 운영중, OFF: 업무시간 외, HOLIDAY: 휴일) |
date | String | O | - | 조회 날짜 (yyyy-MM-dd) |
dayOfWeek | String | O | - | 요일 (MONDAY ~ SUNDAY) |
isHoliday | Boolean | O | - | 휴일 여부 |
holidayInfo | Object | X | - | 휴일 정보 (휴일인 경우에만 포함) |
isWithinWorkingHours | Boolean | O | - | 현재 업무시간 여부 |
workingHours | Object | X | - | 업무시간 정보 (휴일이 아닐 경우 포함) |
holidayInfo (HolidayInfoDto)
이름 | 타입 | 필수 | 기본값 | 설명 |
type | String | O | - | 휴일 유형 (SITE_HOLIDAY: 사이트 지정 휴일, PUBLIC_HOLIDAY: 공휴일) |
name | String | X | - | 휴일 명칭 (예: "신정") |
workingHours (WorkingHoursDto)
이름 | 타입 | 필수 | 기본값 | 설명 |
startTime | String | O | - | 업무 시작 시간 (HH:mm) |
endTime | String | O | - | 업무 종료 시간 (HH:mm) |
6. 에러 / 예외처리
오류 응답 본문의 “code"와 "message" 속성에서 오류에 대한 더 구체적인 세부 정보를 확인할 수 있습니다.
HTTP 상태명 | Error Code | Message | 설명 |
401 Unauthorized | UNAUTHORIZED | 인증에 실패했습니다 | API Key 미전송 또는 인증 실패 |
500 Internal Server Error | INTERNAL_SERVER_ERROR | 내부 서버 오류가 발생했습니다 | 예기치 않은 서버 오류 |
