네이버 스마트 알림

네이버 앱에 알림 메시지 발송 규격입니다.

서비스 준비 중 입니다.

• 네이버 회원을 대상으로 네이버 웹페이지와 네이버 모바일 앱에 알림메시지 전송이 가능합니다.

• 메시지 전송을 위해 사전에 톡톡파트너센터 가입 및 템플릿 등록 작업이 필요합니다.

• 상세 Response 내용은 코드표를 참조해주시기 바랍니다.

스마트 알림 전송을 위해 사전 승인된 템플릿코드가 필요 합니다.

스마트 알림 전송

POST /v1/send/naversmart

Request

Header

Name	Type	Description
Authorization	String	schema + “ “ + token
Content-Type	String	application/json
Accept	String	application/json

Body

Name	Type	Required	Description
partnerKey	String	YES	네이버톡톡 파트너키
to	String	YES	수신번호
userName	String	NO	네이버에 등록된 고객명
productCode	String	NO	스마트알림 템플릿 상품코드
templateCode	String	YES	스마트알림 템플릿 코드
templateParam	Object	NO	스마트알림 템플릿 변수 JSON (템플릿에 정의된 {"key":"value"})
templateText	String	NO	스마트알림 템플릿 메시지
attachments	Object	NO	스마트알림 첨부 필드(버튼, 이미지)
groupKey	String	NO	발송그룹키(템플릿 코드 관련)
ref	String(200)	NO	참조필드
fallback	Object	NO	실패 시 전송될 Fallback 메시지 정보

cURL

curl -X POST https://omni.ibapi.kr/v1/send/naversmart\
-H "content-type: application/json" \
-H "Accept: application/json" \
-H "Authorization:Bearer 발급받은 토큰" \
-d '{"templateCode":"템플릿 코드", "partnerKey":"네이버톡톡 파트너키", "to":"수신번호", "ref":"참조필드"}'

JAVA

import java.io.*;
import okhttp3.*;
public class Main {
  public static void main(String []args) throws IOException{
    OkHttpClient client = new OkHttpClient().newBuilder()
      .build();
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"templateCode\":\"템플릿 코드\", \"partnerKey\":\"네이버톡톡 파트너키\", \"to\":\"수신번호\", \"ref\":\"참조필드\"}");
    Request request = new Request.Builder()
      .url("https://omni.ibapi.kr/v1/send/naversmart")
      .method("POST", body)
      .addHeader("Content-Type", "application/json")
      .addHeader("Accept", "application/json")
      .addHeader("Authorization", "Bearer 발급받은 토큰")
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
  }
}

Go

PHP

NodeJS

C#

JavaScript

python

Ruby

Response

Header

Name	Type	Description
Content-Type	String	application/json

Body

Name	Type	Description
code	String(4)	API호출 결과 코드
result	String	API호출 결과 설명
msgKey	String	메시지 키
ref	String(200)	참조필드(요청 시 입력한 데이터)

HTTP 200(성공:Success)

{
    "code": "A000",
    "result": "Success",
    "msgKey": "발급된 메시지 키",
    "ref": "요청시 입력한 데이터"      
}

HTTP 400(실패:Bad Request)

{
    "code": "A010",
    "result": "Cannot parse JSON"
} 

HTTP 401(실패:Unauthorized)

{
    "code": "A001",
    "result": "Expired token"
}

HTTP 429(실패:Too Many Requests)

{
    "code": "A020",
    "result": "Rate limit exceeded"
}

HTTP 500(실패:Forbidden)

{
    "code": "A999",
    "result": "Unknown error"
}

Schema

fallback

Name	Type	Required	Description
type	String(3)	YES	Fallback 종류(SMS, MMS)
from	String	YES	Fallback 발신번호
text	String(2000)	YES	Fallback 메시지 내용
title	String(20)	NO	Fallback 메시지 제목
fileKey	String Array	NO	Fallback 파일키(최대 3개)
originCID	String(9)	NO	Fallback 최초 발신사업자 식별코드