톡 스튜디오 · 브랜드메시지 단건 발송
브랜드메시지 단건 발송
브랜드 발신프로필로 브랜드메시지(BRM) 1건을 발송하는 API입니다. 타입에 따라 텍스트·이미지·와이드·리스트·캐러셀을 지원하며, 이미지는 이미지 업로드 API로 발급받은 URL만 사용할 수 있습니다.
브랜드메시지 단건 발송
브랜드 발신프로필로 브랜드메시지(BRM) 1건을 발송하는 API입니다. 타입에 따라 텍스트·이미지·와이드·리스트·캐러셀을 지원하며, 이미지는 이미지 업로드 API로 발급받은 URL만 사용할 수 있습니다.
요청 파라미터
| 이름 | 타입 | 필수 | 기본값 | 조건 | 설명 |
|---|---|---|---|---|---|
to |
string | 필수 | - | - | 수신번호입니다. |
profile_key |
string | 필수 | - | - | 브랜드메시지 발신프로필 키(sender key)입니다. 브랜드메시지가 허용된 프로필만 사용할 수 있습니다. |
type |
string | 필수 | - | - | 브랜드메시지 타입입니다.
|
text |
string | 선택 | |
- | 본문입니다. BT·BI·BW에서 사용합니다. |
image_url |
string | 선택 | |
- | 이미지 URL입니다. BI·BW에서 사용하며, 이미지 업로드 API로 발급받은 URL만 유효합니다. |
buttons |
array | 선택 | |
- | 버튼 목록입니다. 각 버튼은 {name, type, url_mobile, url_pc} 형태입니다. BT·BI·BW·BL에서 사용합니다. |
header |
string | 선택 | |
- | 리스트 제목입니다. BL에서 필수이며 20자 이내입니다. |
list_data |
array | 선택 | |
- | BL 리스트 항목입니다. 3~4개이며, 각 항목은 {title, img_url, url_mobile} 형태입니다. img_url은 업로드 API의 URL입니다. |
carousel_data |
array | 선택 | |
- | BC 카드 목록입니다. 2~6개이며, 각 카드는 {header, message, image:{img_url}, buttons:[…]} 형태입니다. |
additional_content |
string | 선택 | |
- | 부가정보입니다. 34자 이내입니다. |
push_alarm |
boolean | 선택 | true |
- | 수신자 푸시 알림 여부입니다. |
optout_number |
string | 선택 | 자동(공용 080) |
- | 무료수신거부 080 번호입니다. 미지정 시 워크스페이스 등록 번호 또는 공용 번호가 적용됩니다. |
fallback |
boolean | 선택 | false |
- | 발송 실패 시 대체문자(SMS/LMS) 발송 여부입니다. |
fallback_text |
string | 선택 | |
- | 대체문자 내용입니다. fallback이 true면 필수입니다. |
fallback_subject |
string | 선택 | 제목 없음 |
- | 대체문자가 LMS로 전환될 때 사용할 제목입니다. |
fallback_from |
string | 선택 | |
- | 대체문자 발신번호입니다. fallback이 true면 필수이며, 승인 등록된 번호만 사용할 수 있습니다. |
reserve_dttm |
string | 선택 | 즉시 발송 |
YYYY-MM-DD HH:mm:ss | 예약 발송 시각입니다. 브랜드메시지는 08~20시에만 발송됩니다. |
idem_key |
string | 선택 | |
- | 멱등키입니다. 같은 키로 다시 접수하면 중복 발송·차감 없이 기존 접수를 반환합니다. |
응답 파라미터
| 이름 | 타입 | 설명 |
|---|---|---|
traceId
|
string | 요청 추적 ID입니다. |
code
|
string | 응답 코드입니다. 성공은 000000입니다. |
message
|
string | 응답 메시지입니다. |
send_key
|
string | 발송 접수 key입니다. |
count
|
integer | 접수된 수신자 수입니다. |
요청 예시
예시 생성 중…
응답 예시 성공
{
"traceId": "9f2c1a7b-4e0d-4b1a-8c2e-1f3a5d7b9c0e",
"code": "000000",
"message": "성공",
"send_key": "a1b2c3d4e5f6a7b8c9d0",
"count": 1
}