네이버 톡톡

네이버 기반의 정보성 메시지 발송 API

API PLEX 고객센터로 연락하여 템플릿을 사전에 등록 하여야 합니다.

수신 받는 유저가 네이버 앱을 설치한 상태에서만 수신가능 합니다.

캐릭터 인코딩은 UTF-8 을 기본으로 합니다.

네이버톡 발송 API

POST https://4vh6qtie3c.apigw.ntruss.com/naver-talk/v1/send

Headers

Name	Type	Description
Authorization*	string	사용자ID;secret_key
Content-Type*	string	application/json;charset=utf-8

Request Body

Name	Type	Description
message*	string	메시지 본문 등록된 템플릿 문구와 치환 문자를 포함한 메시지 전체 문구를 세팅
templateCode*	string	사전에 등록한 템플릿 코드
phoneNumber*	string	네이버 아이디 생성 시 기입한 유저의 핸드폰 번호
messageKey*	string	메시지 고유 키 (unique 필수)

200: OK 응답 반환 완료

Request Body 예시

{
    "message" : "String",
    "messageKey" : "String",
    "phoneNumber" : "String",
    "templateCode" : "String"
 }

Response body

키	타입	필수	설명
success	bool	Y	성공 여부
resultCode	string	Y	결과 코드
resultMessage	string	Y	결과 메시지
transmissionId	string	Y	발송건 별로 부여되는 유니크 아이디 발송 결과를 조회 시 사용

성공

{
    "success": true,
    "resultCode": "0000",
    "resultMessage": "메세지가 유저에게 앱과 웹으로 성공적으로 전송되었습니다.",
    "transmissionId": 4285012221
}

잘못된 요청 또는 에러

{
    "code": "G210",
    "desc": "요청 JSON 변환중 오류가 발생했습니다."
}

잘못된 list 내부 요청

{
    "results": [
        {
            "code": "C341",
            "msg_key": "2022060900001",
            "desc": "MsgLengthOver"
        },
        {
            "code": "C341",
            "msg_key": "2022060900002",
            "desc": "MsgLengthOver"
        }
    ]
}

Result Code 상세

code	설명
0000	메세지가 유저에게 성공적으로 전송되었습니다.
1000	유저의 네이버 아이디 상태에 문제가 있습니다.
1011	권한 없는 유저에게 발송 시도하였습니다.
2000	템플릿에 필요한 파라미터가 일치하지 않습니다.
2001	템플릿에 필요한 파라미터가 부족합니다.
2002	템플릿 아이디가 존재하지 않습니다.
2003	메세지 포맷 오류입니다.
2004	수신자 전화번호 오류입니다.
9051	서버 내부 오류가 발생하였습니다.
9000	알 수 없는 이유로 메세지가 전송되지 않았습니다.

GATEWAY 오류코드

CODE	설명
G110	서비스 ID가 잘못되었습니다.
G120	유효한 사용자가 존재하지 않습니다.
G130	서비스 KEY가 잘못되었습니다.
G140	유효한 발신번호가 아닙니다.
G150	여신이 부족합니다.
G160	1회 발송 최대 수를 초과했습니다.
G180	필수항목이 누락되었습니다. 항목명: %s
G200	project-key 정보가 잘못되었습니다.
G210	요청 JSON 변환중 오류가 발생했습니다.
G410	원천서비스 서비스 오류 발생
G420	사용자 callback api 호출 오류입니다.
G900	Gateway 시스템 오류가 발생했습니다.
G910	사용자 인증에 실패했습니다.