Contact Overview

    The LINE WORKS Contacts API is provided to use private contact and group contact (to be provided later) features. The contact popup window provides LINE WORKS Contacts' private, public, group and domain contact data on the client's portal site, through a popup window.

    Preparations

    To use the LINE WORKS Contacts API, "API ID" should be included in the Contact API's request URL. For how to get your API ID, see API Common Guide.

    Supported Environment

    LINE WORKS supports two environments: testing and live.

    • Testing environment: https://sandbox-apis.worksmobile.com
    • Live environment: https://apis.worksmobile.com

    Request Common

    Parameters for HTTP requests are basically passed in "application/x-www-form-urlencoded" format. See the corresponding API description for the format of each parameter value.

    Response Common

    When an API call is made, the following common response is returned in JSON format.

    Property Type Required Description
    code String Y ● SUCCESS: An API call was successful, and its result is returned in "data."
    ● FAIL: An API call failed, and the detailed information is returned in "failType" and "message."
    data String Y It contains a result value. See the corresponding API description for the format of each result value.
    failType String Y It contains an error code if an API call failed.
    message String Y It contains an error message if an API call failed.

    An example is shown below.

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

    The error codes and messages will be added to each API section later.