Kakao i Connect Message::BizMessage(KOR)::API 호출 방식::API 레퍼런스::네이버톡톡 발송

페이지 이동경로

네이버톡톡

BizMessage API를 사용하여 전화번호를 기반으로 사용자에게 네이버톡톡 메시지를 발송할 수 있습니다. 필요에 따라 NT_FM과 NT_TM 타입을 선택할 수 있으며, 두 타입 모두 수신자가 받는 메시지는 동일합니다.

네이버톡톡 서비스 타입
타입 구분 설명
NT_FM 메시지 발송 치환 대상 템플릿 변수를 포함하여 전체 본문을 첨부하는 방식
NT_TM 메시지 발송 전체 본문을 첨부하지 않고 치환 대상 템플릿 변수만 첨부하는 방식

안내

  • 모든 BizMessage API를 호출하기 전, OAuth 2.0 인증 API를 선제적으로 호출해야 합니다.
  • API 기능별 예제는 Sample Code 문서를 참고하시기 바랍니다.
주의
스테이징 서버는 카카오 운영 서버와 연동되어 있어 실제 메시지가 발송되므로, 메시지 오발송에 주의하시기 바랍니다.

네이버톡톡 발송

네이버톡톡을 발송하는 API는 다음과 같습니다.

Request

Request Syntax

코드예제네이버톡톡 발송 Request Syntax

curl -X POST "https://{base_url}/v2/send/naver" \
-H  "accept: */*" \
-H  "authorization: Bearer {oauthToken}" \
-H  "Content-Type: application/json" \
-d  '{
  "cid": "202210181700001",
  "message_type": "NT_TM",
  "sender_key": "30cnYS1WSFqnIlMSQ4j4",
  "user_name": "홍길동",
  "sender_no": "0316001021",
  "phone_number": "821000000000",
  "template_params": {
    "이름": "홍길동",
    "휴대폰번호": "010-0000-0000"
  },
  "template_code": "NT-202210010000001",
  "fall_back_yn": false,
  "fall_back_message_type" : "SM",
  "fall_back_title": "대체 메시지 타이틀",
  "fall_back_message": "대체 메시지"
}'

API 호출 방식
메서드 요청 URL
POST https://{base_url}/v2/send/naver
네이버톡톡 발송 Path Parameter
파라미터 유형 필수 여부 대분류 구분 설명
base_url String 필수 운영 일반 bizmsg-web.kakaoenterprise.com
금융권 bizmsg-bank.kakaoenterprise.com
증권 bizmsg-stock.kakaoenterprise.com
공공 기관 bizmsg-gov.kakaoenterprise.com
스테이징 일반 stg-user.bizmsg.kakaoenterprise.com
금융권 stg-bizmsg-bank.kakaoenterprise.com
증권 stg-bizmsg-stock.kakaoenterprise.com
공공 기관 stg-bizmsg-gov.kakaoenterprise.com

Request Header

네이버톡톡 발송 Request Header
파라미터 타입 필수 여부 설명
accept String 필수 */*로 고정
authorization String 필수 Bearer {oauthToken}
- {oauthToken}: OAuth 2.0 인증 API로 발급받은 액세스 토큰
Content-Type String 필수 application/json으로 고정

Request Elements

네이버톡톡 발송 Request Elements
파라미터 타입 필수 여부 설명
cid String 필수 고객사 정의 Key ID
message_type String 필수 메시지 타입
NT_FM: 네이버톡톡 변수 포함 본문 전체 첨부하여 발송
NT_TM: 네이버톡톡 변수만 첨부하여 발송
phone_number String 필수 수신자 전화번호(국가코드(82)를 포함) 
- text(16)
message String 선택 템플릿 변수 포함 본문 첨부
- NT_FM 타입: template_params, message 중 하나만 사용 가능
sender_key String 필수 발송 채널 키
user_name String 선택 수신자 이름
template_params Map 선택 템플릿 치환 대상 변수 첨부
- NT_TM 타입: template_params, message 중 하나만 사용 가능
template_code String 필수 네이버톡톡 템플릿 코드
- text(30)
client_id String 선택 고객사 ID
sender_no String 필수 고객사 발신 전화번호 (대체 발송 시 사용, 미사용 시 임의 값 가능)
- text(16)
group_key String 선택 네이버톡톡 발송 그룹 키
attachments Map 선택 템플릿 버튼, 이미지, 쿠폰 정보 등 첨부
- attachments 데이터 예시 참고
biz_no String 선택 최초 발신자 식별 코드 (재판사용)
department_cd String 선택 부서 코드
- 다채널 대체 발송 사용 시 Rule 매핑 정보로 사용됨
fall_back_yn Boolean 필수 대체 전송 사용 여부
true: 대체 메시지를 전송
false(기본값): 대체 메시지를 전송하지 않음
fall_back_message_type String 선택 대체 발송 시 메시지 타입
- text(2)
SM: SMS로 대체 발송
LM: LMS로 대체 발송
fall_back_title String 선택 대체 발송 메시지 제목
- 60 Byte
fall_back_message String 선택 대체 발송 메시지 본문
- text(2000)
tax_cd1 String 선택 정산 코드1
- 고객사가 정산을 위해 정의하여 사용하는 변수 
- text(50)
tax_cd2 String 선택 정산 코드2
- 고객사가 정산을 위해 정의하여 사용하는 변수
- text(50)

Attachments 데이터 예시

Response

Response Syntax

코드예제네이버톡톡 발송 Response Syntax

{
        "code": "200",
        "result": {
                "detail_code": "0000",
                "detail_message": "메세지가 유저에게 앱과 웹으로 성공적으로 전송되었습니다."
        },
        "uid": "221207021748962tny0fmfLSS6ewZI",
        "cid": "221207000000001"
}

Response Elements

네이버톡톡 발송 Response Elements
프로퍼티 타입 필수 여부 설명
code String 선택 메시지 발송 결과 코드
- 100: 발송 진행 중 (처리중)
- 200: 성공
- 400: 권한 오류
- 410: 입력값이 유효하지 않음
- 420: 파일/이미지 관련 오류
- 500: 내부 시스템 오류
- 510: 발송 실패
- 520: 실패되었으나 재 발송 가능
Result 선택 세부 결과 정보(참고용)
detail_code String 선택 세부 결과 코드(참고용)
detail_message String 선택 세부 결과 메시지(참고용)
uid String 선택 메시지 Key ID
cid String 선택 고객사 정의 Key ID
안내
네이버톡톡은 발송 API 응답으로 결과를 수신하는 Push 방식만 제공하므로 발송을 제외한 별도의 API가 존재하지 않습니다.
이 문서가 만족스러운 이유를 알려주세요.
이 문서에 아쉬운 점을 알려주세요.
평가해주셔서 감사합니다.

더 자세한 의견은 documentation@kakaoenterprise.com 으로 제보해주세요.