Users
워크스페이스(Workspace)에 가입한 멤버의 정보를 조회하거나 업데이트하기 위해 다음과 같은 API를 사용합니다.
표Users API 리스트구분 | API 명 | 설명 |
---|---|---|
정보 조회 | users.info | 멤버의 고유 정보인 user_id 로 멤버의 상세 정보를 조회 |
users.find_by_email | 이메일로 카카오워크에 가입 및 인증한 멤버의 상세 정보 조회 | |
users.list | 특정 워크스페이스의 전체 멤버 목록과 멤버 별 상세 정보 조회 | |
정보 업데이트 | users.set_work_time | 특정 멤버의 근무 시간을 업데이트 |
users.set_vacation_time | 특정 멤버의 휴가 시간을 업데이트 | |
/batch/users.set_work_time | 여러 멤버의 근무 시간을 최대 100명까지 업데이트 | |
/batch/users.set_vacation_time | 여러 멤버의 휴가 시간을 최대 100명까지 업데이트 | |
정보 초기화 | /batch/users.reset_work_time | 여러 멤버의 근무 시간을 최대 100명까지 초기화 |
/batch/users.reset_vacation_time | 여러 멤버의 휴가 시간을 최대 100명까지 초기화 |
users.info
워크스페이스에 속한 특정 멤버의 상세 정보를 얻습니다.
Request
Request Syntax
코드예제users.info Request Syntax
curl -X GET https://api.kakaowork.com/v1/users.info?user_id={USER_ID} \
-H "Authorization: Bearer {YOUR_APP_KEY}" \
-H "Content-Type: application/json;charset=utf-8"
메서드 | 요청 URL |
---|---|
GET | https://api.kakaowork.com/v1/users.info?user_id={USER_ID} |
파라미터 | 타입 | 필수여부 | 설명 |
---|---|---|---|
user_id | Integer | 필수 |
정보를 얻고자 하는 멤버의 ID |
Request Header
Request Header에 대한 상세는 다음과 같습니다.
표users.info Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
Authorization | String | 필수 |
Bearer {YOUR_APP_KEY} - {YOUR_APP_KEY} : Bot 등록 요청 후에 획득한 인증키(App Key) |
Content-Type | String | 선택 |
application/json 또는 application/x-www-form-urlencoded |
Response
Response Syntax
코드예제users.info Response Syntax
{
"success": true,
"user": {
/* ... user entity ... */
}
}
Response Elements
Response Elements에 대한 상세는 다음과 같습니다.
표users.info Response Elements필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
success | Boolean | 필수 |
API 호출 실행 결과 |
true : 성공, user 필드와 함께 반환 |
|||
false : 실패, error 필드와 함께 반환 |
|||
Object | 선택 |
멤버의 상세 정보 - API 호출 성공( true )일 경우 제공 |
|
id | String | 필수 |
멤버의 ID |
space_id | String | 필수 |
멤버가 속한 워크스페이스의 ID |
name | String | 필수 |
멤버의 이름 |
nickname | String | 선택 |
멤버의 닉네임 - null : 어드민이 닉네임 사용을 허용하지 않은 경우 |
avatar_url | String | 선택 |
멤버의 프로필 사진 URL |
department | String | 선택 |
부서명 |
String | 선택 |
멤버의 식별 정보 - 현재 이메일(Email) 정보만 제공 |
|
type | String | 선택 |
email : 멤버의 이메일 주소로 식별 설정 |
value | String | 선택 |
멤버의 실제 이메일 주소 ex) test@dktechin.com |
position | String | 선택 |
직급명 - null : 어드민이 닉네임 사용을 허용하지 않은 경우 |
responsibility | String | 선택 |
직책명 - null : 어드민이 닉네임 사용을 허용하지 않은 경우 |
tels | String | 선택 |
전화번호 리스트 |
mobiles | String | 선택 |
모바일 번호 리스트 |
work_start_time | Timestamp | 선택 |
근무 시작 시각(Unix time 값) |
work_end_time | Timestamp | 선택 |
근무 종료 시각(Unix time 값) |
vacation_start_time | Timestamp | 선택 |
휴가 시작 시각(Unix time 값) |
vacation_end_time | Timestamp | 선택 |
휴가 종료 시각(Unix time 값) |
status | String | 선택 |
사용자 계정의 상태 |
activated : 활성 상태 사용자 |
|||
deactivated : 탈퇴 상태 사용자 |
|||
inoperative : 미설치 상태 사용자 |
|||
Object | 선택 |
API 실행 오류 정보 - API 호출 실패( false )일 경우 제공 |
|
code | String | 필수 |
오류 상황을 구분하는 코드 |
invalid_parameter : 제공된 파라미터의 값이 올바르지 않음 |
|||
invalid_authentication : 제공된 인증키가 유효하지 않음 |
|||
api_not_found : 요청 API의 URL 혹은 HTTP 메서드와 다름 |
|||
unauthorized : 인증키가 제공되지 않음 |
|||
internal_server_error : 정의되지 않은 서버 오류 발생 |
|||
expired_authentication : 제공된 인증키가 만료됨 |
|||
invalid_content_type : 요청이 API가 요구하는 Content Type과 다름 |
|||
missing_parameter : 필요한 파라미터 값이 제공되지 않았음 |
|||
user_not_found : 멤버를 찾을 수 없음 |
|||
message | String | 필수 |
오류 원인에 대한 설명 |
users.find_by_email
이메일 주소를 이용하여 특정 워크스페이스에 가입한 멤버의 정보를 조회합니다. 해당 API 호출 시, 다른 워크스페이스에 속한 멤버는 조회할 수 없습니다. 이메일의 경우, 해당 멤버가 워크스페이스 가입 시 멤버 인증에 사용한 이메일 주소를 사용해야 합니다. 프로필 정보에 부가정보로 등록된 이메일을 사용할 경우 멤버 조회가 되지 않습니다.
Request
Request Syntax
코드예제users.find_by_email Request Syntax
curl -X GET https://api.kakaowork.com/v1/users.find_by_email?email={EMAIL} \
-H "Authorization: Bearer {YOUR_APP_KEY}"
메서드 | 요청 URL |
---|---|
GET | https://api.kakaowork.com/v1/users.find_by_email?email={EMAIL} |
파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
String | 필수 |
찾고자 하는 멤버의 이메일 주소 |
Request Header
Request Header에 대한 상세는 다음과 같습니다.
표users.find_by_email Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
Authorization | String | 필수 |
Bearer {YOUR_APP_KEY} - {YOUR_APP_KEY} : Bot 등록 요청 후에 획득한 인증키(App Key) |
Content-Type | String | 선택 |
application/json 또는 application/x-www-form-urlencoded |
Response
Response Syntax
코드예제users.find_by_email Response Syntax
{
"success": true,
"user": {
"avatar_url": "http://test.avatar.com/img.jpg",
"department": "test팀",
"display_name": "test1",
"id": "1",
"mobiles": [
"010-1234-1234"
],
"name": "test1",
"nickname": "test1.a",
"position": "대리",
"responsibility": "팀장",
"space_id": "1",
"tels": [],
"vacation_end_time": null,
"vacation_start_time": null,
"work_end_time": 1625473800,
"work_start_time": 1625441400
"status": "activated"
}
}
Response Elements
Response Elements에 대한 상세는 다음과 같습니다.
표users.find_by_email Response Elements필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
success | Boolean | 필수 |
API 호출 실행 결과 |
true : 성공, user 필드와 함께 반환 |
|||
false : 실패, error 필드와 함께 반환 |
|||
Object | 선택 |
멤버의 상세 정보 - API 호출 성공( true )일 경우 제공 |
|
id | String | 필수 |
멤버의 ID |
space_id | String | 필수 |
멤버가 속한 워크스페이스의 ID |
name | String | 필수 |
멤버의 이름 |
nickname | String | 선택 |
멤버의 닉네임 - null : 어드민이 닉네임 사용을 허용하지 않은 경우 |
display_name | String | 필수 |
카카오워크에 설정된 이름 표시정책에 따라 조정된 이름 |
avatar_url | String | 선택 |
멤버의 프로필 사진 URL |
department | String | 선택 |
부서명 |
position | String | 선택 |
직급명 - null : 어드민이 닉네임 사용을 허용하지 않은 경우 |
responsibility | String | 선택 |
직책명 - null : 어드민이 닉네임 사용을 허용하지 않은 경우 |
tels | String[] | 선택 |
전화번호 리스트 |
mobiles | String[] | 선택 |
모바일 번호 리스트 |
work_start_time | Timestamp | 선택 |
근무 시작 시각(Unix time 값) |
work_end_time | Timestamp | 선택 |
근무 종료 시각(Unix time 값) |
vacation_start_time | Timestamp | 선택 |
휴가 시작 시각(Unix time 값) |
vacation_end_time | Timestamp | 선택 |
휴가 종료 시각(Unix time 값) |
status | String | 선택 |
사용자 계정의 상태 |
activated : 활성 상태 사용자 |
|||
deactivated : 탈퇴 상태 사용자 |
|||
inoperative : 미설치 상태 사용자 |
|||
Object | 선택 |
API 실행 오류 정보 - API 호출 실패( false )일 경우 제공 |
|
code | String | 필수 |
오류 상황을 구분하는 코드 |
invalid_parameter : 제공된 파라미터의 값이 올바르지 않음 |
|||
invalid_authentication : 제공된 인증키가 유효하지 않음 |
|||
api_not_found : 요청 API의 URL 혹은 HTTP 메서드와 다름 |
|||
unauthorized : 인증키가 제공되지 않음 |
|||
internal_server_error : 정의되지 않은 서버 오류 발생 |
|||
expired_authentication : 제공된 인증키가 만료됨 |
|||
invalid_content_type : 요청이 API가 요구하는 Content Type과 다름 |
|||
missing_parameter : 필요한 파라미터 값이 제공되지 않았음 |
|||
user_not_found : 멤버를 찾을 수 없음 |
|||
message | String | 필수 |
오류 원인에 대한 설명 |
users.list
특정 워크스페이스에 속한 전체 멤버의 목록과 각각의 멤버에 대한 상세 정보를 조회합니다.
Request
Request Syntax
코드예제users.list Request Syntax
curl -X GET https://api.kakaowork.com/v1/users.list \
-H "Authorization: Bearer {YOUR_APP_KEY}"
메서드 | 요청 URL |
---|---|
GET | https://api.kakaowork.com/v1/users.list |
Request Header
Request Header에 대한 상세는 다음과 같습니다.
표users.list Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
Authorization | String | 필수 |
Bearer {YOUR_APP_KEY} - {YOUR_APP_KEY} : Bot 등록 요청 후에 획득한 인증키(App Key) |
Content-Type | String | 선택 |
application/json 또는 application/x-www-form-urlencoded |
Request Elements
Request Elements에 대한 상세는 다음과 같습니다.
표users.list Request Elements파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
limit | String | 선택 |
한 번에 가져올 수 있는 데이터 개수 - 기본값: 10, 최대값: 100 |
cursor | String | 선택 |
다음 API 호출 시에 사용할 페이징 커서(Cursor) |
status_in | String | 선택 |
유저 상태 |
activated : 참여 중 |
|||
inoperative : 앱 설치 전 |
안내
Pagination의 자세한 규칙은 Pagination을 참고하시기 바랍니다.
Response
Response Syntax
코드예제users.list Response Syntax
{
"cursor": "Y3Vyc29yX2lkPTMzJmxpbWl0PTIw",
"success": true,
"users": [
{
"avatar_url": "http://test.avatar.com/img.jpg",
"department": "test팀",
"id": "1",
"identifications": [],
"mobiles": [],
"name": "test1",
"nickname": "test1.a",
"position": "대리",
"responsibility": "팀장",
"space_id": "1",
"tels": [],
"vacation_end_time": null,
"vacation_start_time": null,
"work_end_time": 1622687365,
"work_start_time": 1622509200
"status": "activated"
},
{
"avatar_url": "http://test.avatar.com/img2.jpg",
"department": "test팀",
"id": "2",
"identifications": [],
"mobiles": [],
"name": "test2",
"nickname": "test2.b",
"position": "대리",
"responsibility": "팀원",
"space_id": "1",
"tels": [],
"vacation_end_time": 1622687365,
"vacation_start_time": 1622509200,
"work_end_time": null,
"work_start_time": null
"status": "activated"
},
{
"avatar_url": "http://test.avatar.com/img3.jpg",
"department": null,
"id": "3",
"identifications": [],
"mobiles": [],
"name": "test3",
"nickname": "test3.c",
"position": null,
"responsibility": null,
"space_id": "1",
"tels": [],
"vacation_end_time": null,
"vacation_start_time": null,
"work_end_time": null,
"work_start_time": null
"status": "inoperative"
}, ...
]
}
Response Elements
Response Elements에 대한 상세는 다음과 같습니다.
표users.list Response Elements필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
success | Boolean | 필수 |
API 호출 실행 결과 |
true : 성공, users 와 cursor 필드가 함께 반환 |
|||
false : 실패, error 필드와 함께 반환 |
|||
Object[] | 선택 |
멤버의 상세 정보 - API 호출 성공( true )일 경우 제공 |
|
id | String | 필수 |
멤버의 ID |
space_id | String | 필수 |
멤버가 속한 워크스페이스의 ID |
name | String | 필수 |
멤버의 이름 |
nickname | String | 선택 |
멤버의 닉네임 - null : 어드민이 닉네임 사용을 허용하지 않은 경우 |
avatar_url | String | 선택 |
멤버의 프로필 사진 URL |
department | String | 선택 |
부서명 |
String | 선택 |
멤버의 식별 정보 - 현재 이메일(Email) 정보만 제공 |
|
type | String | 선택 |
email : 멤버의 이메일 주소로 식별 설정 |
value | String | 선택 |
멤버의 실제 이메일 주소 ex) test@dktechin.com |
position | String | 선택 |
직급명 - null : 어드민이 닉네임 사용을 허용하지 않은 경우 |
responsibility | String | 선택 |
직책명 - null : 어드민이 닉네임 사용을 허용하지 않은 경우 |
tels | String[] | 선택 |
전화번호 리스트 |
mobiles | String[] | 선택 |
모바일 번호 리스트 |
work_start_time | Timestamp | 선택 |
근무 시작 시각(Unix time 값) |
work_end_time | Timestamp | 선택 |
근무 종료 시각(Unix time 값) |
vacation_start_time | Timestamp | 선택 |
휴가 시작 시각(Unix time 값) |
vacation_end_time | Timestamp | 선택 |
휴가 종료 시각(Unix time 값) |
status | String | 선택 |
사용자 계정의 상태 |
activated : 활성 상태 사용자 |
|||
deactivated : 탈퇴 상태 사용자 |
|||
inoperative : 미설치 상태 사용자 |
|||
cursor | String | 선택 |
다음 API 호출 시에 쓰일 페이징 커서(Cursor) - API 호출 성공( true )일 경우 제공 |
Object | 선택 |
API 실행 오류 정보 - API 호출 실패( false )일 경우 제공 |
|
code | String | 필수 |
오류 상황을 구분하는 코드 |
invalid_parameter : 제공된 파라미터의 값이 올바르지 않음 |
|||
invalid_authentication : 제공된 인증키가 유효하지 않음 |
|||
api_not_found : 요청 API의 URL 혹은 HTTP 메서드와 다름 |
|||
unauthorized : 인증키가 제공되지 않음 |
|||
internal_server_error : 정의되지 않은 서버 오류 발생 |
|||
expired_authentication : 제공된 인증키가 만료됨 |
|||
invalid_content_type : 요청이 API가 요구하는 Content Type과 다름 |
|||
missing_parameter : 필요한 파라미터 값이 제공되지 않았음 |
|||
bad_request : 잘못된 커서가 전달됨 |
|||
message | String | 필수 |
오류 원인에 대한 설명 |
users.set_work_time
특정 멤버의 근무시간을 업데이트합니다.
Request
Request Syntax
코드예제users.set_work_time Request Syntax
curl -X POST https://api.kakaowork.com/v1/users.set_work_time \
-H "Authorization: Bearer {YOUR_APP_KEY}" \
-H "Content-Type: application/json;charset=utf-8" \
-d '{
"user_id": "{USER_ID}",
"work_start_time": {WORK_START_TIME},
"work_end_time": {WORK_END_TIME}}'
메서드 | 요청 URL |
---|---|
POST | https://api.kakaowork.com/v1/users.set_work_time |
Request Header
Request Header에 대한 상세는 다음과 같습니다.
표users.set_work_time Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
Authorization | String | 필수 |
Bearer {YOUR_APP_KEY} - {YOUR_APP_KEY} : Bot 등록 요청 후에 획득한 인증키(App Key) |
Content-Type | String | 선택 |
application/json 또는 application/x-www-form-urlencoded |
Request Elements
Request Elements에 대한 상세는 다음과 같습니다.
표users.set_work_time Request Elements파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
user_id | String | 필수 |
근무 시간을 변경할 멤버의 정보로 다음 값이 올 수 있음 - 멤버 ID - display_identifier 값 - email 주소 |
work_start_time | Timestamp | 필수 |
근무 시작 시간(Unix time 값) |
work_end_time | Timestamp | 필수 |
근무 종료 시간(Unix time 값) |
user_id_type | String | 선택 |
user_id 타입에 대한 고정값 |
멤버 ID: 파라미터 필요 없음 | |||
key : display_identifier 사용 시 |
|||
email : email 사용 시 |
안내
work_start_time 및 work_end_time 값을 모두0
으로 설정하면 근무 시간 설정이 해제됩니다.
user_id_type에 따라 user_id 형태는 변경됩니다.
Response
Response Syntax
코드예제users.set_work_time Response Syntax
{
"success": true
}
Response Elements
Response Elements에 대한 상세는 다음과 같습니다.
표users.set_work_time Response Elements필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
success | Boolean | 필수 |
API 호출 실행 결과 |
true : 성공 |
|||
false : 실패, error 필드와 함께 반환 |
|||
Object | 선택 |
API 실행 오류 정보 - API 호출 실패( false )일 경우 제공 |
|
code | String | 필수 |
오류 상황을 구분하는 코드 |
invalid_parameter : 제공된 파라미터의 값이 올바르지 않음 |
|||
invalid_authentication : 제공된 인증키가 유효하지 않음 |
|||
api_not_found : 요청 API의 URL 혹은 HTTP 메서드와 다름 |
|||
unauthorized : 인증키가 제공되지 않음 |
|||
internal_server_error : 정의되지 않은 서버 오류 발생 |
|||
expired_authentication : 제공된 인증키가 만료됨 |
|||
invalid_content_type : 요청이 API가 요구하는 Content Type과 다름 |
|||
missing_parameter : 필요한 파라미터 값이 제공되지 않았음 |
|||
user_not_found : 멤버를 찾을 수 없음 |
|||
message | String | 필수 |
오류 원인에 대한 설명 |
users.set_vacation_time
특정 멤버의 휴가 시간을 업데이트합니다.
Request
Request Syntax
코드예제users.set_vacation_time Request Syntax
curl -X POST https://api.kakaowork.com/v1/users.set_vacation_time \
-H "Authorization: Bearer {YOUR_APP_KEY}" \
-H "Content-Type: application/json;charset=utf-8" \
-d '{
"user_id": "{USER_ID}",
"vacation_start_time": {VACATION_START_TIME},
"vacation_end_time": {VACATION_END_TIME}}'
메서드 | 요청 URL |
---|---|
POST | https://api.kakaowork.com/v1/users.set_vacation_time |
Request Header
Request Header에 대한 상세는 다음과 같습니다.
표users.set_vacation_time Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
Authorization | String | 필수 |
Bearer {YOUR_APP_KEY} - {YOUR_APP_KEY} : Bot 등록 요청 후에 획득한 인증키(App Key) |
Content-Type | String | 선택 |
application/json 또는 application/x-www-form-urlencoded |
Request Elements
Request Elements에 대한 상세는 다음과 같습니다.
표users.set_vacation_time Request Elements파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
user_id | String | 필수 |
휴가 시간을 변경할 멤버의 정보로 다음 값이 올 수 있음 - 멤버 ID - display_identifier 값 - email 주소 |
vacation_start_time | Timestamp | 필수 |
휴가 시작 시간(Unix Time 값) |
vacation_end_time | Timestamp | 필수 |
휴가 종료 시간(Unix Time 값) |
user_id_type | String | 선택 |
user_id 타입에 대한 고정값 |
멤버 ID: 파라미터 필요 없음 | |||
key : display_identifier 사용 시 |
|||
email : email 사용 시 |
Response
Response Syntax
코드예제users.set_vacation_time Response Syntax
{
"success": true
}
Response Elements
Response Elements에 대한 상세는 다음과 같습니다.
표users.set_vacation_time Response Elements필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
success | Boolean | 필수 |
API 호출 실행 결과 |
true : 성공 |
|||
false : 실패, error 필드와 함께 반환 |
|||
Object | 선택 |
API 실행 오류 정보 - API 호출 실패( false )일 경우 제공 |
|
code | String | 필수 |
오류 상황을 구분하는 코드 |
invalid_parameter : 제공된 파라미터의 값이 올바르지 않음 |
|||
invalid_authentication : 제공된 인증키가 유효하지 않음 |
|||
api_not_found : 요청 API의 URL 혹은 HTTP 메서드와 다름 |
|||
unauthorized : 인증키가 제공되지 않음 |
|||
internal_server_error : 정의되지 않은 서버 오류 발생 |
|||
expired_authentication : 제공된 인증키가 만료됨 |
|||
invalid_content_type : 요청이 API가 요구하는 Content Type과 다름 |
|||
missing_parameter : 필요한 파라미터 값이 제공되지 않았음 |
|||
user_not_found : 멤버를 찾을 수 없음 |
|||
message | String | 필수 |
오류 원인에 대한 설명 |
/batch/users.set_work_time
여러 멤버의 근무 시간을 최대 100명까지 동시에 업데이트합니다.
Request
Request Syntax
코드예제/batch/users.set_work_time Request Syntax
curl -X POST https://api.kakaowork.com/v1/batch/users.set_work_time \
-H "Authorization: Bearer {YOUR_APP_KEY}" \
-H "Content-Type: application/json;charset=utf-8" \
-d '{"user_work_times":[{
"user_id":{USER_ID},
"work_start_time":{WORK_START_TIME},
"work_end_time":{WORK_END_TIME}}]}'
메서드 | 요청 URL |
---|---|
POST | https://api.kakaowork.com/v1/batch/users.set_work_time |
Request Header
Request Header에 대한 상세는 다음과 같습니다.
표/batch/users.set_work_time Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
Authorization | String | 필수 |
Bearer {YOUR_APP_KEY} - {YOUR_APP_KEY} : Bot 등록 요청 후에 획득한 인증키(App Key) |
Content-Type | String | 선택 |
application/json 또는 application/x-www-form-urlencoded |
Request Elements
Request Elements에 대한 상세는 다음과 같습니다.
표/batch/users.set_work_time Request Elements파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
Object[] | 필수 |
근무 시간을 업데이트할 멤버 정보 리스트 - 최대 100명 |
|
user_id | String | 필수 |
근무 시간을 업데이트할 멤버의 정보로 다음 값이 올 수 있음 - 멤버 ID - display_identifier 값 - email 주소 |
work_start_time | Timestamp | 필수 |
근무 시작 시간(Unix time 값) |
work_end_time | Timestamp | 필수 |
근무 종료 시간(Unix time 값) |
user_id_type | String | 선택 |
user_id 타입에 대한 고정값 |
멤버 ID: 파라미터 필요 없음 | |||
key : display_identifier 사용 시 |
|||
email : email 사용 시 |
Response
Response Syntax
코드예제/batch/users.set_work_time Response Syntax
{
"success": true,
"users": [
{
"id": "1",
"work_end_time": 1622687365,
"work_start_time": 1622509200
}
]
}
Response Elements
Response Elements에 대한 상세는 다음과 같습니다.
표/batch/users.set_work_time Response Elements필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
success | Boolean | 필수 |
API 호출 실행 결과 |
true : 성공 |
|||
false : 실패, error 필드와 함께 반환 |
|||
Object[] | 선택 |
API 호출 실행 결과 | |
id | String | 필수 |
멤버의 ID |
work_start_time | Timestamp | 필수 |
근무 시작 시간(Unix time 값) |
work_end_time | Timestamp | 필수 |
근무 종료 시간(Unix time 값) |
Object | 선택 |
API 실행 오류 정보 - API 호출 실패( false )일 경우 제공 |
|
code | String | 필수 |
오류 상황을 구분하는 코드 |
invalid_parameter : 제공된 파라미터의 값이 올바르지 않음 |
|||
invalid_authentication : 제공된 인증키가 유효하지 않음 |
|||
api_not_found : 요청 API의 URL 혹은 HTTP 메서드와 다름 |
|||
unauthorized : 인증키가 제공되지 않음 |
|||
internal_server_error : 정의되지 않은 서버 오류 발생 |
|||
expired_authentication : 제공된 인증키가 만료됨 |
|||
invalid_content_type : 요청이 API가 요구하는 Content Type과 다름 |
|||
missing_parameter : 필요한 파라미터 값이 제공되지 않았음 |
|||
user_not_found : 멤버를 찾을 수 없음 |
|||
message | String | 필수 |
오류 원인에 대한 설명 |
/batch/users.set_vacation_time
여러 멤버의 휴가 시간을 최대 100명까지 동시에 업데이트합니다.
Request
Request Syntax
코드예제/batch/users.set_vacation_time Request Syntax
curl -X POST https://api.kakaowork.com/v1/batch/users.set_vacation_time \
-H "Authorization: Bearer {YOUR_APP_KEY}" \
-H "Content-Type: application/json;charset=utf-8" \
-d '{"user_vacation_times":[{
"user_id":{USER_ID},
"vacation_start_time":{VACATION_START_TIME},
"vacation_end_time":{VACATION_END_TIME}}]}'
메서드 | 요청 URL |
---|---|
POST | https://api.kakaowork.com/v1/batch/users.set_vacation_time |
Request Header
Request Header에 대한 상세는 다음과 같습니다.
표/batch/users.set_vacation_time Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
Authorization | String | 필수 |
Bearer {YOUR_APP_KEY} - {YOUR_APP_KEY} : Bot 등록 요청 후에 획득한 인증키(App Key) |
Content-Type | String | 선택 |
application/json 또는 application/x-www-form-urlencoded |
Request Elements
Request Elements에 대한 상세는 다음과 같습니다.
표/batch/users.set_vacation_time Request Elements파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
Object[] | 필수 |
휴가 시간을 업데이트할 멤버 정보 리스트 - 최대 100명 |
|
user_id | String | 필수 |
휴가 시간을 업데이트할 멤버의 정보로 다음 값이 올 수 있음 - 멤버 ID - display_identifier 값 - email 주소 |
vacation_start_time | Timestamp | 필수 |
휴가 시작 시간(Unix Time 값) |
vacation_end_time | Timestamp | 필수 |
휴가 종료 시간(Unix Time 값) |
user_id_type | String | 선택 |
user_id 타입에 대한 고정값 |
멤버 ID: 파라미터 필요 없음 | |||
key : display_identifier 사용 시 |
|||
email : email 사용 시 |
Response
Response Syntax
코드예제/batch/users.set_vacation_time Response Syntax
{
"success": true,
"users": [
{
"id": 2,
"vacation_end_time": 1622687365,
"vacation_start_time": 1622509200
}
]
}
Response Elements
Response Elements에 대한 상세는 다음과 같습니다.
표/batch/users.set_vacation_time Response Elements필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
success | Boolean | 필수 |
API 호출 실행 결과 |
true : 성공 |
|||
false : 실패, error 필드와 함께 반환 |
|||
Object[] | 선택 |
API 호출 실행 결과 | |
id | String | 필수 |
휴가 시간을 업데이트할 멤버의 ID |
vacation_start_time | Timestamp | 필수 |
휴가 시작 시간(Unix time 값) |
vacation_end_time | Timestamp | 필수 |
휴가 종료 시간(Unix time 값) |
Object | 선택 |
API 실행 오류 정보 - API 호출 실패( false )일 경우 제공 |
|
code | String | 필수 |
오류 상황을 구분하는 코드 |
invalid_parameter : 제공된 파라미터의 값이 올바르지 않음 |
|||
invalid_authentication : 제공된 인증키가 유효하지 않음 |
|||
api_not_found : 요청 API의 URL 혹은 HTTP 메서드와 다름 |
|||
unauthorized : 인증키가 제공되지 않음 |
|||
internal_server_error : 정의되지 않은 서버 오류 발생 |
|||
expired_authentication : 제공된 인증키가 만료됨 |
|||
invalid_content_type : 요청이 API가 요구하는 Content Type과 다름 |
|||
missing_parameter : 필요한 파라미터 값이 제공되지 않았음 |
|||
user_not_found : 멤버를 찾을 수 없음 |
|||
message | String | 필수 |
오류 원인에 대한 설명 |
/batch/users.reset_work_time
여러 멤버의 근무 시간을 최대 100명까지 초기화합니다.
Request
Request Syntax
코드예제/batch/users.reset_work_time Request Syntax
curl -X POST https://api.kakaowork.com/v1/batch/users.reset_work_time \
-H "Authorization: Bearer {YOUR_APP_KEY}" \
-H "Content-Type: application/json;charset=utf-8" \
-d '{ "user_ids": [{USER_ID}, ...]}'
메서드 | 요청 URL |
---|---|
POST | https://api.kakaowork.com/v1/batch/users.reset_work_time |
Request Header
Request Header에 대한 상세는 다음과 같습니다.
표/batch/users.reset_work_time Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
Authorization | String | 필수 |
Bearer {YOUR_APP_KEY} - {YOUR_APP_KEY} : Bot 등록 요청 후에 획득한 인증키(App Key) |
Content-Type | String | 선택 |
application/json 또는 application/x-www-form-urlencoded |
Request Elements
Request Elements에 대한 상세는 다음과 같습니다.
표/batch/users.reset_work_time Request Elements파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
user_ids | String[] | 필수 |
근무 시간을 초기화할 멤버의 정보로 다음 값이 올 수 있음 - 멤버 ID(최대 100명) - display_identifier 값 - email 주소 |
user_id_type | String | 선택 |
user_id 타입에 대한 고정값 |
멤버 ID: 파라미터 필요 없음 | |||
key : display_identifier 사용 시 |
|||
email : email 사용 시 |
Response
Response Syntax
코드예제/batch/users.reset_work_time Response Syntax
{
"success": true
}
Response Elements
Response Elements에 대한 상세는 다음과 같습니다.
표/batch/users.reset_work_time Response Elements파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
success | Boolean | 필수 |
API 호출 실행 결과 |
true : 성공 |
|||
false : 실패, error 필드와 함께 반환 |
|||
Object | 선택 |
API 실행 오류 정보 - API 호출 실패( false )일 경우 제공 |
|
code | String | 필수 |
오류 상황을 구분하는 코드 |
invalid_parameter : 제공된 파라미터의 값이 올바르지 않음 |
|||
invalid_authentication : 제공된 인증키가 유효하지 않음 |
|||
api_not_found : 요청 API의 URL 혹은 HTTP 메서드와 다름 |
|||
unauthorized : 인증키가 제공되지 않음 |
|||
internal_server_error : 정의되지 않은 서버 오류 발생 |
|||
expired_authentication : 제공된 인증키가 만료됨 |
|||
invalid_content_type : 요청이 API가 요구하는 Content Type과 다름 |
|||
missing_parameter : 필요한 파라미터 값이 제공되지 않았음 |
|||
user_not_found : 멤버를 찾을 수 없음 |
|||
message | String | 필수 |
오류 원인에 대한 설명 |
/batch/users.reset_vacation_time
여러 멤버의 휴가 시간을 최대 100명까지 초기화합니다.
Request
Request Syntax
코드예제/batch/users.reset_vacation_time Request Syntax
curl -X POST https://api.kakaowork.com/v1/batch/users.reset_vacation_time \
-H "Authorization: Bearer {YOUR_APP_KEY}" \
-H "Content-Type: application/json;charset=utf-8" \
-d '{ "user_ids": [{USER_ID}, ...]}'
메서드 | 요청 URL |
---|---|
POST | https://api.kakaowork.com/v1/batch/users.reset_vacation_time |
Request Header
Request Header에 대한 상세는 다음과 같습니다.
표/batch/users.reset_vacation_time Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
Authorization | String | 필수 |
Bearer {YOUR_APP_KEY} - {YOUR_APP_KEY} : Bot 등록 요청 후에 획득한 인증키(App Key) |
Content-Type | String | 선택 |
application/json 또는 application/x-www-form-urlencoded |
Request Elements
Request Elements에 대한 상세는 다음과 같습니다.
표/batch/users.reset_vacation_time Request Elements파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
user_ids | String[] | 필수 |
휴가 시간을 초기화할 멤버의 정보로 다음 값이 올 수 있음 - 멤버 ID(최대 100명) - display_identifier 값 - email 주소 |
user_id_type | String | 선택 |
user_id 타입에 대한 고정값 |
멤버 ID: 파라미터 필요 없음 | |||
key : display_identifier 사용 시 |
|||
email : email 사용 시 |
Response
Response Syntax
코드예제users.reset_vacation_time Response Syntax
{
"success": true
}
Response Elements
Response Elements에 대한 상세는 다음과 같습니다.
표/batch/users.reset_vacation_time Response Elements필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
success | Boolean | 필수 |
API 호출 실행 결과 |
true : 성공 |
|||
false : 실패, error 필드와 함께 반환 |
|||
Object | 선택 |
API 실행 오류 정보 - API 호출 실패( false )일 경우 제공 |
|
code | String | 필수 |
오류 상황을 구분하는 코드 |
invalid_parameter : 제공된 파라미터의 값이 올바르지 않음 |
|||
invalid_authentication : 제공된 인증키가 유효하지 않음 |
|||
api_not_found : 요청 API의 URL 혹은 HTTP 메서드와 다름 |
|||
unauthorized : 인증키가 제공되지 않음 |
|||
internal_server_error : 정의되지 않은 서버 오류 발생 |
|||
expired_authentication : 제공된 인증키가 만료됨 |
|||
invalid_content_type : 요청이 API가 요구하는 Content Type과 다름 |
|||
missing_parameter : 필요한 파라미터 값이 제공되지 않았음 |
|||
user_not_found : 멤버를 찾을 수 없음 |
|||
message | String | 필수 |
오류 원인에 대한 설명 |
/batch/resilience/users.set_vacation_time
여러 멤버의 휴가 시간을 최대 100명까지 업데이트 합니다.
Request
Request Syntax
코드예제/batch/users.reset_vacation_time Request Syntax
curl -X POST https://api.kakaowork.com/v1/batch/resilience/users.set_vacation_time \
-H "Authorization: Bearer {YOUR_APP_KEY}" \
-H "Content-Type: application/json;charset=utf-8" \
-d '{"user_vacation_times":[
{
"user_id":{USER_ID},
"vacation_start_time":{VACATION_START_TIME},
"vacation_end_time":{VACATION_END_TIME}
},...
],
"user_id_type" : {USER_ID_TYPE}
}'
코드예제"user_id_type" : "key"
curl -X POST https://api.kakaowork.com/v1/batch/resilience/users.set_vacation_time \
-H "Authorization: Bearer {YOUR_APP_KEY}" \
-H "Content-Type: application/json;charset=utf-8" \
-d '{"user_vacation_times":[
{
"user_id": "test_user",,
"vacation_start_time":1678867200,
"vacation_end_time":1716610800
},...
],
"user_id_type" : "key"
}'
코드예제 "user_id_type" : "email"
curl -X POST https://api.kakaowork.com/v1/batch/resilience/users.set_vacation_time \
-H "Authorization: Bearer {YOUR_APP_KEY}" \
-H "Content-Type: application/json;charset=utf-8" \
-d '{"user_vacation_times":[
{
"user_id":"test_user@test.com",
"vacation_start_time":1678867200,
"vacation_end_time":1716610800
},...
],
"user_id_type" : "email"
}'
코드예제"user_id_type" : "null"
curl -X POST https://api.kakaowork.com/v1/batch/resilience/users.set_vacation_time \
-H "Authorization: Bearer {YOUR_APP_KEY}" \
-H "Content-Type: application/json;charset=utf-8" \
-d '{"user_vacation_times":[
{
"user_id":"4321212",
"vacation_start_time":1678867200,
"vacation_end_time":1716610800
},...
]
}'
메서드 | 요청 URL |
---|---|
POST | https://api.kakaowork.com/v1/batch/resilience/users.set_vacation_time |
Request Header
Request Header에 대한 상세는 다음과 같습니다.
표/batch/resilience/users.set_vacation_time Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
Authorization | String | 필수 |
Bearer {YOUR_APP_KEY} - {YOUR_APP_KEY} : Bot 등록 요청 후에 획득한 인증키(App Key) |
Content-Type | String | 선택 |
application/json 또는 application/x-www-form-urlencoded |
Request Elements
Request Elements에 대한 상세는 다음과 같습니다.
표/batch/users.set_vacation_time Request Elements파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
user_vacation_times | Object[] | 필수 |
휴가 시간을 업데이트할 멤버 정보 리스트 - 최대 100명 |
user_id | String | 필수 |
휴가 시간을 업데이트할 멤버의 정보로 다음 값이 올 수 있음 - 멤버 ID - display_identifier 값 - email 주소 |
vacation_start_time | Timestamp | 필수 |
휴가 시작 시간(Unix time 값) |
vacation_end_time | Timestamp | 필수 |
휴가 종료 시간(Unix time 값) |
user_id_type | String | 선택 |
user_id 타입에 대한 고정값 |
멤버 ID: 파라미터 필요 없음 | |||
key : display_identifier 사용 시 |
|||
email : email 사용 시 |
Response
Response Syntax
코드예제/batch/resilience/users.set_vacation_time Response Syntax
{
"failed": 2,
"failed_times": [
{
"message": "user_not_found",
"user_id": "test.user2",
"vacation_end_time": 1622687365,
"vacation_start_time": 1622509200
},
{
"message": "invalid_parameter",
"user_id": "test.user1",
"vacation_end_time":1622509200,
"vacation_start_time": 1622509200
},
{
"message": "user_not_found",
"user_id": "test.user0",
"vacation_end_time": 0,
"vacation_start_time": 0
}
],
"success": 97,
"total": 100
}
Response Elements
Response Elements에 대한 상세는 다음과 같습니다.
표/batch/users.reset_vacation_time Response Elements파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
success | Boolean | 필수 |
API 호출 실행 결과 |
true : 성공 |
|||
false : 실패, error 필드와 함께 반환 |
|||
set_users | Object[] | 선택 |
API 호출 실행 결과 |
id | String | 필수 |
휴가 시간 업데이트 멤버의 ID |
vacation_start_time | Timestamp | 필수 |
휴가 시작 시간(Unix time 값) - 휴가 리셋 시간: 0 |
vacation_end_time | Timestamp | 필수 |
휴가 종료 시간(Unix time 값) - 휴가 리셋 시간: 0 |
reset_user_ids | list[] | 필수 |
휴가 시간 초기화 멤버의 ID |
Object | 선택 |
API 실행 오류 정보 - API 호출 실패( false )일 경우 제공 |
|
code | String | 필수 |
오류 상황을 구분하는 코드 |
invalid_parameter : 제공된 파라미터의 값이 올바르지 않음 |
|||
invalid_authentication : 제공된 인증키가 유효하지 않음 |
|||
api_not_found : 요청 API의 URL 혹은 HTTP 메서드와 다름 |
|||
unauthorized : 인증키가 제공되지 않음 |
|||
internal_server_error : 정의되지 않은 서버 오류 발생 |
|||
expired_authentication : 제공된 인증키가 만료됨 |
|||
invalid_content_type : 요청이 API가 요구하는 Content Type과 다름 |
|||
missing_parameter : 필요한 파라미터 값이 제공되지 않았음 |
|||
user_not_found : 멤버를 찾을 수 없음 |
|||
message | String | 필수 |
오류 원인에 대한 설명 |
/batch/resilience/users.set_work_time
여러 멤버의 근무 시간을 최대 100명까지 업데이트 합니다.
Request
Request Syntax
코드예제/batch/users.reset_work_time Request Syntax
curl -X POST https://api.kakaowork.com/v1/batch/resilience/users.set_work_time \
-H "Authorization: Bearer {YOUR_APP_KEY}" \
-H "Content-Type: application/json;charset=utf-8" \
-d '{"user_work_times":[
{
"user_id":{USER_ID},
"work_start_time":{WORK_START_TIME},
"work_end_time":{WORK_END_TIME}
},...
],
"user_id_type" : {USER_ID_TYPE}
}'
코드예제"user_id_type" : "key"
curl -X POST https://api.kakaowork.com/v1/batch/resilience/users.set_work_time \
-H "Authorization: Bearer {YOUR_APP_KEY}" \
-H "Content-Type: application/json;charset=utf-8" \
-d '{"user_work_times":[
{
"user_id": "test_user",
"work_start_time":1678867200,
"work_end_time":1716610800
},...
],
"user_id_type" : "key"
}'
코드예제 "user_id_type" : "email"
curl -X POST https://api.kakaowork.com/v1/batch/resilience/users.set_work_time \
-H "Authorization: Bearer {YOUR_APP_KEY}" \
-H "Content-Type: application/json;charset=utf-8" \
-d '{"user_work_times":[
{
"user_id": "test_user@test.com",
"work_start_time":1678867200,
"work_end_time":1716610800
},...
],
"user_id_type" : "email"
}'
코드예제"user_id_type" : "null"
curl -X POST https://api.kakaowork.com/v1/batch/resilience/users.set_work_time \
-H "Authorization: Bearer {YOUR_APP_KEY}" \
-H "Content-Type: application/json;charset=utf-8" \
-d '{"user_work_times":[
{
"user_id": "4321212",
"work_start_time":1678867200,
"work_end_time":1716610800
},...
]
}'
메서드 | 요청 URL |
---|---|
POST | https://api.kakaowork.com/v1/batch/resilience/users.set_work_time |
Request Header
Request Header에 대한 상세는 다음과 같습니다.
표/batch/resilience/users.set_work_time Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
Authorization | String | 필수 |
Bearer {YOUR_APP_KEY} - {YOUR_APP_KEY} : Bot 등록 요청 후에 획득한 인증키(App Key) |
Content-Type | String | 선택 |
application/json 또는 application/x-www-form-urlencoded |
Request Elements
Request Elements에 대한 상세는 다음과 같습니다.
표/batch/users.set_vacation_time Request Elements파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
user_work_times | Object[] | 필수 |
근무 시간을 업데이트할 멤버 정보 리스트 - 최대 100명 |
user_id | String | 필수 |
근무 시간을 업데이트할 멤버의 정보로 다음 값이 올 수 있음 - 멤버 ID - display_identifier 값 - email 주소 |
work_start_time | Timestamp | 필수 |
근무 시작 시간(Unix time 값) |
work_end_time | Timestamp | 필수 |
근무 종료 시간(Unix time 값) |
user_id_type | String | 선택 |
user_id 타입에 대한 고정값 |
멤버 ID: 파라미터 필요 없음 | |||
key : display_identifier 사용 시 |
|||
email : email 사용 시 |
Response
Response Syntax
코드예제/batch/resilience/users.set_work_time Response Syntax
{
"failed": 2,
"failed_times": [
{
"message": "user_not_found",
"user_id": "test.user2",
"work_end_time": 1622687365,
"work_start_time": 1622509200
},
{
"message": "invalid_parameter",
"user_id": "test.user1",
"work_end_time":1622509200,
"work_start_time": 1622509200
},
{
"message": "user_not_found",
"user_id": "test.user0",
"work_end_time": 0,
"work_start_time": 0
}
],
"success": 97,
"total": 100
}
Response Elements
Response Elements에 대한 상세는 다음과 같습니다.
표/batch/resilience/users.set_work_time Response Elements파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
success | Boolean | 필수 |
API 호출 실행 결과 |
true : 성공 |
|||
false : 실패, error 필드와 함께 반환 |
|||
set_users | Object[] | 선택 |
API 호출 실행 결과 |
id | String | 필수 |
근무시간 업데이트 멤버의 ID |
work_start_time | Timestamp | 필수 |
근무 시작 시간(Unix time 값) - 근무 리셋 시간: 0 |
work_end_time | Timestamp | 필수 |
근무 종료 시간(Unix time 값) - 근무 리셋 시간: 0 |
reset_user_ids | list[] | 필수 |
근무 시간 초기화 멤버의 ID |
Object | 선택 |
API 실행 오류 정보 - API 호출 실패( false )일 경우 제공 |
|
code | String | 필수 |
오류 상황을 구분하는 코드 |
invalid_parameter : 제공된 파라미터의 값이 올바르지 않음 |
|||
invalid_authentication : 제공된 인증키가 유효하지 않음 |
|||
api_not_found : 요청 API의 URL 혹은 HTTP 메서드와 다름 |
|||
unauthorized : 인증키가 제공되지 않음 |
|||
internal_server_error : 정의되지 않은 서버 오류 발생 |
|||
expired_authentication : 제공된 인증키가 만료됨 |
|||
invalid_content_type : 요청이 API가 요구하는 Content Type과 다름 |
|||
missing_parameter : 필요한 파라미터 값이 제공되지 않았음 |
|||
user_not_found : 멤버를 찾을 수 없음 |
|||
message | String | 필수 |
오류 원인에 대한 설명 |