본문 바로가기
개발자 문서 메뉴

JavaScript / TypeScript / SDK REFERENCE

React / Next.js SDK 가이드

React / Next.js에서 카카오 알림톡, 브랜드메시지, SMS를 발송하는 공식 React SDK

이 문서의 목차
패키지
@sendgo/react
언어
JavaScript / TypeScript
레지스트리
npm
설치
npm install @sendgo/react

React / Next.js에서 카카오 알림톡, 브랜드메시지, SMS를 발송하는 공식 React SDK

중요: 이 패키지는 서버사이드 전용입니다. Next.js Server Actions, Route Handlers, API Routes에서만 사용하세요. 클라이언트 컴포넌트에서 직접 사용하면 API 키가 브라우저에 노출됩니다.


설치

npm install @sendgo/react @sendgo/node
# 또는
pnpm add @sendgo/react @sendgo/node

빠른 시작

Next.js Server Action

// app/actions/notify.ts
'use server'

import { createSendgoClient } from '@sendgo/react';

const sendgo = createSendgoClient({
  accessKey:      process.env.SENDGO_ACCESS_KEY!,
  secretKey:      process.env.SENDGO_SECRET_KEY!,
  kakaoSenderKey: process.env.SENDGO_KAKAO_SENDER_KEY,
  apiVersion:     'v2',
});

export async function sendOrderConfirmAction(phone: string, orderNo: string) {
  return sendgo.alimtalk.send({
    templateCode: 'ORDER_CONFIRM_001',
    contacts: [{ contact: phone, var1: orderNo }],
  });
}

클라이언트 컴포넌트에서 훅 사용

// app/components/OrderButton.tsx
'use client'

import { useAlimtalk } from '@sendgo/react';
import { sendOrderConfirmAction } from '../actions/notify';

export function OrderButton({ phone, orderNo }: { phone: string; orderNo: string }) {
  const { send, loading, error } = useAlimtalk(sendOrderConfirmAction);

  return (
    <div>
      <button
        onClick={() => send(phone, orderNo)}
        disabled={loading}
        className="btn-primary"
      >
        {loading ? '발송 중...' : '주문 확인 알림 전송'}
      </button>
      {error && <p className="text-red-500">발송 실패: {error.message}</p>}
    </div>
  );
}

알림톡 상세 사용법

// app/actions/alimtalk.ts
'use server'

import { createSendgoClient } from '@sendgo/react';

const sendgo = createSendgoClient({
  accessKey:      process.env.SENDGO_ACCESS_KEY!,
  secretKey:      process.env.SENDGO_SECRET_KEY!,
  kakaoSenderKey: process.env.SENDGO_KAKAO_SENDER_KEY,
  smsSenderKey:   process.env.SENDGO_SMS_SENDER_KEY,
  apiVersion:     'v2',
});

// 다건 발송
export async function sendBulkAlimtalk() {
  return sendgo.alimtalk.send({
    templateCode: 'ORDER_CONFIRM_001',
    contacts: [
      { contact: '01011111111', name: '홍길동', var1: 'ORD-001', var2: '29,000원' },
      { contact: '01022222222', name: '김철수', var1: 'ORD-002', var2: '15,000원' },
      { contact: '01033333333', name: '이영희', var1: 'ORD-003', var2: '52,000원' },
    ],
  });
}

// 예약 발송
export async function sendScheduledAlimtalk(phone: string) {
  return sendgo.alimtalk.send({
    templateCode:  'PROMO_SUMMER_2026',
    scheduleType:  'SCHEDULED',
    at:            '2026-07-28 09:00:00',
    contacts:      [{ contact: phone, var1: '여름 한정 50% 할인' }],
  });
}

// SMS 대체 발송
export async function sendWithFallback(phone: string, trackingNo: string) {
  return sendgo.alimtalk.send({
    templateCode:  'DELIVERY_START_001',
    replaceSms:    'Y',
    smsSubject:    '[배송 시작 안내]',
    smsContent:    `주문하신 상품이 출고되었습니다.\n송장번호: ${trackingNo}`,
    contacts:      [{ contact: phone, var1: 'ORD-001', var2: trackingNo }],
  });
}

SMS / LMS / MMS 사용법

// app/actions/sms.ts
'use server'

import { createSendgoClient } from '@sendgo/react';

const sendgo = createSendgoClient({ accessKey: '...', secretKey: '...' });

// SMS
export async function sendSms(phone: string, code: string) {
  return sendgo.sms.sendSms({
    content:  `[Sendgo] 인증번호: ${code} (5분 이내 입력)`,
    contacts: [{ contact: phone }],
  });
}

// LMS
export async function sendLms(phone: string) {
  return sendgo.sms.sendLms({
    subject:  '[중요] 서비스 점검 안내',
    content:  '안녕하세요. 서비스 점검이 예정되어 있습니다.\n■ 일시: 2026-07-25 02:00 ~ 06:00',
    contacts: [{ contact: phone }],
  });
}

Route Handler (App Router)

// app/api/notify/order/route.ts
import { NextRequest, NextResponse } from 'next/server';
import { createSendgoClient } from '@sendgo/react';

const sendgo = createSendgoClient({
  accessKey:      process.env.SENDGO_ACCESS_KEY!,
  secretKey:      process.env.SENDGO_SECRET_KEY!,
  kakaoSenderKey: process.env.SENDGO_KAKAO_SENDER_KEY,
  apiVersion:     'v2',
});

export async function POST(request: NextRequest) {
  const { phone, orderNo, amount } = await request.json();

  await sendgo.alimtalk.send({
    templateCode: 'ORDER_CONFIRM_001',
    contacts: [{ contact: phone, var1: orderNo, var2: amount }],
  });

  return NextResponse.json({ success: true });
}

useSms 훅

'use client'

import { useSms } from '@sendgo/react';
import { sendSmsAction } from '../actions/sms';

export function VerificationForm() {
  const [phone, setPhone] = useState('');
  const { send, loading, error, data } = useSms(sendSmsAction);

  return (
    <form onSubmit={(e) => { e.preventDefault(); send(phone, '123456'); }}>
      <input
        type="tel"
        value={phone}
        onChange={(e) => setPhone(e.target.value)}
        placeholder="010-0000-0000"
      />
      <button type="submit" disabled={loading}>
        {loading ? '발송 중...' : '인증번호 받기'}
      </button>
      {error && <p className="error">발송 실패: {error.message}</p>}
      {data && <p className="success">인증번호가 발송되었습니다.</p>}
    </form>
  );
}

브랜드메시지 · 짧은 URL

이 패키지는 코어(@sendgo/node)의 클라이언트를 그대로 노출하므로, 코어에 있는 채널이 모두 그대로 쓸 수 있습니다. 두 기능 모두 v2 전용입니다.

기능 접근
카카오 브랜드메시지 (친구톡의 후속 채널) sendBrandMessage()
짧은 URL (단축 + 클릭 반응 분석) createShortUrl() / shortUrlStats()

브랜드메시지는 채널 친구가 아닌 수신자에게도 보낼 수 있고(targeting = N), 수신 동의한 전체 채널 친구에게 동보 발송할 수도 있습니다(targeting = F).

짧은 URL 은 메시지 본문의 링크를 줄이고 클릭 반응(일별 추이·디바이스·유입경로·국가)을 집계합니다.

사용 예시와 파라미터는 코어 README 와 SDK 가이드 를 참고하세요.

관리 API — 채널·템플릿·발신번호 등록 (v2 전용)

등록·심사 작업을 Server Action 으로 노출합니다. 서버에서만 호출하세요 — 관리 API 도 발송 API 와 같은 키를 쓰므로 브라우저에 노출되면 안 됩니다.

Server Action 하는 일
requestKakaoChannelCode(yellowId, phone) 1단계 — 관리자 휴대폰으로 인증번호 SMS 발송
registerKakaoChannel(params) 2단계 — 인증번호로 발신프로필 생성
listKakaoSenders() · syncKakaoSenders(key?) 발신프로필 목록 · 상태 동기화
createNoticeTemplate(params) 알림톡 템플릿 등록
requestNoticeTemplateInspection(code, comment?) 검수 요청
syncNoticeTemplate(code) 검수 결과 폴링
listNoticeTemplates(params?) 알림톡 템플릿 목록
createBrandTemplate(params) · listBrandTemplates(params?) 브랜드메시지 템플릿
senderNumberTypes() · validateSenderNumber(phone, type) 발신번호 유형 · 중복 확인
registerSender(params, files) 발신번호 등록 신청
listSenders() 발신번호 목록 (심사 상태 확인)
createMessageTemplate(params) · listMessageTemplates(params?) 문자 상용구 템플릿
uploadKakaoImage(type, file) · uploadKakaoImages(type, files) 카카오 이미지 업로드 — 템플릿용 URL 발급
listRejectedNumbers(params?) 수신거부(080) 번호 조회
subscribeWebhook(params) · getWebhook() · testWebhook() 이벤트 웹훅 구독

여기 없는 메서드(승인 취소, 휴면 해제, 템플릿 수정 등)는 createSendgoClient() 로 클라이언트를 받아 직접 부르세요.

sendgo.io 콘솔에 들어올 일이 없습니다. 휴대폰 발신번호는 PASS 대신 신분증 사본을 받아 sendgo 운영자가 대신 심사합니다. 사람이 개입하는 지점은 카카오 채널 인증번호 하나뿐이고, 그것도 여러분 화면에서 입력받으면 됩니다. 심사가 붙는 것들은 비동기라 웹훅으로 결과를 받으세요.

// app/onboarding/actions.ts
'use server';

import {
  requestKakaoChannelCode,
  registerKakaoChannel,
  createNoticeTemplate,
  requestNoticeTemplateInspection,
} from '@sendgo/react';

export async function startChannelRegistration(formData: FormData) {
  await requestKakaoChannelCode(
    String(formData.get('yellowId')),
    String(formData.get('phone')),
  );
}

export async function finishChannelRegistration(formData: FormData) {
  const created = await registerKakaoChannel({
    token: String(formData.get('code')),        // 사용자가 문자로 받은 인증번호
    yellowId: String(formData.get('yellowId')),
    phoneNumber: String(formData.get('phone')),
    categoryCode: '001001',
  });

  const kakaoSenderKey = created.data.sender.kakaoSenderKey;

  const template = await createNoticeTemplate({
    kakaoSenderKey,
    templateName: '주문 접수 안내',
    templateContent: '#{name}님, 주문 #{orderNo}이 접수되었습니다.',
    templateMessageType: 'BA',
    templateEmphasizeType: 'NONE',
    categoryCode: '001001',
    messagePurpose: 'order_delivery',
    legalBasis: 'transaction',
    benefitOrigin: 'none',
    expiryType: 'none',
    optInReviewConfirmed: true,
    ctaClearConfirmed: true,
    policyConfirmed: true,
  });

  await requestNoticeTemplateInspection(template.data.template.templateCode);
}

검수 결과는 즉시 오지 않습니다. Route Handler 나 크론에서 syncNoticeTemplate() 을 돌려 inspectionStatus 가 APR 이 되는지 확인하세요.


변경 사항

1.3.0 (2026-09-11)

  • 관리 API Server Action 추가 — 카카오 채널 등록(requestKakaoChannelCode, registerKakaoChannel), 알림톡 템플릿 등록·검수 요청·폴링 (createNoticeTemplate, requestNoticeTemplateInspection, syncNoticeTemplate), 브랜드메시지 템플릿, 발신번호 등록 신청(registerSender), 문자 상용구 템플릿.
  • 관리 API 요청 타입을 re-export 했습니다.
  • @sendgo/node 를 ^1.3.0 으로 올렸습니다.
  • 이벤트 웹훅 추가 — 발신번호 승인, 알림톡 검수 결과, 채널 차단, 브랜드메시지 타겟팅 결과를 구독해 받습니다. 서명은 받은 원본 바이트로 검증합니다(SDK 에 검증 헬퍼 포함).
  • 카카오 이미지 업로드 추가 — 브랜드메시지 템플릿의 imageUrl 은 카카오가 호스팅하는 URL 이어야 하는데, 그 URL 을 얻는 길이 콘솔에만 있었습니다.
  • 수신거부(080) 조회 추가 — 자기 DB 의 수신 상태를 맞출 수 있습니다.

1.2.1 (2026-08-14)

  • 레지스트리 목록에 노출되는 패키지 설명에서 친구톡을 브랜드메시지로 교체했습니다. npm/PyPI/Packagist/Maven/NuGet/RubyGems 검색 결과에 그대로 찍히는 문자열이라 종료된 채널을 계속 홍보하고 있었습니다.
  • 검색 키워드에 brand-message 를 추가했습니다 (friendtalk 은 유입 검색어라 유지).

1.2.0 (2026-08-14)

  • 친구톡 Deprecated 표기 — 친구톡은 카카오 정책에 따라 2025-12-31 종료되었고, 2026-01-01 부터 발송 요청이 브랜드메시지(자유형)로 자동 대체 발송됩니다. 관련 API 에 각 언어의 표준 deprecation 표기를 달았습니다.
  • 자유 본문 타입(FT/FI/FW)의 개별 발송 경로는 아직 친구톡 API 뿐이라는 점을 문서에 명시했습니다 — 브랜드메시지 API 는 그 조합에 NOT_A_BRAND_MESSAGE 를 반환합니다.
  • 브랜드메시지 전환 안내와 메시지 타입 1:1 대응표를 README 에 추가했습니다.

1.1.0 (2026-08-11)

  • 짧은 URL 서버 액션 추가 — createShortUrl / listShortUrls / getShortUrl / shortUrlStats / deactivateShortUrl

라이선스

MIT License © 2026 Sendgo


패키지 정보

API 키 발급 방법

샌드고에 로그인한 뒤 연동하기 → 연동 정보 메뉴에서 액세스 키와 시크릿 키를 발급받고, 같은 화면에서 호출을 허용할 IP 를 등록합니다 — 등록되지 않은 주소에서 온 요청은 거부됩니다. 알림톡·브랜드메시지를 사용하려면 발신프로필 관리 메뉴에서 발신프로필을 등록해 kakao_sender_key를 발급받고, 문자를 사용하려면 발신번호 관리 메뉴에서 발신번호를 등록해야 합니다.

이 패키지로 할 수 있는 것

관련 패키지

만드는 일에 집중하세요. 메시지는 샌드고가.맨 위로 ↑