画像のアップロード

Prev Next

Classic/VPC環境で利用できます。

ブランドメッセージの送信に使用する画像をアップロードします。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /brandmessage/v2/services/{serviceId}/images

リクエストヘッダ

Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
serviceId String Required Biz Messageサービス ID

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
imageType String Required 画像タイプ
imageFile File Required 画像ファイル

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://sens.apigw.ntruss.com/brandmessage/v2/services/ncp:kkobizmsg:kr:27*********6:sens/images' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: multipart/form-data' \
--form 'imageType=BASIC' 'imageFile=@"/E:/desktop/myImage.jpg"'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
imageId String Required 画像 ID
imageUrl String Required 画像 URL
imageType String Required 画像ファイルタイプ
imageName String Required 画像ファイル名

レスポンスステータスコード

Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "imageId": "5b19970c-****-****-****-c8ec1cd8f37e",
    "imageUrl": "https://mud-kage.kakao.com/dn/dhkJRb/***********/**********************/img_l.jpg",
    "imageType": "BASIC",
    "imageName": "myImage.jpg"
}

画像タイプ

画像タイプ情報は次の通りです。

項目 説明 備考
BASIC TEXT、COMMERCE、PREMIUM_VIDEO画像
  • 推奨サイズ: 800 x 400px(横500px以上)
  • アスペクト比(width/height): 0.5~1.333
  • ファイル形式: jpg、png
  • ファイルサイズ”: 最大5MB
WIDE WIDE_IMAGE画像
  • 推奨サイズ: 800 x 600px(横500px以上)
  • アスペクト比(width/height): 0.5~1.0
  • ファイル形式: jpg、png
  • ファイルサイズ: 最大5MB
WIDE_ITEM_LIST_MAIN WIDE_ITEM_LISTの1番目のアイテム画像
  • 横500px以上
  • アスペクト比(width/height): 0.5
  • ファイル形式: jpg、png
  • ファイルサイズ: 最大5MB
WIDE_ITEM_LIST_SUB WIDE_ITEM_LISTの2番目以降のアイテム画像
  • 横500px以上
  • アスペクト比(width/height): 1.0
  • ファイル形式: jpg、png
  • ファイルサイズ: 最大5MB
CAROUSEL_FEED CAROUSEL_FEED画像
  • 推奨サイズ: 800 x 600pxまたは800 x 400px(横500px以上)
  • アスペクト比(width/height): 0.5~1.333
  • ファイル形式: jpg、png
  • ファイルサイズ: 最大5MB
CAROUSEL_COMMERCE CAROUSEL_COMMERCE画像
  • 推奨サイズ: 800 x 600pxまたは800 x 400px(横 500px以上)
  • アスペクト比(width/height): 0.5~.333 (全アスペクト比は同一)
  • ファイル形式: jpg、png
  • ファイルサイズ: 最大5MB