Get Message Bot Information

    Gets detailed information of a message bot.

    API Type

    Server API

    Request URL

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

    HTTP Method

    GET

    Path Parameters

    Parameter Required Description
    botNo Y Message bot number for which you want to get detailed information.

    Request Example

    
    POST https://apis.worksmobile.com/r/apiid/message/v1/bot/123
    

    Response

    It returns HTTP status 200 with detailed information of a message bot as a response if successful.

    Property Type Description
    name string Message bot name
    i18nNames[] array Multilingual names
    i18nNames[].language string Language code
    ○ ko_KR ○ ja_JP ○ zh_CN ○ zh_TW ○ en_US
    i18nNames[].name string Name in the language
    photoUrl string URL of the message bot profile image
    i18nPhotoUrls[] array URLs of multilingual images
    i18nPhotoUrls[].language string Language code
    ○ ko_KR ○ ja_JP ○ zh_CN ○ zh_TW ○ en_US
    i18nPhotoUrls[].photoUrl string URL of an image in the language
    description string Description of the message bot
    i18nDescriptions[] array Multilingual descriptions of the message bot
    i18nDescriptions[].language string Language code
    ○ ko_KR ○ ja_JP ○ zh_CN ○ zh_TW ○ en_US
    i18nDescriptions[].description string Multilingual description of the message bot
    createdTime number The date and time when the message bot is created. It is a Unix time in msec.
    modifiedTime number The date and time when the message bot is updated. It is a Unix time in msec.
    managers array\ Primary contacts of the message bot
    submanagers array\ Secondary contacts of the message bot
    domainInfos array\ List of registered domains
    domainInfos[].domainId number Registered domain ID
    domainInfos[].usePublic boolean Indicates whether to show the bot on the client's organization chart.
    ○ false: Private
    ○ true: Public
    domainInfos[].usePermission boolean Indicates whether to allow only specified members to use the bot.
    ○ false: All
    ○ true: Specified members only
    domainInfos[].accountIds array List of the specified members. It is shown only if usePermission is “true.”
    useGroupJoin boolean Chat type
    ○ false: 1:1 chat only
    ○ true: Invitation to team/group or 1:N chat room available
    useDomainScope boolean The scope of domains for the bot.
    ○ false: All domains (default)
    ○ true: Specified domains
    domainIds array List of domains. It is shown only if useDomainScope is “true.”
    useCallback boolean Indicates whether to use callbacks.
    ○ false: Don’t use (default)
    ○ true: Use
    callbackUrl string URL of the client's message receiving server. It is shown only if useCallback is “true.”
    callbackEvents array Event type to receive. It is shown only if useCallback is “true.” More event types will be added later.
    ○ "text": Plain text
    ○ "location": User location
    ○ "sticker": Sticker
    ○ "image": Image

    Response Example

    
    {
      "name": "echo bot",
      "photoUrl": "https://developers.worksmobile.com/favicon.png",
      "description": "WorksMobile's A.I. conversation enabled bot",
      "callbackUrl": "https://xxx",
      "callbackEvents": ["text", "location", "sticker", "image"],
      "tenantId": 123123,
      "createdTime": 1464693120000,
      "modifiedTime": 1464694324000,
      "managers": ["manager@example.com", "manager2@example.com"],
      "submanagers": ["submanager@example.com"],
      "domainInfos": [{
        "domainId": 123,
        "usePublic": true,
        "usePermission": false
      },{
        "domainId": 456,
        "usePublic": true,
        "usePermission": true,
        "accountIds": ["manager@example.com"]
      }],
      "useGroupJoin": true,
      "useDomainScope": false,
      "useCallback": true,
      "callbackUrl": "https://xxx",
      "callbackEvents": ["text", "location", "sticker", "image"]
    }
    

    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.