메일 API 개요

    LINE WORKS 메일 API(이하 '메일 API' 또는 'API')는 HTTP 요청으로 활용할 수 있는 REST API로 API 결과는 보통 JSON 형식으로 반환된다(단, 메일 쓰기, 메일 읽기, 외부 주소록 등의 팝업 창은 제외). 인증 방식으로는 OAuth 2.0을 사용한다.

    메일 API는 LINE WORKS 메일 서비스의 기능 중에서 자주 사용하는 기능을 API로 제공한다.

    API 공통 정보

    제공 환경

    LINE WORKS에서는 테스트와 서비스의 2가지 환경을 제공한다. 그러나 메일 API는 서비스 환경에서만 사용 가능하다.

    • 서비스 환경: https://apis.worksmobile.com

    오퍼레이션을 요청할 때는 HTTP 메서드와 요청 URL을 결합한다. 예를 들어, 서비스 환경에서 메일을 발송하는 오퍼레이션은 다음과 같다.

    예) 메일 발송 오퍼레이션

    POST https://apis.worksmobile.com/r/{API ID}/mail/v2/sendMail
    

    개별 API 설명에서 서비스 환경에 대한 요청 URL을 확인할 수 있다.

    Request 공통

    API를 호출할 때는 반드시 헤더에 Access Token과 컨슈머키를 포함해야 한다. Access Token은 로그인할 때 발급받을 수 있고, 로그인할 때마다 재발급된다.

    컨슈머키 발급은 API 공통가이드를 참고한다.

    헤더에 Access Token과 컨슈머키를 설정하는 방법은 다음과 같다.

    httpMethod.setRequestHeader("Authorization", "Bearer Access Token");
    httpMethod.setRequestHeader("consumerKey", "컨슈머키");