Works 알림 Bot API 가이드

서버IP, Secret Key 는 IT Infra팀에 요청하세요.
네이버 Works 메신저를 통한 알림 자동화 API입니다. 회사 서버나 시스템에서 개인에게 보내는 알림과 경고를 간단한 API 호출만으로 자동화할 수 있습니다. 백엔드의 복잡한 로직은 모두 서버에 구현되어 있으니, 아래 가이드를 참고하여 간편하게 사용해 보세요.

1. API 개요

지정한 네이버웍스 사용자에게 봇을 통해 메시지를 발송하는 API입니다. 현재는 단순 텍스트 전송 기능만 제공합니다. JWT모듈은 Naver 개발문서를 참고하였으며, RestAPI 기능은 IT Infra팀 자체적으로 설계와 개발을 하였습니다.
RestAPI를 사용하면 Works의 복잡한 jwt 발급-인증과 bot ID 설정-권한 문제를 신경 쓸 필요가 없이 필수 정보만 전달하면 됩니다.

Flow :
Client → RestAPI 서버(사내망, JWT 발급/검증) → Works Bot API 호출 → 메시지 전송

2. API 엔드포인트(사내 개발 서버)

POST http://{API서버IP}/send

(Python Flask 기반이며 Gunicorn으로 구동됩니다. 개발 서버는 내부망이며, 외부 접근은 공인 IP를 통해 제한적으로 허용됩니다.)

3. 요청 헤더 (Request Headers)

Key Value 필수 설명
Content-Type application/json Y 요청 본문이 JSON 형식임을 나타냅니다.
X-Api-Key {API 키} Y 인증을 위한 비밀 키입니다. (IT Infra 담당자에게 요청)
테스트용 인증 키 사용 가능: 관리자에게 요청
테스트 키는 언제든지 삭제될 수 있습니다. 정식으로 사용하시려면 담당자에게 키 발급을 요청해 주세요.

4. 요청 본문 (Request Body)

5. 전체 명령 샘플 (cURL)

아래 명령어를 터미널에 붙여넣으면 즉시 메시지가 전송됩니다.

curl -X POST http://<API서버IP>/send \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: <API Secret Key>" \
  -d '{
    "email": "<수신자 ID>",
    "message": "<메시지 내용>"
  }'

또는

API_URL="http://<API서버IP>/send"
  API_KEY='<API Secret Key>'
  curl -v -X POST "$API_URL" \
    -H "Content-Type: application/json" \
    -H "X-Api-Key: $API_KEY" \
    -d '{"email":"<수신자 ID>","message":"<메시지 내용>"}'

6. 성공 응답 (Success Response)

{
  "success": true,
  "message": "Message sent successfully.",
  "response": "Success"
}

7. 실패 응답 (Failure Response)

8. 확인된 오류

9. 기타