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

    Update a Message Bot

    Updates information of a registered message bot.

    You can also choose a chat type.
    The default is 1:1 chat, and you can enable "Invitation to team/group or 1:N chat room available" using the useGroupJoin parameter.

    If you disable " Invitation to team/group or 1:N chat room available" using the useGroupJoin parameter, a bot invited to a team/group, or 1:N chatroom will be removed from the chatroom.

    You can change the scope of domains for a bot.
    The domain registered with the registerBotDomain API and yet is not the one specified as a custom domain will be automatically removed.

    API Type

    Server API

    Request URL

    https://apis.worksmobile.com/{API ID}/message/updateBot/v2

    HTTP Method

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

    Request

    Parameter Type Required Description
    botNo number Y The number of the message bot to be updated.
    name string Y Message bot name
    i18nNames[] array N Multilingual names
    i18nNames[].language string Y Language code
    ●ko_KR
    ●ja_JP
    ●zh_CN
    ●zh_TW
    ●en_US
    i18nNames[].name string Y Name in the language
    Max: 100 characters
    photoUrl string Y The URL of a message bot profile image (PNG format, and only HTTPS allowed)
    i18nPhotoUrls[] array N URLs of multilingual images
    i18nPhotoUrls[].language string Y Language code
    ●ko_KR
    ●ja_JP
    ●zh_CN
    ●zh_TW
    ●en_US
    i18nPhotoUrls[].photoUrl string Y URL of a multilingual image
    Max: 1000 characters
    description string Y Description of the message bot
    i18nDescriptions[] array N Multilingual descriptions of the message bot
    i18nDescriptions[].language string Y Language code
    ●ko_KR
    ●ja_JP
    ●zh_CN
    ●zh_TW
    ●en_US
    i18nDescriptions[].description string Y Multilingual description of the message bot
    Max: 100 characters
    managerList array<string> Y Managers of the message bot (at least 1 and up to 3 accounts)
    submanagerList array<string> N Sub managers of the message bot (up to 3 accounts)
    useGroupJoin boolean N Chat type
    ● false: 1:1 chat only (default)
    ● true: Invitation to team/group or 1:N chat room available
    useDomainScope boolean N Specify the scope of domains for a bot.
    ● false: All domains (default)
    ● true: Custom domains
    domainIdList array<number> N Specify domains if useDomainScope is "true."
    At least one domain should be specified.

    Request Example

    {
      "botNo": 123,
      "name": "echo bot",
      "i18nNames": [{
        "language": "ko_KR",
        "name": "에코봇"
      }, {
        "language": "ja_JP",
        "name": "エコボッ"
      }],
      "photoUrl": "https://developers.worksmobile.com/favicon.png",
      "i18nPhotoUrls": [{
        "language": "ko_KR",
        "photoUrl": "https://developers.worksmobile.com/favicon.png"
      }, {
        "language": "ja_JP",
        "photoUrl": "https://developers.worksmobile.com/favicon.png"
      }],
      "description": "WorksMobile's A.I. conversation enabled bot",
      "i18nDescriptions": [{
        "language": "ko_KR",
        "description": "웍스모바일의 A.I 대화가 가능한 봇"
      },{
        "language": "ja_JP",
        "description": "ワークスモバイルのA.I対話が可能なボット"
      }],
      "managerList": ["manager@example.com", "manager2@example.com"],
      "submanagerList": ["submanager@example.com"],
      "useGroupJoin": true,
      "useDomainScope": false
    }
    

    Response

    It returns code 200 when the API call is successful.

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