This API will soon be deprecated. Please use another API.

    Register a Message Bot Domain

    Registers a message bot's domain information.
    If you want to use a message bot in a specified domain, you should register the domain with this API after registering a message bot with the registerBot API.

    The domain to be registered must be specified in the scope of domains for the bot using the registerBot API.

    A message bot can be public or private in the domain.
    A public message bot is shown on the client's bot list from which users can invite the bot to their chats.

    If you choose to allow "only specified members" to use the bot, you can assign bot permissions only to those members using Add Members with Bot Permissions API.

    API Type

    Server API

    Request URL

    https://apis.worksmobile.com/{API ID}/message/registerBotDomain/v3

    HTTP Method

    POST(Content-Type: application/json; charset=UTF-8)

    Request

    Parameter Type Required Description
    botNo number Y Message bot number to which you want to register a domain.
    domainId number Y Domain ID to allow to use the message bot
    usePublic boolean N Indicates whether to show the bot on the client's organization chart.
    ● false: Private (default)
    ● true: Public
    usePermission boolean N Indicates whether to allow only specified members to use the bot.
    ● false: All (default)
    ● true: Specified members only

    Request Example

    {
        "botNo": 123,
        "domainId": 123123 
    }
    

    Response

    It returns code 200 when the API call is successful.

    {"code": 200, "message": "OK"}