문자/알림톡 서비스
가맹점 카카오톡 자체 채널로 원하는 템플릿을 등록해 고객에게 정보성 혹은 광고성 메시지를 발송할 수 있는 서비스
Quick Guide
샘플 다운로드
개발 언어에 맞는 샘플을
다운로드 받아 주세요.
테스트 실행 및 결과확인
진행과정과
응답결과를 확인해 주세요.
실제 연동진행
가맹점 실서버 환경에 맞게
연동을 진행해주세요.
연동 준비하기
문자/알림톡 서비스 연동 전, 체크해야할 사항을 안내드립니다.
MID상점아이디
계약 완료 여부, 사용 가능 지불 수단 등은 계약담당자 문의INIAPI key대칭키
가맹점관리자 ▶ 상점정보 ▶ 계약정보 ▶ KEY 정보 ▶ INIAPI Key방화벽정보
| 항목 | 운영환경 | |
|---|---|---|
| URL | bizapi.inicis.com | |
| IP | 118.129.210.163 183.109.71.43 |
|
| PORT | 443 | |
| 연결방향 | OUTBOUND | |
| 프로토콜 | TLS 1.2 이상 지원 | |
STEP1알림톡 메세지 발송요청
발송요청정보
- 발송요청URL : https://bizapi.inicis.com/api/message
- Method : POST
- Content-Type: application/json
- 요청 본문은 Json 형식으로 UTF-8 인코딩 사용하여 세팅
| mid* | String | 상점아이디 MID는 계약완료 후 전달 받으실 수 있습니다. (테스트 발송 불가) 관련 문의 : 영업담당자 또는 pdev@kggroup.co.kr |
10 byte
|
|---|---|---|---|
| yid* | String | 옐로ID |
40 byte
|
| referenceId* | String | 요청 참조 ID (Unique) |
40 byte
|
| messageType* | String | 전송메시지 종류 |
종류
2 byte
|
| recvTel* | String | 수신자 전화번호 ( 01012345678 or 010-1234-5678 ) |
16 byte
|
| templateId | String | 템플릿코드 ( 알림톡 필수 ) |
30 byte
|
| responseType | String | 비즈메시지 응답방식 ( RT : realtime , PS : Push ) 알림톡의 경우 미입력시 push 로 발송 친구톡은 push 방식만 존재하므로 다른값 입력시 무시 * RT (RealTime) : 실시간 응답. 메세지발송까지 처리하고 원천사에서 실시간으로 응답줌. PS (Push) : 메시지 발송요청하면 고객은 받을거라는 전제하에 응답 줌. |
2 byte
|
| timeout | Number | 타임아웃 ( 응답방식에 따라 설정값 변경 가능 ) RT : 5 ~ 15초 ( 이외의 값 입력시 default 10 초 ) PS : 0 으로 설정 ( 의미없음 ) |
2 byte
|
| adFlag | String | 광고성 메시지 표기여부 친구톡일 경우 사용 , 알림톡일 경우 무시 - 광고성 메시지의 경우 Y, 광고성 메시지가 아닌경우 N - Y일 경우 기존 프로필명 부분을 광고 텍스트 표시 및 수신거부 방법 문구 추가 |
1 byte
|
| switchType | String | 비즈메시지 전송 실패시 메시지 전환 발송 구분 ( S: SMS , L: LMS, N: 미사용 ) 미입력시 default :'N' 처리 SMS 전환 발송요청시 smsMessage 가 필수로 입력되어야 하며 입력되지 않은 경우에는 전환 발송 미사용 처리 |
1 byte
|
| sendTel | String | 발신자 전화번호 (01012345678 or 010-1234-5678) messageType = SS or switchType = S 일 경우 필수 messageType = SL or switchType = L 일 경우 필수 |
16 byte
|
| clientIp* | String | 요청 서버 IP ex) 127.0.0.1 |
20 byte
|
| hashData* | String | 해시 데이터 요청 파라미터의 위/변조 검증을 위해서 사용 INIAPI KEY + mid + referenceId + messageType + recvTel 을 SHA512 해시 |
HASH
N/A
|
| content* | Content | 메시지 내용 세팅 시, 아래 "요청본문 상세" 참고 |
상세
N/A
|
| button | Button | 버튼 내용 세팅 시, 아래 "요청본문 상세" 참고 |
상세
N/A
|
TYPE요청본문 상세
- Content
- Button
| smsMessage | String | 대체발송 및 직접발송 SMS 메시지 messageType = SS or switchType = S 일 경우 필수 |
90 Byte
|
|---|---|---|---|
| lmsTitle | String | 대체발송 및 직접발송 LMS 제목 messageType = SL or switchType = L 일 경우 선택 |
50 Byte
|
| lmsMessage | String | 대체발송 및 직접발송 LMS 메시지 messageType = SL or switchType = L 일 경우 필수 |
2000 Byte
|
| alimtalkMessage | String | 알림톡 메시지 친구톡 이미지의 경우 800bytes 제한 |
2000 Byte
|
| count | Number | 총 사용할 버튼갯수 ( 버튼 사용시 필수 ) 0~5개까지 사용 가능 |
1 Byte
|
|
|---|---|---|---|---|
| details (버튼 상세 내용) |
Detail[ ] | type | 버튼타입 친구톡 텍스트, 친구톡 이미지의 경우 배송조회(DS) 버튼 사용 불가 |
버튼타입
2 Byte
|
| order | 버튼순서 알림톡의 경우 템플릿 등록시, 버튼 순서와 일치하지 않을 경우 발송 실패 |
1 Byte
|
||
| name | 버튼 명 |
28 Byte
|
||
| mobileWebUrl | 모바일 환경에서 이동할 Web URL |
200 Byte
|
||
| webUrl | PC 환경에서 이동할 PC URL |
200 Byte
|
||
| iosAppUrl | IOS 환경에서의 Application custom scheme |
200 Byte
|
||
| androidUrl | Android 환경에서의 Application custom scheme |
200 Byte
|
||
STEP2알림톡 메세지 발송응답
※ 유의사항
해당 응답파라미터는 모든 프로세스 종료 후 최종적으로 전달되는 결과값 입니다.
- 응답파라미터는 추후 요건에 의해 추가될 수 있습니다.
- 실패 응답 시, 일부 파라미터 응답이 null 일 수 있습니다.
| resultCode * | String | 결과 코드 |
결과코드
4 byte
|
|
|---|---|---|---|---|
| resultMsg * | String | 결과 메시지 |
100 byte
|
|
| switchType | String | 전환 발송 구분 비즈 메시지 실패 시 응답 |
2 Byte
|
|
| switchResultCode | String | 전환 발송 결과 코드 비즈 메시지 실패 시 응답 |
결과코드
4 Byte
|
|
| switchResultMsg | String | 전환 발송 결과 메시지 비즈 메시지 실패 시 응답 |
100 Byte
|
|
| sendDateTime | String | 전송 시간 ex) 20221012151725 |
16 Byte
|
|
| tid | String | 처리 고유 ID |
40 Byte
|
|
| errorDetails * (요청 파라미터 오류 메시지) |
Message[ ] | field | 요청 필드 |
N/A
|
| contents* | 오류 메시지 |
N/A
|
||