[API 도메인]

Develop

https://dev-api.metaflyer.co.kr

Production

https://api.metaflyer.co.kr

[Header]

Name	Type	Description
apiKey	String	별도 요청

[Content-Type]

application/json;charset=UTF-8

[Common Response]

{
    "time": String,
    "result": String,
    "resultMessage": String,
    "locale": String
}

Name	Type	Required	Description
time	String	true	Response Time `2022-11-07T07:52:35.949+00:00`
result	String	true	Response Code
resultMessage	String	true	Response Message
locale	String	true	API Locale

SMS

[URL]

POST /api/message/sendSMS.v1.0

[Request Body]

{
    "content": String,
    "sendDate": String,
    "sender": String,
    "receivers": [
        {
            "phoneNumber": String
        },
        {
            "phoneNumber": String
        }
    ]
}

Name	Type	Required	Description
content	String	true	메시지 내용 size : 90 byte
sendDate	String	false	발송시간 format : yyyy-MM-dd HH:mm
sender	String	true	발신자 번호 format : 000-0000-0000
receivers	Array	true	수신자 정보
– phoneNumber	String	true	수신자 번호 format : 000-0000-0000

[Response]

{
    "time": String,
    "result": String,
    "resultMessage": String,
    "locale": String,
    "item": {
        "requestId": String
    }
}

Name	Type	Required	Description
item	Object	true
– requestId	String	true	발신 요청 ID

LMS

[URL]

POST /api/message/sendLMS.v1.0

[Request Body]

{
    "subject": String,
    "content": String,
    "sendDate": String,
    "sender": String,
    "receivers": [
        {
            "phoneNumber": String
        },
        {
            "phoneNumber": String
        }
    ]
}

Name	Type	Required	Description
subject	String	false	메시지 제목
content	String	true	메시지 내용 size : 2000 byte
sendDate	String	false	발송시간 format : yyyy-MM-dd HH:mm
sender	String	true	발신자 번호 format : 000-0000-0000
receivers	Array	true	수신자 정보
– phoneNumber	String	true	수신자 번호 format : 000-0000-0000

[Response]

{
    "time": String,
    "result": String,
    "resultMessage": String,
    "locale": String,
    "item": {
        "requestId": String
    }
}

Name	Type	Required	Description
item	Object	true
– requestId	String	true	발신 요청 ID

MMS

[URL]

POST /api/message/sendMMS.v1.0

[Request Body]

{
    "subject": String,
    "content": String,
    "sendDate": String,
    "sender": String,
    "image": {
        "contentType": String,
        "fileName": String,
        "body": String
    },
    "receivers": [
        {
            "phoneNumber": String
        },
        {
            "phoneNumber": String
        }
    ]
}

Name	Type	Required	Description
subject	String	false	메시지 제목
content	String	true	메시지 내용 size : 2000 byte
sendDate	String	false	발송시간 format : yyyy-MM-dd HH:mm
sender	String	true	발신자 번호 format : 000-0000-0000
image	Object	false	이미지
– contentType	String	true	MIME Type JPG(image/jpeg), JPEG(image/jpeg), SIS(image/vnd.wap.sis)
– fileName	String	true	File Name
– body	String	true	File Body File byte[] 를 Base64 인코딩 size : 50kb 이하 ex) `Base64.getEncoder().encodeToString(Files.readAllBytes(file.toPath()))`
receivers	Array	true	수신자 정보
– phoneNumber	String	true	수신자 번호 format : 000-0000-0000

[Response]

{
    "time": String,
    "result": String,
    "resultMessage": String,
    "locale": String,
    "item": {
        "requestId": String
    }
}

Name	Type	Required	Description
item	Object	true
– requestId	String	true	발신 요청 ID

Alimtalk

[URL]

POST /api/message/sendAlimtalk.v1.0

[Request Body]

{
    "senderKey": String,
    "sender": String,
    "templateCode": String,
    "sendDate": String,
    "receivers": [
        {
            "phoneNumber": String,
            "content": String
        }
    ]
}

Name	Type	Required	Description
senderKey	String	true	발신 키
sender	String	true	발신자 번호 format : 000-0000-0000
templateCode	String	true	알림톡 템플릿 코드
sendDate	String	false	발송시간 format : yyyy-MM-dd HH:mm
receivers	Array	true	수신자 정보
– phoneNumber	String	true	수신자 번호 format : 000-0000-0000
– content	String	true	메시지 내용 size : byte

[Response]

{
    "time": String,
    "result": String,
    "resultMessage": String,
    "locale": String,
    "item": {
        "requestId": String
    }
}

Name	Type	Required	Description
item	Object	true
– requestId	String	true	발신 요청 ID

Friendtalk

[URL]

POST /api/message/sendFriendtalk.v1.0

[Request Body]

{
    "senderKey": String,
    "sender": String,
    "sendDate": String,
    "adFlag": Boolean,
    "messageType": String,
    "image": {
        "contentType": String,
        "fileName": String,
        "body": String
    },
    "imageLink": String,
    "receivers": [
        {
            "phoneNumber": String,
            "content": String
        }
    ]
}

Name	Type	Required	Description
senderKey	String	true	발신 키
sender	String	true	발신자 번호 format : 000-0000-0000
sendDate	String	false	발송시간 format : yyyy-MM-dd HH:mm
adFlag	Boolean	false	광고여부
image	Object	false	이미지
– contentType	String	true	MIME Type JPG(image/jpeg), JPEG(image/jpeg), SIS(image/vnd.wap.sis)
– fileName	String	true	File Name
– body	String	true	File Body File byte[] 를 Base64 인코딩 size : 50kb 이하 ex) `Base64.getEncoder().encodeToString(Files.readAllBytes(file.toPath()))`
receivers	Array	true	수신자 정보
– phoneNumber	String	true	수신자 번호 format : 000-0000-0000
– content	String	true	메시지 내용 size : byte

[Response]

{
    "time": String,
    "result": String,
    "resultMessage": String,
    "locale": String,
    "item": {
        "requestId": String
    }
}

Name	Type	Required	Description
item	Object	true
– requestId	String	true	발신 요청 ID

Message API

SMS

LMS

MMS

Alimtalk

Friendtalk