Kakao Work::Web API 레퍼런스

페이지 이동경로

카카오워크 Web API

카카오워크(Kakao Work)의 Web API는 워크스페이스에서 Bot과 멤버가 대화를 하기 위해 필요한 정보를 조회하고, 관련 정보를 적용하는데 필요한 인터페이스입니다.
카카오워크의 Web API는 HTTP Remote Procedure Call(이하 RPC) 스타일의 API를 제공합니다. HTTP RPC 스타일은 리소스 중심의 REST API와는 달리, 종류별로 그룹 지어진 기능들을 URL로 표현하여 API를 구분합니다.

Web API의 URL

카카오워크 Web API의 URL은 다음과 같은 형식을 따릅니다.

코드예제Web API의 URL 형식
https://api.kakaowork.com/v1/{API 종류}.{API 이름}
API 상세
분류 설명
API 종류 각 API는 기능 영역별로 분류되어 제공
Users 사용자 정보를 다루는 API
Conversations 채팅방을 다루는 API
Messages 메시지를 다루는 API
Reactive 반응형 대화를 진행하기 위한 API
Departments 특정 워크스페이스에 속한 부서 정보를 조회하는 API
Spaces 특정 워크스페이스 정보를 조회하는 API
Bots 특정 Bot 정보를 조회하는 API
API 이름 기능 영역별로 분류된 API 종류 중에서 각 액션을 수행하는 API 명을 지칭

예를 들어, 워크스페이스에 속한 멤버의 상세 정보를 조회하는 API는 다음과 같이 표현할 수 있습니다.

코드예제Web API의 URL 예시
https://api.kakaowork.com/v1/users.info

Web API 리스트

본 가이드에서는 다음의 Web API에 대한 자세한 설명을 제공합니다.

Web API 리스트
API 종류 API 명 설명
Users users.info 특정 멤버의 상세 정보 획득
users.find_by_email 이메일 주소로 워크스페이스 멤버의 정보 획득
users.find_by_phone_number 전화번호로 워크스페이스 멤버의 정보 획득
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명까지 초기화
Conversations conversations.open Bot과 멤버 간 채팅방 생성
conversations.list Bot이 생성한 채팅방 조회
conversations.users Bot이 생성한 채팅방에 있는 사용자 리스트 조회
conversations.invite Bot이 생성한 특정 채팅방에 사용자를 초대
conversations.kick Bot이 생성한 특정 채팅방에 있는 사용자를 내보내기
Messages messages.send 특정 채팅방에 새로운 메시지를 전송
messages.send_by_email 이메일(Email)로 사용자를 찾고, 1:1 채팅방에 메시지를 전송
messages.send_by 전달받은 이메일 주소또는 Key 값을 사용하여 사용자와의 1:1 채팅방에 메시지를 전송
Reactive submit_action 사용자의 정보와 메시지의 정보를 고객사 서버로 전달
request_modal Modal을 구성하는 JSON 정보를 받음
submit_modal 사용자의 입력 정보를 고객사 서버에 최종 전달
Departments departments.list 특정 워크스페이스에 속한 전체 부서 목록과 상세 정보 조회
Spaces spaces.info 워크스페이스의 정보를 조회
Bots bots.info Bot의 정보를 조회

관련 문서

Bot 시작 가이드 Kakao Work Web API 레퍼런스 Kakao Work Block Kit 구성 및 정책 Kakao Work Bot 메시지 시나리오 Kakao Work

이 문서가 만족스러운 이유를 알려주세요.
이 문서에 아쉬운 점을 알려주세요.
평가해주셔서 감사합니다.

더 자세한 의견은 documentation@kakaoenterprise.com 으로 제보해주세요.