GET/bots/{botId}/richmenus/{richmenuId}/image

Gets the image set for a rich menu.
You can use the Download content operation to download the image.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

bot.message
bot
bot.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/bots/{botId}/richmenus/{richmenuId}/image

Path Parameters

ParameterTypeDescription
botId integer 

Bot ID


required
example : 2000001
format : int64 
richmenuId string 

Bot's rich menu ID


required
example : 40001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
fileId string 

Rich menu image file ID


required 
i18nFileIds array (i18nFileIds) 

List of multilingual file IDs


minItems : 0 

i18nFileIds

PropertyTypeDescription
language string 

Language code


required
Allowed values : ko_KR, ja_JP, en_US, zh_CN, zh_TW 
fileId string 

File ID


required 

Response Example

example

1{2  "fileId": "jp1.1628695315008671000.1628781715.0.1000001.0.0.0",3  "i18nFileIds": [4    {5      "language": "en_US",6      "fileId": "jp1.1628695315008671000.1628781715.0.1000001.0.0.0"7    }8  ]9}