All pages
Powered by GitBook
1 of 1

Loading...

File

중계사 파일 등록 요청

post
Authorizations
Body
fileIdstring · max: 64Required

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

Example: brandId.FDSAF.432153214
usageTypestring · enum · max: 10Required

사용타입 별 설명.

  • send : 메시지 발송에 사용할 파일 (발송가능기간 D+365일 00:00, 파일유효기간 D+456일 00:00)
Default: sendPossible values:
mimeTypestringRequired

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

Example: image/jpeg
filestring · binaryRequired
messagebaseIdstring · max: 40Optional

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

Responses
200
success
application/json
default
fail
application/json
post
POST /ag/1.2/file HTTP/1.1
Host: maapdomain.com
Authorization: Bearer JWT
Content-Type: multipart/form-data
Accept: */*
Content-Length: 118

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

파일 상태 조회 요청

get
Authorizations
Path parameters
fileIdstringRequired

file ID

Responses
200
success
application/json
default
fail
application/json
get
GET /ag/1.2/file/{fileId} HTTP/1.1
Host: maapdomain.com
Authorization: Bearer JWT
Accept: */*
{
  "status": "200",
  "data": {
    "fileInfo": {
      "fileId": "brandId.FDSAF.432153214",
      "usageType": "send",
      "mimeType": "image/jpeg",
      "status": "ready",
      "expiryDate": "2019-08-06T07:08:38.426+09"
    }
  }
}