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 “Register a Message Bot” API.

    The domain to be registered must be specified in the scope of domains for the bot using the “Register a Message Bot” 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.

    Caution

    • You can specify up to 150 members.

    API Type

    Server API

    Request URL

    https://apis.worksmobile.com/r/{API ID}/message/v1/bot/{botNo}/domain/{domainId}

    HTTP Method

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

    Path Parameters

    Parameter Required Description
    botNo Y Message bot number
    domainId Y Domain ID to allow to use the message bot

    Request

    Parameter Type Required Description
    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
    accountIds array N Specify members if usePermission is “true.”

    Request Example

    simple

    
    POST https://apis.worksmobile.com/r/apiid/message/v1/bot/123/domain/456
    
    detail
    
    POST https://apis.worksmobile.com/r/apiid/message/v1/bot/123/domain/456
    {
      "usePublic": true,
      "usePermission": true,
      "accountIds": ["manager@example.com"]
    }
    

    Response

    It returns HTTP status 200 with no response if successful.

    Error Code

    If the API call fails, it returns an error code and message.
    For error codes, refer to Message Bot REST API Error Codes.