메시지 발송

Request

[POST] https://api.solapi.com/messages/v4/send-many/detail

하나 이상의 메시지를 발송합니다. 대량 발송은 그룹 메시지를 사용하세요.

발신번호의 경우 사전에 등록된 발신번호만 사용 가능하며 발신번호 관리 페이지에서 관리 가능합니다.

홈페이지의 문자발송 내역에서 전송결과 내역을 확인하실 수 있습니다. (로그인 필요)

또한 발송할 수 있는 메시지가 없을 경우 자세한 에러 내역을 결과로 반환합니다.

전송 내역(메시지 그룹, 메시지 목록)의 보관기간은 생성일 기준 6개월 입니다. 6개월이 지난 내역은 조회가 불가능합니다.

문자별 특징

단문(SMS)

일반 문자입니다. 내용은 90byte 제한이 있으며 일반적으로 한글로는 45자, 영어로는 90자입니다. messages.autoTypeDetect 필드가 true로 설정되어 있을 경우 messages.text 필드가 90byte 이하라면 자동으로 설정되는 문자입니다.

필수 필드

messages.from
messages.to
messages.text

장문(LMS)

장문 문자입니다. 내용은 2000byte 제한이 있으며 일반적으로 한글로는 1000자, 영어로는 2000자입니다. 수신자가 수신하기 위해서는 단말기의 데이터가 켜저 있어야 합니다. 와이파이는 상관 없습니다. messages.autoTypeDetect 필드가 true로 설정되어 있을 경우 messages.text 필드가 90byte 초과라면 혹은 messages.subject 필드가 설정되어 있다면 자동으로 설정되는 문자입니다.

필수 필드

messages.from
messages.to
messages.text

선택 필드

messages.subject

사진 문자(MMS)

사진 문자입니다. 내용은 2000byte 제한이 있으며 일반적으로 한글로는 1000자, 영어로는 2000자입니다. 또한 messages.imageId 를 설정하여 사진을 같이 보낼 수 있습니다. 수신자가 수신하기 위해서는 단말기의 데이터가 켜저 있어야 합니다. 와이파이는 상관 없습니다. messages.autoTypeDetect 필드가 true로 설정되어 있을 경우 messages.imageId 필드가 설정되어 있다면 자동으로 설정되는 문자입니다.

이미지의 겨우 아래의 조건이 있습니다.

이미지 타입: MMS
크기 제한: 없음
용량 제한: 최대 200KB
파일 형식: JPG

이미지 관리 페이지 (로그인 필요)
이미지 관리 API

필수 필드

messages.from
messages.to
messages.text
messages.imageId

선택 필드

messages.subject

카카오톡 알림톡(ATA)

카카오톡 알림톡입니다. 사전에 등록된 템플릿 내용으로 알림톡을 발송하게 됩니다. 알림톡의 경우 템플릿으로 내용을 미리 정해놓지만 변수(치환문구)를 포함할 수 있어 발송할 때에도 내용을 지정해주어야 합니다. 본문 이외에도 강조표기문구, 아이템 리스트, 부가정보 등을 모두 합하여 변수 치환 후 1000자를 넘을 수 없습니다.

messages.kakaoOptions.disableSms 를 false 로 설정했을 경우 알림톡이 발송에 실패하게 됐을 때 문자로(SMS, LMS, MMS)로 대체 발송됩니다. 대체 발송이 될 경우 알림톡 가격은 환불되고 각 문자 타입에 맞는 금액이 차감됩니다.

템플릿이 아래와 같을 경우 변수 지정 방법에는 2가지가 있습니다.

내용:
✋ 안녕하세요. #{홍길동} 고객님.

강조표기문구:
환영합니다. #{홍길동} 고객님!

버튼1:
채널추가

버튼2:
버튼이름: 바로가기
버튼타입: 웹링크
모바일 링크: https://google.com/#{url}

variables 사용

입력할 수 있는 파라미터 중 messages.kakaoOptions.variables 가 있습니다. 해당 파라미터를 설정하면 정해진 내용은 굳이 지정할 필요 없이 변수만 설정해주면 됩니다. 이름이 중복되는 변수가 있을 경우 한 번만 설정해주면 동일하게 변수가 기입됩니다.

{
    "messages": [{
        "to": "01000000000",
        "kakaoOptions": {
            "pfId": "KA01PF22101008f52rLy9Dzaz3l06DKB",
            "templateId": "KA01TP2210102f2120zzJoTGWP1hxZOV",
            "variables": {
                "#{홍길동}": "세종대왕",
                "#{url}": "custom-url"
            }
        }
    }]
}

변수 직접 설정 (비추천)

펼치기

❗ 이 방법은 사용을 권장드리지 않습니다.

변수 직접 설정 방법을 사용할 경우 변수 이름과 상관 없이 원하는 내용을 정해진 본문과 함께 직접 넣어주어야 합니다.

{
    "messages": [{
        "to": "01000000000",
        "text": "✋ 안녕하세요. 이순신 고객님."
        "kakaoOptions": {
            "pfId": "KA01PF22101008f52rLy9Dzaz3l06DKB",
            "templateId": "KA01TP2210102f2120zzJoTGWP1hxZOV",
            "title": "환영합니다. 안중근 고객님!",
            "buttons": [{
                "buttonName": "채널추가",
                "buttonType": "AD"
            }, {
                "buttonName": "바로가기",
                "buttonType": "WL",
                "linkMo": "https://google.com/custom-url"
            }]
        }
    }]
}

필수 필드

messages.to
messages.kakaoOptions.pfId
messages.kakaoOptions.templateId

선택 필드

messages.from
messages.text
messages.subject
messages.kakaoOptions.disableSms
messages.kakaoOptions.title
messages.kakaoOptions.buttons
messages.kakaoOptions.variables

친구톡 (CTA)

카카오톡 친구톡입니다. 친구톡은 수신자가 발송하는 채널에 친구가 추가되어 있을 경우에만 성공적으로 전송되며 친구가 아닌 대상에게 발송할 경우 발송에 실패하고 가격은 환불됩니다. 대체발송을 허용할 경우 친구가 아닌 사용자에게도 문자(SMS, LMS, MMS)로 다시 발송됩니다. 본문은 1000자를 넘길 수 없습니다.

알림톡과 다르게 사전에 템플릿을 등록할 필요 없이 원하는 내용을 바로 작성하여 전송할 수 있으며 광고도 보낼 수 있습니다. 광고성 친구톡을 보낼 경우 messages.kakaoOptions.adFlag 필드를 true로 설정해야 합니다.

필수 필드

messages.to
messages.text
messages.kakaoOptions.pfId

선택 필드

messages.from
messages.subject
messages.kakaoOptions.buttons
messages.kakaoOptions.disableSms
messages.kakaoOptions.adFlag

이미지 친구톡 (CTI)

카카오톡 이미지 친구톡입니다. 친구톡과 동일하지만 이미지를 첨부하여 보낼 수 있으며 가격이 다릅니다. 본문은 400자를 넘을 수 없습니다.

이미지의 겨우 아래의 조건이 있습니다.

이미지 타입: kakao
권장 크기: 720px * 720px
크기 제한: 가로 500px 미만 또는 가로:세로 비율이 2:1 미만 또는 3:4 초과시 업로드 불가
용량 제한: 최대 500KB
파일 형식: JPG, PNG

이미지 관리 페이지 (로그인 필요)
이미지 관리 API

필수 필드

messages.to
messages.text
messages.kakaoOptions.pfId
messages.kakaoOptions.imageId

선택 필드

messages.from
messages.subject
messages.kakaoOptions.buttons
messages.kakaoOptions.disableSms
messages.kakaoOptions.adFlag

Authorization 인증 필요

_{Authorization 인증이란?}

계정 권한	회원 권한	계정 상태	회원 상태	계정 인증
`message:write`	`role-message:write`	`ACTIVE`	`ACTIVE`

Request Structure

{
    "messages": [
        {
            "to": "string",
            "from": "string",
            "text": "string",
            "type": "string",
            "country": "string",
            "subject": "string",
            "imageId": "string",
            "kakaoOptions": {
                "pfId": "string",
                "templateId": "string",
                "title": "string",
                "adFlag": "boolean",
                "disableSms": "boolean",
                "imageId": "string",
                "variables": {
                    "#{홍길동}": "string",
                    "#{010-0000-0000}": "string",
                    "#{2021년 6월 17일}": "string"
                },
                "quickReplies": [
                    {
                        "name": "string",
                        "linkType": "string",
                        "linkMo": "string",
                        "linkPc": "string",
                        "linkAnd": "string",
                        "linkIos": "string"
                    }
                ],
                "highlight": {
                    "title": "string"
                },
                "header": "string",
                "item": {
                    "list": [
                        {
                            "description": "string"
                        }
                    ],
                    "summary": {
                        "description": "string"
                    }
                },
                "buttons": [
                    {
                        "buttonName": "string",
                        "buttonType": "string",
                        "linkMo": "string",
                        "linkPc": "string",
                        "linkAnd": "string",
                        "linkIos": "string"
                    }
                ]
            },
            "naverOptions": {
                "talkId": "string",
                "templateId": "string",
                "disableSms": "boolean",
                "variables": {
                    "#{홍길동}": "string",
                    "#{010-0000-0000}": "string",
                    "#{2021년 6월 17일}": "string"
                },
                "buttons": [
                    {
                        "buttonName": "string",
                        "buttonType": "string",
                        "linkMo": "string",
                        "linkPc": "string",
                        "linkAnd": "string",
                        "linkIos": "string"
                    }
                ]
            },
            "rcsOptions": {
                "brandId": "string",
                "templateId": "string",
                "copyAllowed": "boolean",
                "variables": {
                    "{{홍길동}}": "string",
                    "{{010-0000-0000}}": "string",
                    "{{2021년 6월 17일}}": "string"
                },
                "mmsType": "string",
                "commercialType": "boolean",
                "disableSms": "boolean",
                "additionalBody": [
                    {
                        "title": "string",
                        "description": "string",
                        "imageId": "string",
                        "buttons": [
                            {
                                "buttonType": "string",
                                "buttonName": "string",
                                "link": "string",
                                "latitude": "string",
                                "longitude": "string",
                                "label": "string",
                                "query": "string",
                                "title": "string",
                                "startTime": "date",
                                "endTime": "date",
                                "text": "string",
                                "phone": "string"
                            }
                        ]
                    }
                ],
                "buttons": [
                    {
                        "buttonType": "string",
                        "buttonName": "string",
                        "link": "string",
                        "latitude": "string",
                        "longitude": "string",
                        "label": "string",
                        "query": "string",
                        "title": "string",
                        "startTime": "date",
                        "endTime": "date",
                        "text": "string",
                        "phone": "string"
                    }
                ]
            },
            "faxOptions": {
                "fileIds": [
                    "string"
                ]
            },
            "voiceOptions": {
                "voiceType": "string",
                "headerMessage": "string",
                "tailMessage": "string",
                "replyRange": "number",
                "counselorNumber": "string"
            },
            "customFields": {
                "key": "string"
            },
            "autoTypeDetect": "boolean"
        }
    ],
    "scheduledDate": "date",
    "strict": "boolean",
    "agent": {
        "appId": "string",
        "osPlatform": "string",
        "sdkVersion": "string"
    },
    "allowDuplicates": "boolean",
    "showMessageList": "boolean"
}

Body Params

Name	Type	Required	Description
messages	`array`	O	발송할 메시지 내용
scheduledDate	`date`		메시지 예약 날짜
strict	`boolean`		엄격 검사 여부. 기본값: `false` - 유요하지 않은 문자 검사(아닐 시 자체적으로 삭제). - LMS 나 MMS에서 제목 여부 검사. (아닐 시 문자 내용에서 제목을 구함). - 템플릿을 발송 전 검사(아닐 시 발송 후 실패).
agent	`object`		에이전트
allowDuplicates	`boolean`		중복 수신번호 허용 여부. 기본값: `false`
showMessageList	`boolean`		응답에 메시지도 포함시킬지 선택 여부.

Body / messages

Name	Type	Required	Description
to	`string`	O	수신번호. 발송할 때는 숫자만 입력해야 됩니다. 해외로 발송할 경우 "+"(더하기) 기호와 국가 번호는 제외하고 입력해주세요. 국가번호는 `country` 필드에 입력해야 합니다.
from	`string`		발신번호. 사전 등록된 전화번호만 사용 가능합니다. 문자(SMS, LMS, MMS, FAX)를 보낼 때는 필수입니다. 알림톡, 친구톡을 보내는 경우에는 빈 값도 허용되지만 대체발송 시 문자 발송은 실패합니다.
text	`string`		메시지 내용. SMS: 90byte 제한 나머지: 2000byte 제한
type	`string`		메시지 타입 SMS: 단문 문자 LMS: 장문 문자 MMS: 사진 문자 ATA: 알림톡 CTA: 친구톡 CTI: 친구톡 + 이미지 NSA: 네이버 스마트 알림 RCS_SMS: RCS 단문 문자 RCS_LMS: RCS 장문 문자 RCS_MMS: RCS 사진 문자 RCS_TPL: RCS 템플릿 문자 FAX: 팩스 VOICE: 보이스콜
country	`string`		국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)
subject	`string`		메시지 제목. 40byte 제한. LMS, MMS, FAX 에서만 사용 가능합니다. ATA, CTA, CTI, NSA, RCS_SMS, RCS_LMS, RCS_MMS, RCS_TPL에서도 설정 가능하지만 LMS 혹은 MMS로 대체발송 될 때 사용됩니다. 설정하지 않았을 경우 메시지 본문 내용 앞 40byte가 자동으로 들어갑니다.
imageId	`string`		MMS 발송 시 사용되는 이미지의 고유 아이디. 이미지 타입이 `MMS`일 경우에만 사용 가능합니다. 이미지 관리 페이지 (로그인 필요) 이미지 관리 API
kakaoOptions	`object`		친구톡, 알림톡을 보내기 위한 옵션
naverOptions	`object`		네이버 스마트 알림을 보내기 위한 옵션
rcsOptions	`object`		RCS 문자를 보내기 위한 옵션
faxOptions	`object`		설명 없음
voiceOptions	`object`		보이스 옵션
customFields	`object`		확장 필드로 사용. 키는 30자, 값은 100자 제한
autoTypeDetect	`boolean`		"type" 필드를 직접 지정하지 않았을 경우 자동으로 타입을 지정하게 할 수 있는 값입니다. 기본값: `true`

Body / messages / kakaoOptions

Name	Type	Description
pfId	`string`	카카오톡 채널 연동 아이디 카카오톡 채널 관리 페이지 (로그인 필요) 카카오톡 채널 관리 API
templateId	`string`	알림톡 템플릿 연동 아이디 알림톡 템플릿 관리 페이지 (로그인 필요) 알림톡 템플릿 관리 API
title	`string`	강조표기문구
adFlag	`boolean`	친구톡 광고 문자 여부. 친구톡 광고를 보낼 때 해당 값을 제대로 설정하지 않으면 카카오톡 채널 사용에 패널티가 가해질 수 있습니다. 기본값: `false`
disableSms	`boolean`	대체발송여부. `false` 로 설정했을 경우 해당건이 발송에 실패하게 됐을 때 문자로(SMS, LMS, MMS)로 대체 발송됩니다. 대체 발송이 될 경우 기존 가격은 환불되고 각 문자 타입에 맞는 금액이 차감됩니다. 기본값: `false`
imageId	`string`	이미지 친구톡 발송 시 사용되는 이미지의 고유 아이디. 이미지 타입이 `KAKAO`일 경우에만 사용 가능합니다. 이미지 관리 페이지 (로그인 필요) 이미지 관리 API
variables	`object`	카카오톡 템플릿 대체 문구 입력 오브젝트
quickReplies	`array`	바로 연결. 최소 1개, 최대 10개.
highlight	`object`	알림톡 하이라이트. 강조 유형이 아이템 리스트일 때만 사용 가능합니다.
header	`string`	알림톡 헤더. 강조 유형이 아이템 리스트일 때만 사용 가능합니다. 변수 포함 가능. 최대 16자
item	`object`	알림톡 아이템. 목록과 요약이 있습니다. 강조 유형이 아이템 리스트일 때만 사용 가능합니다.
buttons	`array`	알림톡, 친구톡 템플릿 버튼 목록

Body / messages / kakaoOptions / variables

Name	Type	Description
#{홍길동}	`string`	템플릿에 포함된 대체문구
#{010-0000-0000}	`string`	템플릿에 포함된 대체문구
#{2021년 6월 17일}	`string`	템플릿에 포함된 대체문구

Body / messages / kakaoOptions / quickReplies

Name	Type	Required	Description
name	`string`	O	바로 연결 이름. 변수 포함 불가능
linkType	`string`	O	링크타입. 링크 유형 안내 문서
linkMo	`string`		모바일 링크(WL 웹링크)
linkPc	`string`		웹 링크(WL 웹링크)
linkAnd	`string`		안드로이드 링크(AL 앱링크)
linkIos	`string`		IOS 링크(AL 앱링크)

Body / messages / kakaoOptions / highlight

Name	Type	Required	Description
title	`string`		알림톡 하이라이트 제목. 변수 포함 가능. 최대 30자

Body / messages / kakaoOptions / item

Name	Type	Required	Description
list	`array`		알림톡 아이템 리스트. 최소 2개, 최대 10개까지 등록할 수 있습니다.
summary	`object`		알림톡 아이템 리스트 요약.

Body / messages / kakaoOptions / item / list

Name	Type	Required	Description
description	`string`		알림톡 아이템 리스트 제목. 변수 포함 가능. 최대 23자

Body / messages / kakaoOptions / item / summary

Name	Type	Required	Description
description	`string`		알림톡 아이템 리스트 요약 내용. 변수 포함 가능. 화폐 단위, 숫자, 쉼표, 마침표만 사용 가능합니다. 최대 14자.

Body / messages / kakaoOptions / buttons

Name	Type	Required	Description
buttonName	`string`	O	버튼 이름
buttonType	`string`	O	버튼 유형. 버튼 유형 안내 문서
linkMo	`string`		모바일 링크(WL 웹링크)
linkPc	`string`		웹 링크(WL 웹링크)
linkAnd	`string`		안드로이드 링크(AL 앱링크)
linkIos	`string`		IOS 링크(AL 앱링크)

Body / messages / naverOptions

Name	Type	Description
talkId	`string`	테스트에서 발급된 네이버 톡톡 연동 아이디
templateId	`string`	네이버 스마트 알림 템플릿 아이디
disableSms	`boolean`	대체발송여부. `false` 로 설정했을 경우 해당건이 발송에 실패하게 됐을 때 문자로(SMS, LMS, MMS)로 대체 발송됩니다. 대체 발송이 될 경우 기존 가격은 환불되고 각 문자 타입에 맞는 금액이 차감됩니다. 기본값: `false`
variables	`object`	네이버 템플릿 대체 문구 입력 오브젝트
buttons	`array`	네이버 스마트 알림 템플릿 버튼 목록

Body / messages / naverOptions / variables

Name	Type	Description
#{홍길동}	`string`	템플릿에 포함된 대체문구
#{010-0000-0000}	`string`	템플릿에 포함된 대체문구
#{2021년 6월 17일}	`string`	템플릿에 포함된 대체문구

Body / messages / naverOptions / buttons

Name	Type	Required	Description
buttonName	`string`		버튼 이름
buttonType	`string`	O	버튼 타입.
linkMo	`string`		모바일 링크
linkPc	`string`		웹 링크
linkAnd	`string`		안드로이드 앱 링크
linkIos	`string`		아이폰 앱 링크

Body / messages / rcsOptions

Name	Type	Description
brandId	`string`	브랜드 아이디
templateId	`string`	RCS 템플릿 아이디
copyAllowed	`boolean`	문자 복사 가능 여부
variables	`object`	RCS 템플릿 대체 문구 입력 오브젝트
mmsType	`string`	사진 문자 타입. 타입: "M3", "S3", "M4", "S4", "M5", "S5", "M6", "S6" (M: 중간 사이즈. S: 작은 사이즈. 숫자: 사진 개수)
commercialType	`boolean`	광고 문자 여부
disableSms	`boolean`	대체발송여부. `false` 로 설정했을 경우 해당건이 발송에 실패하게 됐을 때 문자로(SMS, LMS, MMS)로 대체 발송됩니다. 대체 발송이 될 경우 기존 가격은 환불되고 각 문자 타입에 맞는 금액이 차감됩니다. 기본값: `false`
additionalBody	`array`	RCS 사진 문자 전송 시 필요한 오브젝트
buttons	`array`	RCS 템플릿 버튼 목록

Body / messages / rcsOptions / variables

Name	Type	Description
{{홍길동}}	`string`	템플릿에 포함된 대체문구
{{010-0000-0000}}	`string`	템플릿에 포함된 대체문구
{{2021년 6월 17일}}	`string`	템플릿에 포함된 대체문구

Body / messages / rcsOptions / additionalBody

Name	Type	Required	Description
title	`string`	O	슬라이드 제목
description	`string`	O	슬라이드 설명
imageId	`string`		MMS 발송 시 사용되는 이미지의 고유 아이디. 이미지 타입이 `MMS`일 경우에만 사용 가능합니다. 이미지 관리 페이지 (로그인 필요) 이미지 관리 API
buttons	`array`		슬라이드에 추가되는 버튼 목록 최대 2개

Body / messages / rcsOptions / additionalBody / buttons

Name	Type	Required	Description
buttonType	`string`	O	'WL'(웹링크), 'ML'(지도[좌표]), 'MQ'(지도[쿼리]), 'MR'(위치공유), 'CA'(캘린더생성), 'CL'(복사), 'DL'(전화걸기), 'MS'(메시지보내기)
buttonName	`string`	O	버튼 이름
link	`string`		버튼 타입 ML, MQ에 사용되는 링크
latitude	`string`		버튼 타입 ML에 사용되는 위도 좌표
longitude	`string`		버튼 타입 ML에 사용되는 경도 좌표
label	`string`		버튼 타입 ML에 사용되는 레이블
query	`string`		버튼 타입 MQ에 사용되는 쿼리
title	`string`		버튼 타입 CA에 사용되는 일정 이름
startTime	`date`		버튼 타입 CA에 사용되는 일정 시작일
endTime	`date`		버튼 타입 CA에 사용되는 일정 종료작일
text	`string`		메시지 내용. SMS: 90byte 제한 나머지: 2000byte 제한
phone	`string`		핸드폰 번호 버튼 타입 DL과 MS에 사용됨

Body / messages / rcsOptions / buttons

Name	Type	Required	Description
buttonType	`string`	O	'WL'(웹링크), 'ML'(지도[좌표]), 'MQ'(지도[쿼리]), 'MR'(위치공유), 'CA'(캘린더생성), 'CL'(복사), 'DL'(전화걸기), 'MS'(메시지보내기)
buttonName	`string`	O	버튼 이름
link	`string`		버튼 타입 ML, MQ에 사용되는 링크
latitude	`string`		버튼 타입 ML에 사용되는 위도 좌표
longitude	`string`		버튼 타입 ML에 사용되는 경도 좌표
label	`string`		버튼 타입 ML에 사용되는 레이블
query	`string`		버튼 타입 MQ에 사용되는 쿼리
title	`string`		버튼 타입 CA에 사용되는 일정 이름
startTime	`date`		버튼 타입 CA에 사용되는 일정 시작일
endTime	`date`		버튼 타입 CA에 사용되는 일정 종료작일
text	`string`		메시지 내용. SMS: 90byte 제한 나머지: 2000byte 제한
phone	`string`		핸드폰 번호 버튼 타입 DL과 MS에 사용됨

Body / messages / faxOptions

Name	Type	Required	Description
fileIds	`array`		설명 없음

Body / messages / voiceOptions

Name	Type	Description
voiceType	`string`	'MALE', 'FEMALE' (보이스 타입 '남자', '여자')
headerMessage	`string`	머리말, 통화 시작시 나오는 메시지 (최대 70Byte)
tailMessage	`string`	맺음말, 통화가 끝나고 나오는 메시지, 상담원 연결 시 나오지 않음, 머리말이 있어야 사용가능 (최대 70Byte)
replyRange	`number`	통화 내용이 나온 후 1~3번까지의 버튼으로 받는 답변 (수신자에게서 입력받을 숫자, 1~3까지 입력가능, '3'입력 시 1~3번까지 누를 수 있음.)

EX) 안녕하십니까. 쇼핑몰 사이트를 이용해주셔서 감사합니다. 제공해드리는 상품에 대한 만족도를 선택해주세요. 1번 만족. 2번 보통. 3번 불만족 | | counselorNumber | string | | 상담원번호, 번호 입력 시 통화 내용이 나온 후 0번을 누르면 상담원 연결 (replyRange가 없으면 0번외엔 누를 수 없음 ) |

Body / messages / customFields

Name	Type	Required	Description
key	`string`		확장 필드. 키는 30자, 값은 1,000자 제한

Body / agent

Name	Type	Description
appId	`string`	앱 아이디
osPlatform	`string`	OS 플렛폼
sdkVersion	`string`	SDK 버전

Response

Response Structure

{
    "failedMessageList": [
        {
            "to": "string",
            "from": "string",
            "type": "string",
            "country": "string",
            "messageId": "string",
            "statusCode": "string",
            "statusMessage": "string",
            "accountId": "string"
        }
    ],
    "groupInfo": {
        "count": {
            "total": "number",
            "sentTotal": "number",
            "sentFailed": "number",
            "sentSuccess": "number",
            "sentPending": "number",
            "sentReplacement": "number",
            "refund": "number",
            "registeredFailed": "number",
            "registeredSuccess": "number"
        },
        "countForCharge": {
            "sms": {
                "82": "number",
                "101": "number"
            },
            "lms": {
                "82": "number",
                "101": "number"
            },
            "mms": {
                "82": "number",
                "101": "number"
            },
            "ata": {
                "82": "number",
                "101": "number"
            },
            "cta": {
                "82": "number",
                "101": "number"
            },
            "cti": {
                "82": "number",
                "101": "number"
            },
            "nsa": {
                "82": "number",
                "101": "number"
            },
            "rcs_sms": {
                "82": "number",
                "101": "number"
            },
            "rcs_lms": {
                "82": "number",
                "101": "number"
            },
            "rcs_mms": {
                "82": "number",
                "101": "number"
            },
            "rcs_tpl": {
                "82": "number",
                "101": "number"
            },
            "fax": {
                "82": "number",
                "101": "number"
            },
            "voice": {
                "82": "number",
                "101": "number"
            }
        },
        "balance": {
            "requested": "number",
            "replacement": "number",
            "refund": "number",
            "sum": "number"
        },
        "point": {
            "requested": "number",
            "replacement": "number",
            "refund": "number",
            "sum": "number"
        },
        "app": {
            "profit": {
                "sms": "number",
                "lms": "number",
                "mms": "number",
                "ata": "number",
                "cta": "number",
                "cti": "number",
                "nsa": "number",
                "rcs_sms": "number",
                "rcs_lms": "number",
                "rcs_mms": "number",
                "rcs_tpl": "number",
                "fax": "number",
                "voice": "number"
            },
            "app": "string",
            "version": "string"
        },
        "serviceMethod": "string",
        "sdkVersion": "string",
        "osPlatform": "string",
        "log": [
            {
                "createAt": "date",
                "message": "string",
                "oldBalance": "number",
                "newBalance": "number",
                "oldPoint": "number",
                "newPoint": "number",
                "totalPrice": "number"
            }
        ],
        "status": "string",
        "dateSent": "date",
        "scheduledDate": "date",
        "dateCompleted": "date",
        "isRefunded": "boolean",
        "flagUpdated": "boolean",
        "prepaid": "boolean",
        "strict": "boolean",
        "masterAccountId": "string",
        "allowDuplicates": "boolean",
        "_id": "string",
        "accountId": "string",
        "apiVersion": "string",
        "customFields": {
            "key": "string"
        },
        "groupId": "string",
        "price": {
            "82": {
                "sms": "number",
                "lms": "number",
                "mms": "number",
                "ata": "number",
                "cta": "number",
                "cti": "number",
                "nsa": "number",
                "rcs_sms": "number",
                "rcs_lms": "number",
                "rcs_mms": "number",
                "rcs_tpl": "number",
                "fax": "number",
                "voice": "number"
            }
        },
        "dateCreated": "date",
        "dateUpdated": "date"
    }
}

Response Description

Response /

Name	Type	Should Return	Description
failedMessageList	`array`	O	설명 없음
groupInfo	`object`	O	설명 없음

Response / failedMessageList

Name	Type	Should Return	Description
to	`string`	O	수신번호
from	`string`	O	발신번호
type	`string`	O	메시지 타입 SMS: 단문 문자 LMS: 장문 문자 MMS: 사진 문자 ATA: 알림톡 CTA: 친구톡 CTI: 친구톡 + 이미지 NSA: 네이버 스마트 알림 RCS_SMS: RCS 단문 문자 RCS_LMS: RCS 장문 문자 RCS_MMS: RCS 사진 문자 RCS_TPL: RCS 템플릿 문자 FAX: 팩스 VOICE: 보이스콜
country	`string`	O	국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)
messageId	`string`	O	메시지 아이디
statusCode	`string`	O	상태 코드 참고
statusMessage	`string`	O	상태 메시지 참고
accountId	`string`	O	계정 고유 번호

Response / groupInfo

Name	Type	Should Return	Description
count	`object`	O	카운트
countForCharge	`object`	O	차감 카운트
balance	`object`	O	잔액
point	`object`	O	포인트
app	`object`	O	앱 정보
serviceMethod	`string`	O	서비스 메소드. MT: 문자
sdkVersion	`string`	O	SDK 버전
osPlatform	`string`	O	OS / Platform
log	`Array`		로그
status	`string`	O	그룹 상태 PENDING - 대기중 SENDING - 이미 발송 요청된 그룹 DELETED - 삭제 처리된 그룹 FAILED - 실패 처리된 그룹 COMPLETE - 발송 완료된 그룹 SCHEDULED - 발송 예약된 그룹
dateSent	`date`	O	발송 일시
scheduledDate	`date`	O	메시지 예약 날짜
dateCompleted	`date`	O	완료 일시
isRefunded	`boolean`	O	환급 여부
flagUpdated	`boolean`	O	업데이트 여부
prepaid	`boolean`	O	선불 여부. `false`일 시 후불로 차감되는 건
strict	`boolean`	O	엄격 검사 여부. 기본값: `false` - 유요하지 않은 문자 검사(아닐 시 자체적으로 삭제). - LMS 나 MMS에서 제목 여부 검사. (아닐 시 문자 내용에서 제목을 구함). - 템플릿을 발송 전 검사(아닐 시 발송 후 실패).
masterAccountId	`string`	O	해당 서브 계정을 관리하고 있는 마스터계정
allowDuplicates	`boolean`	O	중복 수신번호 허용 여부. 기본값: `false`
_id	`string`	O	그룹 고유 아이디. `groupId`와 동일
accountId	`string`	O	계정 고유 번호
apiVersion	`string`	O	API 버전
customFields	`object`	O	발송 전에 그룹에 입력하였던 커스텀 필드. 아무것도 하지 않았을 시 빈 오브젝트
groupId	`string`	O	그룹 아이디
price	`object`	O	단가
dateCreated	`date`	O	생성 일시
dateUpdated	`date`	O	업데이트 일시

Response / groupInfo / count

Name	Type	Should Return	Description
total	`number`	O	토탈
sentTotal	`number`	O	전체 발송 건수
sentFailed	`number`	O	발송 실패 건수
sentSuccess	`number`	O	발송 성공 건수
sentPending	`number`	O	대기 건수
sentReplacement	`number`	O	대체 발송 건수
refund	`number`	O	환급 건수
registeredFailed	`number`	O	접수 실패 건수
registeredSuccess	`number`	O	접수 성공 건수

Response / groupInfo / countForCharge

Name	Type	Should Return	Description
sms	`object`	O	단문 문자 차감 건수
lms	`object`	O	장문 문자 차감 건수
mms	`object`	O	사진 문자 차감 건수
ata	`object`	O	알림톡 차감 건수
cta	`object`	O	친구톡 차감 건수
cti	`object`	O	친구톡 + 이미지 차감 건수
nsa	`object`	O	네이버 스마트 알림 차감 건수
rcs_sms	`object`	O	RCS 단문 문자 차감 건수
rcs_lms	`object`	O	RCS 장문 문자 차감 건수
rcs_mms	`object`	O	RCS 사진 문자 차감 건수
rcs_tpl	`object`	O	RCS 템플릿 문자 차감 건수
fax	`object`	O	팩스 차감 건수
voice	`object`	O	보이스콜 차감 건수

Response / groupInfo / countForCharge / sms

Name	Type	Should Return	Description
82	`number`		대한민국 단문 문자 차감 건수
101	`number`		특정국가의 단문 문자 차감 건수

Response / groupInfo / countForCharge / lms

Name	Type	Should Return	Description
82	`number`		대한민국 장문 문자 차감 건수
101	`number`		특정국가의 장문 문자 차감 건수

Response / groupInfo / countForCharge / mms

Name	Type	Should Return	Description
82	`number`		대한민국 사진 문자 차감 건수
101	`number`		특정국가의 사진 문자 차감 건수

Response / groupInfo / countForCharge / ata

Name	Type	Should Return	Description
82	`number`		대한민국 알림톡 차감 건수
101	`number`		특정국가의 알림톡 차감 건수

Response / groupInfo / countForCharge / cta

Name	Type	Should Return	Description
82	`number`		대한민국 친구톡 차감 건수
101	`number`		특정국가의 친구톡 차감 건수

Response / groupInfo / countForCharge / cti

Name	Type	Should Return	Description
82	`number`		대한민국 친구톡 + 이미지 차감 건수
101	`number`		특정국가의 친구톡 + 이미지 차감 건수

Response / groupInfo / countForCharge / nsa

Name	Type	Should Return	Description
82	`number`		대한민국 네이버 스마트 알림 차감 건수
101	`number`		특정국가의 네이버 스마트 알림 차감 건수

Response / groupInfo / countForCharge / rcs_sms

Name	Type	Should Return	Description
82	`number`		대한민국 RCS 단문 문자 차감 건수
101	`number`		특정국가의 RCS 단문 문자 차감 건수

Response / groupInfo / countForCharge / rcs_lms

Name	Type	Should Return	Description
82	`number`		대한민국 RCS 장문 문자 차감 건수
101	`number`		특정국가의 RCS 장문 문자 차감 건수

Response / groupInfo / countForCharge / rcs_mms

Name	Type	Should Return	Description
82	`number`		대한민국 RCS 사진 문자 차감 건수
101	`number`		특정국가의 RCS 사진 문자 차감 건수

Response / groupInfo / countForCharge / rcs_tpl

Name	Type	Should Return	Description
82	`number`		대한민국 RCS 템플릿 문자 차감 건수
101	`number`		특정국가의 RCS 템플릿 문자 차감 건수

Response / groupInfo / countForCharge / fax

Name	Type	Should Return	Description
82	`number`		대한민국 팩스 차감 건수
101	`number`		특정국가의 팩스 차감 건수

Response / groupInfo / countForCharge / voice

Name	Type	Should Return	Description
82	`number`		대한민국 보이스콜 차감 건수
101	`number`		특정국가의 보이스콜 차감 건수

Response / groupInfo / balance

Name	Type	Description
requested	`number`	차감 금액
replacement	`number`	대체 발송 금액
refund	`number`	환급 금액
sum	`number`	합계 금액

Response / groupInfo / point

Name	Type	Description
requested	`number`	차감 포인트
replacement	`number`	대체 발송 포인트
refund	`number`	환급 포인트
sum	`number`	합계 포인트

Response / groupInfo / app

Name	Type	Should Return	Description
profit	`object`		앱 사용 요금
app	`string`	O	앱 정보
version	`string`	O	앱 버전

Response / groupInfo / app / profit

Name	Type	Should Return	Description
sms	`number`	O	단문 문자 사용 요금
lms	`number`	O	장문 문자 사용 요금
mms	`number`	O	사진 문자 사용 요금
ata	`number`	O	알림톡 사용 요금
cta	`number`	O	친구톡 사용 요금
cti	`number`	O	친구톡 + 이미지 사용 요금
nsa	`number`	O	네이버 스마트 알림 사용 요금
rcs_sms	`number`	O	RCS 단문 문자 사용 요금
rcs_lms	`number`	O	RCS 장문 문자 사용 요금
rcs_mms	`number`	O	RCS 사진 문자 사용 요금
rcs_tpl	`number`	O	RCS 템플릿 문자 사용 요금
fax	`number`	O	팩스 사용 요금
voice	`number`	O	보이스콜 사용 요금

Response / groupInfo / log

Name	Type	Should Return	Description
createAt	`date`	O	로그 기록 일시
message	`string`	O	로그 메시지
oldBalance	`number`		차감 전 잔액
newBalance	`number`		차감 후 잔액
oldPoint	`number`		차감 전 포인트
newPoint	`number`		차감 후 포인트
totalPrice	`number`		차감액

Response / groupInfo / customFields

Name	Type	Should Return	Description
key	`string`		발송 전에 그룹에 입력하였던 커스텀 값의 키

Response / groupInfo / price

Name	Type	Should Return	Description
82	`object`		대한민국 문자 발송 단가

Response / groupInfo / price / 82

Name	Type	Should Return	Description
sms	`number`	O	단문 문자 발송 단가
lms	`number`	O	장문 문자 발송 단가
mms	`number`	O	사진 문자 발송 단가
ata	`number`	O	알림톡 발송 단가
cta	`number`	O	친구톡 발송 단가
cti	`number`	O	친구톡 + 이미지 발송 단가
nsa	`number`	O	네이버 스마트 알림 발송 단가
rcs_sms	`number`	O	RCS 단문 문자 발송 단가
rcs_lms	`number`	O	RCS 장문 문자 발송 단가
rcs_mms	`number`	O	RCS 사진 문자 발송 단가
rcs_tpl	`number`	O	RCS 템플릿 문자 발송 단가
fax	`number`	O	팩스 발송 단가
voice	`number`	O	보이스콜 발송 단가

문서 생성일 : 2024-02-18

메시지 발송

목차​

Request​

문자별 특징​

단문(SMS)​

필수 필드​

장문(LMS)​

필수 필드​

선택 필드​

사진 문자(MMS)​

필수 필드​

선택 필드​

카카오톡 알림톡(ATA)​

variables 사용​

변수 직접 설정 (비추천)​

필수 필드​

선택 필드​

친구톡 (CTA)​

필수 필드​

선택 필드​

이미지 친구톡 (CTI)​

필수 필드​

선택 필드​

Authorization 인증 필요​

Request Structure​

Body Params​

Body / messages​

Body / messages / kakaoOptions​

Body / messages / kakaoOptions / variables​

Body / messages / kakaoOptions / quickReplies​

Body / messages / kakaoOptions / highlight​

Body / messages / kakaoOptions / item​

Body / messages / kakaoOptions / item / list​

Body / messages / kakaoOptions / item / summary​

Body / messages / kakaoOptions / buttons​

Body / messages / naverOptions​

Body / messages / naverOptions / variables​

Body / messages / naverOptions / buttons​

Body / messages / rcsOptions​

Body / messages / rcsOptions / variables​

Body / messages / rcsOptions / additionalBody​

Body / messages / rcsOptions / additionalBody / buttons​

Body / messages / rcsOptions / buttons​

Body / messages / faxOptions​

Body / messages / voiceOptions​

Body / messages / customFields​

Body / agent​

Response​

Response Structure​

Response Description​

Response /​

Response / failedMessageList​

Response / groupInfo​

Response / groupInfo / count​

Response / groupInfo / countForCharge​

Response / groupInfo / countForCharge / sms​

Response / groupInfo / countForCharge / lms​

Response / groupInfo / countForCharge / mms​

Response / groupInfo / countForCharge / ata​

Response / groupInfo / countForCharge / cta​

Response / groupInfo / countForCharge / cti​

Response / groupInfo / countForCharge / nsa​

Response / groupInfo / countForCharge / rcs_sms​

Response / groupInfo / countForCharge / rcs_lms​

Response / groupInfo / countForCharge / rcs_mms​

Response / groupInfo / countForCharge / rcs_tpl​

Response / groupInfo / countForCharge / fax​

Response / groupInfo / countForCharge / voice​

Response / groupInfo / balance​

Response / groupInfo / point​

Response / groupInfo / app​

Response / groupInfo / app / profit​

Response / groupInfo / log​

Response / groupInfo / customFields​

Response / groupInfo / price​

Response / groupInfo / price / 82​

목차

Request

문자별 특징

단문(SMS)

필수 필드

장문(LMS)

필수 필드

선택 필드

사진 문자(MMS)

필수 필드

선택 필드

카카오톡 알림톡(ATA)

variables 사용

변수 직접 설정 (비추천)

필수 필드

선택 필드

친구톡 (CTA)

필수 필드

선택 필드

이미지 친구톡 (CTI)

필수 필드

선택 필드

Authorization 인증 필요

Request Structure

Body Params

Body / messages

Body / messages / kakaoOptions

Body / messages / kakaoOptions / variables

Body / messages / kakaoOptions / quickReplies

Body / messages / kakaoOptions / highlight

Body / messages / kakaoOptions / item

Body / messages / kakaoOptions / item / list

Body / messages / kakaoOptions / item / summary

Body / messages / kakaoOptions / buttons

Body / messages / naverOptions

Body / messages / naverOptions / variables

Body / messages / naverOptions / buttons

Body / messages / rcsOptions

Body / messages / rcsOptions / variables

Body / messages / rcsOptions / additionalBody

Body / messages / rcsOptions / additionalBody / buttons

Body / messages / rcsOptions / buttons

Body / messages / faxOptions

Body / messages / voiceOptions

Body / messages / customFields

Body / agent

Response

Response Structure

Response Description

Response /

Response / failedMessageList

Response / groupInfo

Response / groupInfo / count

Response / groupInfo / countForCharge

Response / groupInfo / countForCharge / sms

Response / groupInfo / countForCharge / lms

Response / groupInfo / countForCharge / mms

Response / groupInfo / countForCharge / ata

Response / groupInfo / countForCharge / cta

Response / groupInfo / countForCharge / cti

Response / groupInfo / countForCharge / nsa

Response / groupInfo / countForCharge / rcs_sms

Response / groupInfo / countForCharge / rcs_lms

Response / groupInfo / countForCharge / rcs_mms

Response / groupInfo / countForCharge / rcs_tpl

Response / groupInfo / countForCharge / fax

Response / groupInfo / countForCharge / voice

Response / groupInfo / balance

Response / groupInfo / point

Response / groupInfo / app

Response / groupInfo / app / profit

Response / groupInfo / log

Response / groupInfo / customFields

Response / groupInfo / price

Response / groupInfo / price / 82