アドレス帳APIの概要

    LINE WORKSアドレス帳 APIは、個人とグループの連絡先(グループ連絡先は、今後提供予定)機能を提供します。 連絡先ポップアップは、クライアントのポータルサイトからポップアップを通じてLINE WORKS連絡先の個人、共用、グループおよびドメインの連絡先データを提供します。

    アドレス帳 APIを使用する前に

    LINE WORKSアドレス帳 APIを使用するには、API IDの発行を受ける必要があります。API IDは、アドレス帳の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説明を参照してください(エラーコードとエラーメッセージは、今後追加予定)。