주소록 API 개요

    LINE WORKS 주소록 API는 개인 주소록과 그룹 주소록(추후 제공) 기능을 제공한다. 주소록 팝업 창은 고객사의 포털에서 LINE WORKS 주소록의 개인, 공용, 그룹 및 도메인 연락처를 이용할 수 있도록 팝업 창을 통해 데이터를 제공한다.

    사용 준비

    LINE WORKS 주소록 API를 사용하려면 API ID를 발급받아야 한다. API ID는 주소록 API의 URL에 사용된다. API ID 발급은 API 공통가이드를 참고한다.

    제공 환경

    LINE WORKS에서는 다음과 같이 테스트와 서비스의 2가지 환경을 제공한다.

    • 테스트 환경: https://sandbox-apis.worksmobile.com
    • 서비스 환경: https://apis.worksmobile.com

    Request 공통

    HTTP 요청으로 파라미터를 전달할 때는 application/x-www-form-urlencoded 방식을 기본으로 한다. 파라미터값 형식은 각 API 설명에서 확인할 수 있다.

    Response 공통

    API 호출 시 다음의 공통 JSON 형식이 반환된다.

    속성 타입 필수 여부 설명
    code String Y ● SUCCESS: 호출이 성공했으며 data에 결과값이 들어 있다.
    ● FAIL: 호출이 실패했으며 failType, message에 상세 정보가 들어 있다.
    data String Y 결과값이 들어 있다. 형식은 각 API 설명에서 확인할 수 있다.
    failType String Y 호출이 실패한 경우 오류 코드가 들어 있다.
    message String Y 호출이 실패한 경우 오류 메시지가 들어 있다.

    예를 들면 다음과 같다.

    {"code ":"SUCCESS", "data": 1, "failType" : "", "message":""}
    

    API별로 발생하는 오류 코드와 오류 메시지는 각 API 설명에서 확인할 수 있다.