API PLEX Developer Guide
ServiceBlog
English
English
  • API PLEX Developer's Guide
  • Release Note
    • Release Note
  • Service
    • Biz Message
      • SMS
      • LMS
      • MMS
      • MMS Image Upload
      • Message sending result (WebHook)
    • Kakao Message
      • Alim Talk
      • Friend Talk
      • Image Upload API
      • Failback
      • Message sending result (WebHook)
    • Global Message
      • GMS
        • GMS (v2)
        • Message sending result (WebHook)
        • Code References
          • Message status code
          • Service error code
Powered by GitBook
On this page
  • Path variable
  • MMS image upload API
  • Response Body
  1. Service
  2. Biz Message

MMS Image Upload

API for pre-uploading some image files to be used in MMS.

Please prepare the image to be uploaded according to the instructions provided in the Request Body.

The secret key (secret_key) can be obtained by adding a sub-account in [Service Console / Sub Account] and clicking the [Detailed Inquiry] button.

Path variable

Please refer to the following information to ensure that path variables (enclosed in curly braces {}) within each URI are not omitted when making calls.

code
definition

user_id

user ID

MMS image upload API

POST https://tyrar0qvgf.apigw.ntruss.com/image/v1/mms/{user_id}

Headers

Name
Type
Description

Authorization*

string

userID;secret_key

Content-Type*

string

multipart/form-data;charset=utf-8

Request Body

Name
Type
Description

image*

File

image file to be uploaded

Size Limit: Width 1500 px, Height 1440 px File Format: jpg File Size Limit: Maximum 300 kB (Uploaded images will be deleted after 3 months)

Response Body

You can check the successful acceptance of each API request based on the result code (code field) for each request.

Key
Type
Description

file_name

string

Image file name

image_url

string

Image path url

code

string

name

string

Acceptance result code name

description

string

Acceptance result code description

Success

{
    "file_name": "mms_image_sample.jpg",
    "image_url": "https://kr.object.ncloudstorage.com/api-plex-upload/image/mms/{user_id}/mms_sample1.jpg",
    "code": "C100",
    "name": "success",
    "description": "success"
}

Invalid request or error

{
    "code": "C400_2",
    "name": "Invalid Parameter",
    "description": "image width must be (<= 1500 px)"
}

API PLEX Response Code

code
HTTP status
title
description

C100

200

Success

Success

C400_1

400

Invalid data type

Refer to the description in the response body

C400_2

400

Invalid request parameter

Refer to the description in the response body

C400_3

400

Missing required parameters

Refer to the description in the response body

C404_1

404

Unable to find the data

Refer to the description in the response body

C500_1

500

Internal server error

Refer to the description in the response body

Last updated 1 year ago

Acceptance result code (Refer to )

API PLEX response codes