Get Message Bots

    Gets registered message bots.

    API Type

    Server API

    Request URL

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

    HTTP Method

    GET

    Request Example

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

    Response

    It returns HTTP status 200 with a list of message bots as a response if successful.

    Property Type Description
    bots array List of message bots
    bots[].botNo number Message bot number
    bots[].name string Message bot name
    bots[].i18nNames[] array Multilingual names
    bots[].i18nNames[].language string Language code
    ○ ko_KR ○ ja_JP ○ zh_CN ○ zh_TW ○ en_US
    bots[].i18nNames[].name string Name in the language
    bots[].photoUrl string URL of the message bot profile image
    bots[].i18nPhotoUrls[] array URLs of multilingual images
    bots[].i18nPhotoUrls[].language string Language code
    ○ ko_KR ○ ja_JP ○ zh_CN ○ zh_TW ○ en_US
    bots[].i18nPhotoUrls[].photoUrl string URL of an image in the language

    Response Example

    
    {
      "bots": [
        {
          "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"
          }]
        }
      ]
    }
    

    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.