NITSOFT

알림톡 발송

post

EndPoint

POST /kakao/alimtalk/{channelId}

Parameters

channelId

채널 아이디

Parameters Body

templateCode

템플릿 코드

destination

수신 대상 정보

phone

수신자 전화번호

params

변수(json key(변수 명) : value(치환할 값))

content

메시지 본문 (본문 입력 시 params(변수 치환) 항목은 무시)

buttons

버튼 정보 배열

name

버튼명

type

버튼 유형 (WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지 전달, AC: 채널추가)

urlPc

버튼 PC 링크 주소

urlMobile

버튼 모바일 링크 주소

schemeAndroid

버튼 Android Scheme

schemeIos

버튼 IOS Scheme

variables

고정 변수(json key(변수 명) : value(치환할 값)

isTest

테스트 발송 여부 (1: 테스트, 0: 정상발송)

reserve

예약 여부

sendDate

예약 일시(reserve 가 1인 경우 필수, "yyyy-MM-dd hh:mm:ss")

callback

발신 번호

fallback

대체 문자 발송 여부

fallbackMessage

대체 문자

callbackIdx

대체 문자 발송 발신번호 고유번호(fallback:1 인경우 필수, /message/channels api 호출 결과의 idx)

kisacode

KISA코드 (KISA에서 발급한 9자리 숫자 코드)

Response

- JSON

statusCode

오류 코드

error

오류 메세지

message

결과 메세지

historyIdx

발송 인덱스 번호

count

총 발송 요청 수량

sendLogIdx

발송 상세 인덱스 번호 리스트

Example

Request

POST /kakao/alimtalk/{channelId}

RequestBody

{
    "templateCode": "00000000000000000",
    "destination": [
        {
            "phone": "01000000000",
            "params": {
                "coupon_notice1": "쿠폰",
                "user_name": "홍길동"
            }
        }
    ],
    "variables": {
        "URL": "https://www.nitsoft.co.kr"
    },
    "reserve": 1,
    "sendDate": "2024-01-01 10:10:00",
    "callback": "01000000000",
    "fallback": 1,
    "fallbackMessage": "test",
    "callbackIdx": 0,
    "isTest": 1,
    "kisacode": 123456789
}

Response

{
    "historyIdx": 1742,
    "count": 1,
    "sendLogIdx": [
        100,
        101,
        102
    ]
}

ErrorResponse

{
    "statusCode": 400,
    "error": "Bad Request",
    "message": "테스트 발송 여부를 입력해주세요. (isTest)"
}