File

PreviousMessage NextMsgstatus (webhook)

중계사 파일 등록 요청

post

/file

Authorizations

Body

fileIdstring · max: 64required

사전등록할 file ID로 유니크하게 생성되어야 한다. 생성가이드 {brandId}.{userCode} 또는 {chatbotId}.{userCode}

Example: brandId.FDSAF.432153214

usageTypestring · enum · max: 10 · default: sendrequired

사용타입 별 설명.

send : 메시지 발송에 사용할 파일 <br>(발송가능기간 D+365일 00:00, 파일유효기간 D+456일 00:00)

Options: chatbot, messagebase, send

mimeTypestringrequired

mime type. 예) image/jpeg, image/png, MimeType 설명

Example: image/jpeg

filestring · binaryrequired

messagebaseIdstring · max: 40

(신규포맷 mms 전용) 이미지 파일이 사용될 messagebase 템플릿 ID. 등록하고자 하는 이미지의 width, height가 해당하는 템플릿에 적합한 지 validation check를 수행한다.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://maapdomain.com/ag/1.2/file' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: multipart/form-data' \
  --form 'fileId=brandId.FDSAF.432153214' \
  --form 'usageType=send' \
  --form 'mimeType=image/jpeg' \
  --form 'file=text' \
  --form 'messagebaseId=text'

200

default

{
  "status": "200",
  "data": {
    "fileInfo": {
      "fileId": "brandId.FDSAF.432153214",
      "usageType": "send",
      "mimeType": "image/jpeg",
      "status": "ready",
      "expiryDate": "2019-08-06T07:08:38.426+09"
    }
  }
}

success

파일 상태 조회 요청

get

/file/{fileId}