https://docs.kakaowork.com/kakao_work/webapireference/ Recent content in Web API 레퍼런스 on 카카오워크 기술문서 Hugo -- gohugo.io ko-kr © Kakao Corp. https://docs.kakaowork.com/kakao_work/webapireference/commonguide/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.kakaowork.com/kakao_work/webapireference/commonguide/ API 공통 가이드 API 공통 가이드는 카카오워크 Web API를 사용하여 Bot을 개발할 때 미리 알아야 하는 내용을 설명합니다. 표API 공통 사항 공통 사항 설명 HTTP/HTTPS 사용 가능 Extension Service API는 HTTP와 HTTPS 프로토콜 모두 사용 가능 API 사용 제한 원활한 카카오워크 서비스 제공을 위하여 과도한 API 사용은 예고 없이 제한될 수 있음 - 구체적인 제한 사항은 추후 확정될 예정 - API 사용에서 지속적인 제한이 발생한다면 호출 빈도를 조절하여 사용 가능 API Request 카카오워크에서 제공하고 있는 API의 요청 URL 형태는 다음과 같습니다. https://docs.kakaowork.com/kakao_work/webapireference/users/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.kakaowork.com/kakao_work/webapireference/users/ Users 워크스페이스(Workspace)에 가입한 멤버의 정보를 조회하거나 업데이트하기 위해 다음과 같은 API를 사용합니다. 표Users API 리스트 구분 API 명 설명 정보 조회 users.info 멤버의 고유 정보인 user_id로 멤버의 상세 정보를 조회 users.find_by_email 이메일로 카카오워크에 가입 및 인증한 멤버의 상세 정보 조회 users.list 특정 워크스페이스의 전체 멤버 목록과 멤버 별 상세 정보 조회 정보 업데이트 users.set_work_time 특정 멤버의 근무 시간을 업데이트 users. https://docs.kakaowork.com/kakao_work/webapireference/conversations/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.kakaowork.com/kakao_work/webapireference/conversations/ Conversations 채팅방을 생성하기 위해 다음과 같은 API를 사용합니다. 표Conversations API 리스트 API 명 설명 conversations.open Bot과 멤버 간 채팅방 생성 conversations.list Bot이 생성한 채팅방 조회 conversations.users Bot이 생성한 채팅방에 있는 사용자 목록 조회 conversations.invite Bot이 생성한 특정 채팅방에 사용자를 초대 conversations.kick Bot이 생성한 특정 채팅방에 있는 사용자를 내보내기 conversations.edit Bot이 생성한 단체 채팅방(group 타입)의 설정 변경 conversations. https://docs.kakaowork.com/kakao_work/webapireference/messages/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.kakaowork.com/kakao_work/webapireference/messages/ Messages 특정 채팅방에 신규 메시지를 전송하거나 사용자의 이메일 주소를 통해 1:1 채팅방에 메시지를 전송하는 API는 다음과 같습니다. 표Messages API 리스트 API 명 설명 messages.send 채팅방의 ID를 사용하여 특정 채팅방에 새로운 메시지를 전송 messages.send_by_email 이메일 주소를 통해 특정 사용자를 찾고, 1:1 채팅방에 메시지를 전송 messages.send_by 전달받은 이메일 주소 또는 Key 값을 사용하여 사용자와의 1:1 채팅방에 메시지를 전송 messages. https://docs.kakaowork.com/kakao_work/webapireference/reactive/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.kakaowork.com/kakao_work/webapireference/reactive/ 반응형 메시지 반응형 대화에서 특정 액션 타입이 지정된 버튼을 통해 멤버의 의견을 전달받고, 다음 시나리오로 이어나갈 때 submit_action API를 사용합니다. submit_action API를 사용하기 위해서는 말풍선 구성 시에 Button Block의 action_type을 submit_action으로 설정해야 합니다. 표Submit API 리스트 API 명 설명 submit_action 사용자가 선택한 Button의 정보와 멤버 ID, 해당 메시지의 정보를 고객사 서버로 전달 안내 Block Kit 블록에 대한 자세한 사항은 Block Kit 구성 및 정책 문서를 참고하시기 바랍니다. https://docs.kakaowork.com/kakao_work/webapireference/organization/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.kakaowork.com/kakao_work/webapireference/organization/ Organization 워크스페이스에서 부서, 직위, 직책과 같은 조직도 정보를 조회하기 위해 다음과 같은 API를 사용합니다. 표Organization API 리스트 구분 API 명 설명 부서 정보 조회 departments.list 특정 워크스페이스에 속한 전체 부서 목록 및 상세 정보 조회 직위 정보 조회 positions.list 특정 워크스페이스에 속한 전체 직위 목록 및 상세 정보 조회 직책 정보 조회 responsibilities.list 특정 워크스페이스에 속한 전체 직책 목록 및 상세 정보 조회 departments. https://docs.kakaowork.com/kakao_work/webapireference/spaces/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.kakaowork.com/kakao_work/webapireference/spaces/ Spaces 특정 워크스페이스의 정보를 조회하기 위해 다음과 같은 API를 사용합니다. 표Spaces API 리스트 구분 API 명 설명 정보 조회 spaces.info 워크스페이스의 정보 조회 spaces.info 워크스페이스의 정보를 조회합니다. Request Request Syntax 코드예제space.info Request Syntax BASH curl -X GET https://api.kakaowork.com/v1/spaces.info \ -H "Authorization: Bearer {YOUR_APP_KEY}" \ -H "Content-Type: application/json;charset=utf-8" 표API 호출 방식 메서드 요청 URL GET https://api. https://docs.kakaowork.com/kakao_work/webapireference/bots/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.kakaowork.com/kakao_work/webapireference/bots/ Bots 특정 Bot의 정보를 조회하기 위해 다음과 같은 API를 사용합니다. 표Bots API 리스트 구분 API 명 설명 정보 조회 bots.info 특정 Bot의 정보 조회 bots.info Bot의 정보를 조회합니다. Request Request Syntax 코드예제bots.info Request Syntax BASH curl -X GET https://api.kakaowork.com/v1/bots.info \ -H "Authorization: Bearer {YOUR_APP_KEY}" \ -H "Content-Type: application/json;charset=utf-8" 표API 호출 방식 메서드 요청 URL GET https://api. https://docs.kakaowork.com/kakao_work/webapireference/auth/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.kakaowork.com/kakao_work/webapireference/auth/ Auth 카카오워크가 Bot 서버로 전달하는 요청을 검증하기 위해 다음과 같은 API를 사용합니다. 표Auth API 리스트 구분 API 명 설명 공개키 조회 auth.jwks Bot 서버로 전달되는 요청의 JWT 검증용 공개키(JWKS) 조회 auth.jwks 카카오워크가 Bot 서버로 전달하는 요청을 검증하기 위한 공개키 목록(JSON Web Key Set)을 조회합니다. 카카오워크는 Request URL·Callback URL로 요청(반응형 메시지·Modal)을 전달할 때 Authorization 헤더에 Bearer {JWT} 형식의 토큰을 함께 보냅니다.