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

    Get Message Bots

    Gets registered message bots.

    API Type

    Server API

    Request URL

    https://apis.worksmobile.com/{API ID}/message/getBotList/v4

    HTTP Method

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

    Request

    None

    Response

    It returns a list of message bots when the API call is successful.

    Property Type Description
    code number ● 200: Success
    ● 4xx: Client request errors
    ● 5xx: Unexpected errors and server internal errors
    message string Description about the code
    botList array List of message bots
         botNo number Message bot number
        name string Message bot name
    botList[].i18nNames[] array Multilingual names
    botList[].i18nNames[].language string Language code
    ●ko_KR
    ●ja_JP
    ●zh_CN
    ●zh_TW
    ●en_US
    botList[].i18nNames[].name string Name in the language
        photoUrl string The URL of the message bot profile image
    botList[].i18nPhotoUrls[] array URLs of multilingual images
    botList[].i18nPhotoUrls[].language string Language code
    ●ko_KR
    ●ja_JP
    ●zh_CN
    ●zh_TW
    ●en_US
    botList[].i18nPhotoUrls[].photoUrl string URL of an image in the language

    Response Example

    {
      "code": 200,
      "message": "OK",
      "botList": [
        {
          "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"
          }]
        }
      ]
    }