단일 메시지

Request

POST https://api.solapi.com/messages/v4/send

하나의 메시지를 발송합니다. 2개 이상의 메시지는 그룹 메시지를 사용하세요.

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

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

Authorization 인증 필요 [?]

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

Request Structure

{
    "message": "object",
    "strict": "boolean",
    "agent": "object",
    "allowDuplicates": "boolean"
}

Body Params

Name	Type	Required	Description
message	object	O	메시지에 대한 정보
strict	boolean		설명 없음
agent	object		에이전트
allowDuplicates	boolean		설명 없음

Body / message

Name	Type	Required	Description
to	string	O	수신번호
from	string	O	발신번호 사전 등록된 전화번호만 사용 가능
text	string		메시지 내용 한글 1,000자, 영문 2,000자 제한
type	string		메시지 타입
country	string		국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)
subject	string		메시지 제목 한글 20자, 영문 40자 제한
imageId	string		Storage API에 등록된 이미지 아이디 참고
kakaoOptions	object		친구톡, 알림톡을 보내기 위한 옵션
naverOptions	object		네이버 스마트 알림을 보내기 위한 옵션
rcsOptions	object		설명 없음
customFields	object		확장 필드로 사용. 키는 30자, 값은 100자 제한
autoTypeDetect	boolean		타입 설정이 없을 경우 자동으로 설정함. 기본 값은 true

Body / message / kakaoOptions

Name	Type	Required	Description
pfId	string		테스트에서 발급된 카카오톡 채널의 연동 아이디
pfGroupId	string		설명 없음
title	string		설명 없음
adFlag	boolean		설명 없음
templateId	string		알림톡 템플릿 아이디
disableSms	boolean		대체 발송 여부
imageId	string		Storage API에 등록된 이미지 아이디 참고
variables	object		설명 없음
buttons	array		알림톡 템플릿 버튼 목록

Body / message / kakaoOptions / variables

Body / message / kakaoOptions / buttons

Name	Type	Required	Description
buttonName	string	O	버튼 이름
buttonType	string	O	버튼 종류(AL: 앱링크, WL: 웹링크, DS: 배송조회, BK: 키워드, MD: 전달, BC: 상담톡 전환, BT: 봇 전환, AC: 채널 추가
linkMo	string		모바일 링크(WL 웹링크)
linkPc	string		웹 링크(WL 웹링크)
linkAnd	string		안드로이드 링크(AL 앱링크)
linkIos	string		IOS 링크(AL 앱링크)

Body / message / naverOptions

Name	Type	Required	Description
talkId	string		설명 없음
templateId	string		알림톡 템플릿 아이디
disableSms	boolean		대체 발송 여부
variables	object		설명 없음
buttons	array		네이버 스마트 알림 템플릿 버튼 목록

Body / message / naverOptions / variables

Body / message / naverOptions / buttons

Name	Type	Required	Description
buttonType	string	O	설명 없음
linkMo	string		모바일 링크
linkPc	string		웹 링크
linkAnd	string		설명 없음
linkIos	string		설명 없음

Body / message / rcsOptions

Name	Type	Required	Description
brandId	string		설명 없음
templateId	string		알림톡 템플릿 아이디
copyAllowed	boolean		설명 없음
variables	object		설명 없음
mmsType	string		설명 없음
commercialType	boolean		설명 없음
disableSms	boolean		대체 발송 여부
additionalBody	array		설명 없음
buttons	array		설명 없음

Body / message / rcsOptions / variables

Body / message / rcsOptions / additionalBody

Name	Type	Required	Description
title	string	O	설명 없음
description	string	O	설명 없음
imageId	string		Storage API에 등록된 이미지 아이디 참고
buttons	array		설명 없음

Body / message / rcsOptions / additionalBody / buttons

Name	Type	Required	Description
buttonType	string	O	설명 없음
link	string		설명 없음
latitude	string		설명 없음
longitude	string		설명 없음
label	string		설명 없음
query	string		설명 없음
title	string		설명 없음
startTime	date		설명 없음
endTime	date		설명 없음
text	string		메시지 내용 한글 1,000자, 영문 2,000자 제한
phone	string		설명 없음

Body / message / rcsOptions / buttons

Name	Type	Required	Description
buttonType	string	O	설명 없음
link	string		설명 없음
latitude	string		설명 없음
longitude	string		설명 없음
label	string		설명 없음
query	string		설명 없음
title	string		설명 없음
startTime	date		설명 없음
endTime	date		설명 없음
text	string		메시지 내용 한글 1,000자, 영문 2,000자 제한
phone	string		설명 없음

Body / message / customFields

Body / agent

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

---

Response

Response Structure

{
    "groupId": "string",
    "messageId": "string",
    "accountId": "string",
    "statusMessage": "string",
    "statusCode": "string",
    "to": "string",
    "from": "string",
    "type": "string",
    "country": "string"
}

Response Description

Response /

Name	Type	Should Return	Description
groupId	string	O	그룹 아이디
messageId	string	O	메시지 아이디
accountId	string	O	계정 고유 번호
statusMessage	string	O	상태 메시지 참고
statusCode	string	O	상태 코드 참고
to	string	O	수신번호
from	string	O	발신번호 사전 등록된 전화번호만 사용 가능
type	string	O	메시지 타입
country	string	O	국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)

---

Samples

메시지 발송 (type: Auto Detect)

Sample Request

{
    "message": {
        "to": "01000000001",
        "from": "029302266",
        "text": "내용"
    }
}

Sample Response

{
    "groupId": "G4V20211116140944NLZUCJOCVNOYW9Y",
    "to": "01000000001",
    "from": "029302266",
    "type": "SMS",
    "statusMessage": "정상 접수(이통사로 접수 예정) ",
    "country": "82",
    "messageId": "M4V20211116140944VNOQH1HURYHEWL8",
    "statusCode": "2000",
    "accountId": "12925149"
}

Sample Code

NODE

var request = require('request');

var options = {
  headers: {
    Authorization:
      'HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4',
    'Content-Type': 'application/json'
  },
  body: {
    message: {
      to: '01000000001',
      from: '029302266',
      text: '내용'
    }
  },
  method: 'POST',
  json: true,
  url: 'http://api.solapi.com/messages/v4/send'
};

request(options, function(error, response, body) {
  if (error) throw error;
  console.log('result :', body);
});

PHP

PYTHON

CURL

RUBY

GO

JAVA

---

단문문자(SMS) 발송

Sample Request

{
    "message": {
        "to": "01000000001",
        "from": "029302266",
        "text": "내용",
        "type": "SMS"
    }
}

Sample Response

{
    "groupId": "G4V20211116140944BCLIG9ES8GNDEWD",
    "to": "01000000001",
    "from": "029302266",
    "type": "SMS",
    "statusMessage": "정상 접수(이통사로 접수 예정) ",
    "country": "82",
    "messageId": "M4V20211116140944ZD7XAL8ZZJHXELL",
    "statusCode": "2000",
    "accountId": "12925149"
}

Sample Code

NODE

var request = require('request');

var options = {
  headers: {
    Authorization:
      'HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4',
    'Content-Type': 'application/json'
  },
  body: {
    message: {
      to: '01000000001',
      from: '029302266',
      text: '내용',
      type: 'SMS'
    }
  },
  method: 'POST',
  json: true,
  url: 'http://api.solapi.com/messages/v4/send'
};

request(options, function(error, response, body) {
  if (error) throw error;
  console.log('result :', body);
});

PHP

PYTHON

CURL

RUBY

GO

JAVA

---

장문문자(LMS) 발송

Sample Request

{
    "message": {
        "to": "01000000001",
        "from": "029302266",
        "subject": "별 헤는 밤",
        "text": "봄이 어머니, 패, 한 부끄러운 이웃 별 옥 계집애들의 계십니다. 내린 아무 아름다운 나는 이름을 있습니다. 위에도 하나에 못 북간도에 새워 강아지, 말 비둘기, 헤는 듯합니다. 가을로 했던 위에도 이름자를 봅니다. 아무 새겨지는 별 너무나 토끼, 듯합니다. 청춘이 헤는 토끼, 계절이 많은 듯합니다. 아름다운 못 내 그리고 아직 청춘이 라이너 버리었습니다. 벌레는 까닭이요, 어머니 봅니다. 속의 아이들의 나는 프랑시스 있습니다. 밤이 강아지, 하나 계십니다. 잔디가 이름과 별 프랑시스 하나에 하나 계십니다.",
        "type": "LMS"
    }
}

Sample Response

{
    "groupId": "G4V20211116140944PEIEQC7SAOFWBAP",
    "to": "01000000001",
    "from": "029302266",
    "type": "LMS",
    "statusMessage": "정상 접수(이통사로 접수 예정) ",
    "country": "82",
    "messageId": "M4V20211116140944XDPZ2G44FRLYEX7",
    "statusCode": "2000",
    "accountId": "12925149"
}

Sample Code

NODE

var request = require('request');

var options = {
  headers: {
    Authorization:
      'HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4',
    'Content-Type': 'application/json'
  },
  body: {
    message: {
      to: '01000000001',
      from: '029302266',
      subject: '별 헤는 밤',
      text:
        '봄이 어머니, 패, 한 부끄러운 이웃 별 옥 계집애들의 계십니다. 내린 아무 아름다운 나는 이름을 있습니다. 위에도 하나에 못 북간도에 새워 강아지, 말 비둘기, 헤는 듯합니다. 가을로 했던 위에도 이름자를 봅니다. 아무 새겨지는 별 너무나 토끼, 듯합니다. 청춘이 헤는 토끼, 계절이 많은 듯합니다. 아름다운 못 내 그리고 아직 청춘이 라이너 버리었습니다. 벌레는 까닭이요, 어머니 봅니다. 속의 아이들의 나는 프랑시스 있습니다. 밤이 강아지, 하나 계십니다. 잔디가 이름과 별 프랑시스 하나에 하나 계십니다.',
      type: 'LMS'
    }
  },
  method: 'POST',
  json: true,
  url: 'http://api.solapi.com/messages/v4/send'
};

request(options, function(error, response, body) {
  if (error) throw error;
  console.log('result :', body);
});

PHP

PYTHON

CURL

RUBY

GO

JAVA

---

사진문자(MMS) 발송

Sample Request

{
    "message": {
        "to": "01000000001",
        "from": "029302266",
        "subject": "제목",
        "text": "내용",
        "type": "MMS",
        "imageId": "FILEID191113003354156UvCuw3tubTl"
    }
}

Sample Response

{
    "groupId": "G4V20211116140944QBEPOVPHEIB5AYQ",
    "to": "01000000001",
    "from": "029302266",
    "type": "MMS",
    "statusMessage": "정상 접수(이통사로 접수 예정) ",
    "country": "82",
    "messageId": "M4V20211116140944MKKV0PCO7OA267A",
    "statusCode": "2000",
    "accountId": "12925149"
}

Sample Code

NODE

var request = require('request');

var options = {
  headers: {
    Authorization:
      'HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4',
    'Content-Type': 'application/json'
  },
  body: {
    message: {
      to: '01000000001',
      from: '029302266',
      subject: '제목',
      text: '내용',
      type: 'MMS',
      imageId: 'FILEID191113003354156UvCuw3tubTl'
    }
  },
  method: 'POST',
  json: true,
  url: 'http://api.solapi.com/messages/v4/send'
};

request(options, function(error, response, body) {
  if (error) throw error;
  console.log('result :', body);
});

PHP

PYTHON

CURL

RUBY

GO

JAVA

---

알림톡(ATA) 발송

Sample Request

{
    "message": {
        "to": "01000000001",
        "from": "029302266",
        "text": "#{홍길동}님이 요청하신 출금 요청 처리가 완료되어 아래 정보로 입금 처리되었습니다. #{입금정보} 관련하여 문의 있으시다면'1:1문의하기'를이용부탁드립니다. 감사합니다.",
        "type": "ATA",
        "kakaoOptions": {
            "pfId": "KA01PF190227072057634pRBhbpAw1w1",
            "templateId": "test_2019030716320324334488000",
            "buttons": [
                {
                    "buttonType": "WL",
                    "buttonName": "1:1문의",
                    "linkMo": "https://www.example.com"
                }
            ]
        }
    }
}

Sample Response

{
    "groupId": "G4V20211116140944IKJI2V4VHCUM8KB",
    "to": "01000000001",
    "from": "029302266",
    "type": "ATA",
    "statusMessage": "정상 접수(이통사로 접수 예정) ",
    "country": "82",
    "messageId": "M4V20211116140944PFJKEOHPDEYMFRE",
    "statusCode": "2000",
    "accountId": "12925149"
}

Sample Code

NODE

var request = require('request');

var options = {
  headers: {
    Authorization:
      'HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4',
    'Content-Type': 'application/json'
  },
  body: {
    message: {
      to: '01000000001',
      from: '029302266',
      text:
        "#{홍길동}님이 요청하신 출금 요청 처리가 완료되어 아래 정보로 입금 처리되었습니다. #{입금정보} 관련하여 문의 있으시다면'1:1문의하기'를이용부탁드립니다. 감사합니다.",
      type: 'ATA',
      kakaoOptions: {
        pfId: 'KA01PF190227072057634pRBhbpAw1w1',
        templateId: 'test_2019030716320324334488000',
        buttons: [
          {
            buttonType: 'WL',
            buttonName: '1:1문의',
            linkMo: 'https://www.example.com'
          }
        ]
      }
    }
  },
  method: 'POST',
  json: true,
  url: 'http://api.solapi.com/messages/v4/send'
};

request(options, function(error, response, body) {
  if (error) throw error;
  console.log('result :', body);
});

PHP

PYTHON

CURL

RUBY

GO

JAVA

---

친구톡(CTA) 발송

Sample Request

{
    "message": {
        "to": "01000000001",
        "from": "029302266",
        "text": "내용",
        "type": "CTA",
        "kakaoOptions": {
            "pfId": "KA01PF190227072057634pRBhbpAw1w1"
        }
    }
}

Sample Response

{
    "groupId": "G4V20211116140944IA0PWC8ZPLGQLHQ",
    "to": "01000000001",
    "from": "029302266",
    "type": "CTA",
    "statusMessage": "정상 접수(이통사로 접수 예정) ",
    "country": "82",
    "messageId": "M4V20211116140944ZRDS8RDQRYVFW4X",
    "statusCode": "2000",
    "accountId": "12925149"
}

Sample Code

NODE

var request = require('request');

var options = {
  headers: {
    Authorization:
      'HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4',
    'Content-Type': 'application/json'
  },
  body: {
    message: {
      to: '01000000001',
      from: '029302266',
      text: '내용',
      type: 'CTA',
      kakaoOptions: {
        pfId: 'KA01PF190227072057634pRBhbpAw1w1'
      }
    }
  },
  method: 'POST',
  json: true,
  url: 'http://api.solapi.com/messages/v4/send'
};

request(options, function(error, response, body) {
  if (error) throw error;
  console.log('result :', body);
});

PHP

PYTHON

CURL

RUBY

GO

JAVA

---

친구톡 사진(CTI) 발송

Sample Request

{
    "message": {
        "to": "01000000001",
        "from": "029302266",
        "text": "내용",
        "type": "CTI",
        "kakaoOptions": {
            "pfId": "KA01PF190227072057634pRBhbpAw1w1",
            "imageId": "FILEID191113003354156UvCuw3tubTl"
        }
    }
}

Sample Response

{
    "groupId": "G4V20211116140945PGHWP2AZZ6GSAXP",
    "to": "01000000001",
    "from": "029302266",
    "type": "CTI",
    "statusMessage": "정상 접수(이통사로 접수 예정) ",
    "country": "82",
    "messageId": "M4V20211116140945XICC9BD6FGEQ7TA",
    "statusCode": "2000",
    "accountId": "12925149"
}

Sample Code

NODE

var request = require('request');

var options = {
  headers: {
    Authorization:
      'HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4',
    'Content-Type': 'application/json'
  },
  body: {
    message: {
      to: '01000000001',
      from: '029302266',
      text: '내용',
      type: 'CTI',
      kakaoOptions: {
        pfId: 'KA01PF190227072057634pRBhbpAw1w1',
        imageId: 'FILEID191113003354156UvCuw3tubTl'
      }
    }
  },
  method: 'POST',
  json: true,
  url: 'http://api.solapi.com/messages/v4/send'
};

request(options, function(error, response, body) {
  if (error) throw error;
  console.log('result :', body);
});

PHP

PYTHON

CURL

RUBY

GO

JAVA

---

sendSimpleMessage

Sample Request

{
    "strict": false,
    "message": {
        "to": "01000000001",
        "from": "029302266",
        "text": "뷁뒑뤩궭훩홊",
        "type": "SMS"
    }
}

Sample Response

{
    "groupId": "G4V20211116140944UA2I4BCJUKCFXBC",
    "to": "01000000001",
    "from": "029302266",
    "type": "SMS",
    "statusMessage": "정상 접수(이통사로 접수 예정) ",
    "country": "82",
    "messageId": "M4V20211116140944DY60GNXJWKICXUY",
    "statusCode": "2000",
    "accountId": "12925149"
}

Sample Code

NODE

var request = require('request');

var options = {
  headers: {
    Authorization:
      'HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4',
    'Content-Type': 'application/json'
  },
  body: {
    strict: false,
    message: {
      to: '01000000001',
      from: '029302266',
      text: '뷁뒑뤩궭훩홊',
      type: 'SMS'
    }
  },
  method: 'POST',
  json: true,
  url: 'http://api.solapi.com/messages/v4/send'
};

request(options, function(error, response, body) {
  if (error) throw error;
  console.log('result :', body);
});

PHP

PYTHON

CURL

RUBY

GO

JAVA

---

문서 생성일 : 2021-11-16