Flutter / Dart SDK 가이드

Flutter / Dart 서버에서 카카오 알림톡, 브랜드메시지, SMS를 발송하는 공식 Dart SDK

중요: 이 패키지는 서버사이드 전용입니다 (Dart 백엔드, Shelf, Serverpod 등). API 키가 클라이언트(Flutter 앱)에 노출되지 않도록 반드시 서버에서만 사용하세요.

---

설치

# pubspec.yaml
dependencies:
  sendgo_flutter: ^1.1.0

dart pub get

---

빠른 시작

import 'package:sendgo_flutter/sendgo_flutter.dart';

void main() async {
  final client = SendgoClient(
    accessKey:      Platform.environment['SENDGO_ACCESS_KEY']!,
    secretKey:      Platform.environment['SENDGO_SECRET_KEY']!,
    kakaoSenderKey: Platform.environment['SENDGO_KAKAO_SENDER_KEY'],
    smsSenderKey:   Platform.environment['SENDGO_SMS_SENDER_KEY'],
    apiVersion:     'v2',
  );

  // 알림톡 발송
  await client.alimtalk.send(
    templateCode: 'ORDER_CONFIRM_001',
    contacts: [
      Contact(contact: '01012345678', name: '홍길동', var1: 'ORD-001', var2: '29,000원'),
    ],
  );
}

---

알림톡 상세 사용법

import 'package:sendgo_flutter/sendgo_flutter.dart';

final client = SendgoClient(
  accessKey: Platform.environment['SENDGO_ACCESS_KEY']!,
  secretKey: Platform.environment['SENDGO_SECRET_KEY']!,
  kakaoSenderKey: Platform.environment['SENDGO_KAKAO_SENDER_KEY'],
  smsSenderKey:   Platform.environment['SENDGO_SMS_SENDER_KEY'],
  apiVersion: 'v2',
);

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

// 예약 발송
await client.alimtalk.send(
  templateCode: 'PROMO_SUMMER_2026',
  scheduleType: 'SCHEDULED',
  at:           '2026-07-28 09:00:00',
  contacts: [Contact(contact: '01012345678', var1: '여름 한정 50% 할인')],
);

// SMS 자동 대체 발송
await client.alimtalk.send(
  templateCode: 'DELIVERY_START_001',
  replaceSms:   'Y',
  smsSubject:   '[배송 시작 안내]',
  smsContent:   '주문하신 상품이 출고되었습니다.\n송장번호: #{var2}',
  contacts: [Contact(contact: '01012345678', var1: 'ORD-001', var2: '1234567890')],
);

---

친구톡 사용법

⚠️ Deprecated — 친구톡은 카카오 정책에 따라 2025-12-31 종료되었습니다. 2026-01-01 부터 친구톡 발송 요청은 카카오 측에서 브랜드메시지(자유형) 로 자동 대체 발송됩니다. 호출은 계속 성공하며, 자유 본문 타입(FT/FI/FW)을 개별 수신자에게 보내는 경로는 현재 이것뿐이므로 기존 코드를 당장 바꿀 필요는 없습니다.

다음의 경우에는 브랜드메시지를 사용하세요.

• 템플릿 기반 리치 타입 (FL/FC/FM/FP/FA)
• 채널 친구가 아닌 수신자 (targeting = N / I)
• 수신 동의한 전체 채널 친구 동보 (targeting = F)

메시지 타입은 1:1 대응되며 변환은 서버가 처리합니다 — FT→BT, FI→BI, FW→BW, FL→BL, FC→BC, FM→BM, FP→BP, FA→BA.

// 텍스트형
await client.friendtalk.send(
  content:  '안녕하세요! 7월 한정 특가 이벤트를 확인해보세요.',
  contacts: [Contact(contact: '01012345678')],
);

// 이미지형
await client.friendtalk.send(
  messageType: 'FI',
  content:     '이번 주 특가 상품을 확인하세요!',
  imageUrl:    'https://cdn.example.com/banner.jpg',
  imageLink:   'https://example.com/event',
  contacts:    [Contact(contact: '01012345678')],
);

---

브랜드메시지 사용법

브랜드메시지는 친구톡의 후속 채널입니다. 메시지 타입이 친구톡과 1:1 대응되며 (FT→BT, FI→BI, FW→BW, FL→BL, FC→BC, FM→BM, FP→BP, FA→BA), 요청에는 친구톡 코드를 그대로 넘기고 변환은 서버가 처리합니다.

친구톡과 달리 다음이 가능합니다.

• 채널 친구가 아닌 수신자에게 발송 (targeting: N)
• 수신 동의한 전체 채널 친구 동보 발송 (targeting: F, 수신자 목록 불필요)
• 리스트·캐러셀·커머스·동영상 등 템플릿 기반 리치 메시지

v2 전용입니다. 자유 본문 타입(FT/FI/FW)을 개별 수신자에게 보낼 때는 여전히 친구톡 API 를 쓰세요 — 이 엔드포인트는 그 조합에 NOT_A_BRAND_MESSAGE 를 반환합니다. 친구톡 요청은 카카오 측에서 브랜드메시지(자유형)로 대체 발송됩니다.

// 단건 발송 — 채널 친구 대상
await client.brandMessage.send(BrandMessageRequest(
  targeting: 'M',
  messageType: 'FL',
  friendTemplateUuid: '9cd5460b-6458-4edc-9b11-c26d3013c340',
  contacts: [Contact(contact: '01012345678', var1: '29,000원')],
));

// 동보 발송 — 수신 동의한 전체 채널 친구 (contacts 불필요)
await client.brandMessage.broadcast(BrandMessageRequest(
  messageType: 'FW',
  friendTemplateUuid: '9cd5460b-6458-4edc-9b11-c26d3013c340',
));

// 캠페인 조회
final list = await client.brandMessage.campaigns(count: 10);
final one  = await client.brandMessage.campaign('1f0a6d0e-6b3b-4f0f-9b2f-2f6f6a1b7c11');

---

SMS / LMS / MMS 사용법

// SMS
await client.sms.sendSms(
  content:  '[Sendgo] 인증번호: 123456 (5분 이내 입력)',
  contacts: [Contact(contact: '01012345678')],
);

// LMS
await client.sms.sendLms(
  subject:  '[중요] 서비스 점검 안내',
  content:  '안녕하세요. 서비스 점검이 예정되어 있습니다.\n■ 일시: 2026-07-25 02:00 ~ 06:00',
  contacts: [Contact(contact: '01012345678')],
);

// MMS
await client.sms.sendMms(
  subject:  '[이벤트] 7월 특가',
  content:  '이번 달 특가 상품을 확인하세요!',
  contacts: [
    Contact(contact: '01011111111'),
    Contact(contact: '01022222222'),
  ],
);

---

Shelf 서버 통합

// bin/server.dart
import 'dart:convert';
import 'dart:io';
import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart' as io;
import 'package:sendgo_flutter/sendgo_flutter.dart';

final sendgo = SendgoClient(
  accessKey:      Platform.environment['SENDGO_ACCESS_KEY']!,
  secretKey:      Platform.environment['SENDGO_SECRET_KEY']!,
  kakaoSenderKey: Platform.environment['SENDGO_KAKAO_SENDER_KEY'],
  apiVersion:     'v2',
);

Response handler(Request request) async {
  if (request.url.path == 'api/notify/order' && request.method == 'POST') {
    final body = jsonDecode(await request.readAsString());
    await sendgo.alimtalk.send(
      templateCode: 'ORDER_CONFIRM_001',
      contacts: [Contact(contact: body['phone'], var1: body['orderNo'])],
    );
    return Response.ok(jsonEncode({'success': true}),
        headers: {'content-type': 'application/json'});
  }
  return Response.notFound('Not found');
}

void main() async {
  final server = await io.serve(handler, InternetAddress.anyIPv4, 8080);
  print('서버 시작: ${server.port}');
}

---

예외 처리

import 'package:sendgo_flutter/sendgo_flutter.dart';

try {
  await client.alimtalk.send(
    templateCode: 'ORDER_CONFIRM_001',
    contacts: [Contact(contact: '01012345678')],
  );
} on SendgoException catch (e) {
  print('발송 실패: HTTP ${e.statusCode} [${e.errorCode}]');

  switch (e.errorCode) {
    case 'INVALID_ACCESS_KEY':
    case 'INVALID_SECRET_KEY':
      alertOps('Sendgo 인증키를 확인하세요.');
    case 'INVALID_TEMPLATE_CODE':
      logger.warn('존재하지 않는 템플릿: ${e.message}');
    case 'PAYMENT_REQUIRED':
      alertOps('Sendgo 크레딧이 부족합니다.');
    case 'IP_NOT_ALLOWED':
      alertOps('허용되지 않은 IP');
  }
}

---

설정 옵션

파라미터	타입	필수	기본값	설명
accessKey	String	필수	—	Sendgo 액세스 키
secretKey	String	필수	—	Sendgo 시크릿 키
kakaoSenderKey	String?	선택	null	카카오 발신프로필 키
smsSenderKey	String?	선택	null	SMS 발신자 키
apiVersion	String	선택	'v2'	API 버전 (v1 | v2)
baseUrl	String	선택	'https://sendgo.io'	API 기본 URL

---

짧은 URL

짧은 URL 은 메시지 본문의 링크를 줄이고, 그 링크가 실제로 눌렸는지 집계합니다. 문자는 바이트 수가 요금과 직결되므로 링크를 줄이면 그만큼 본문을 더 쓸 수 있습니다.

같은 원본 URL 을 다시 줄이면 기존 링크가 그대로 반환됩니다. 캠페인별로 반응을 따로 집계하려면 forceNew 로 새 코드를 만드세요.

deactivate 는 링크를 삭제하지 않고 리다이렉트만 중지합니다. 이미 발송한 메시지의 링크를 무효화할 때 쓰며, 누적 통계는 남고 이후 접속은 410 Gone 이 됩니다.

// 짧은 URL 생성 (v2 전용)
final created = await sendgo.shortUrl.create(const ShortUrlRequest(
  targetUrl: 'https://example.com/promotions/summer-sale',
  title: '여름 세일 랜딩',
));

final code = created['data']['code'] as String;

// 반응 통계 — 일별 추이 + 디바이스/유입경로/국가별 분해
final stats = await sendgo.shortUrl.stats(code, from: '2026-08-01');

await sendgo.shortUrl.list(count: 10);
await sendgo.shortUrl.show(code);
await sendgo.shortUrl.deactivate(code);   // 리다이렉트만 중지, 통계는 남는다

stats 는 일별 추이(daily)와 디바이스(byDevice)·유입경로(byReferer)·국가(byCountry)별 분해를 반환합니다. 일별 추이는 사전 집계 표에서 읽으므로 클릭이 많아도 응답 시간이 일정합니다.

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

발송은 처음부터 API였지만 등록과 심사는 콘솔에서만 되던 것들이 있었습니다. 1.3.0 부터 그 작업도 코드로 처리합니다.

서비스	하는 일	계정
client.kakaoSenders	카카오 채널 인증·등록·동기화, 브랜드메시지 M/N 신청	기업
client.noticeTemplates	알림톡 템플릿 CRUD, 검수 요청·취소, 승인 취소, 휴면 해제	기업
client.brandTemplates	브랜드메시지(구 친구톡) 템플릿 CRUD, 동기화, 가져오기	기업
client.senderRegistration	발신번호 등록 신청, 중복 확인, 유형 안내	개인·기업
client.messageTemplates	문자 상용구 템플릿 CRUD	개인·기업
client.kakaoImages	카카오 이미지 업로드 — 템플릿용 URL 발급	기업
client.rejectedNumbers	수신거부(080) 번호 조회	개인·기업
client.webhook	이벤트 웹훅 구독 — 심사 결과 수신	개인·기업

관리 API 도 발송 API 와 같은 키를 씁니다. 앱에 키를 넣지 마세요 — Cloud Functions 나 Dart 서버에서만 호출합니다.

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

카카오 채널 등록

// 1단계 — 카카오가 관리자 휴대폰으로 인증번호를 SMS 발송한다 (응답에 번호는 없다)
await client.kakaoSenders.requestToken('@my-channel', '01012345678');

// 2단계 — 사람이 받은 인증번호로 발신프로필 생성
final created = await client.kakaoSenders.create(const KakaoSenderCreateRequest(
  token: '123456',
  yellowId: '@my-channel',
  phoneNumber: '01012345678',
  categoryCode: '001001',   // categories() 로 조회
));

final kakaoSenderKey = created['data']['sender']['kakaoSenderKey'] as String;

await client.kakaoSenders.categories();
await client.kakaoSenders.list();
await client.kakaoSenders.sync();                 // 전체 상태 동기화 (하루 한 번 권장)
await client.kakaoSenders.sync(kakaoSenderKey);   // 단건

알림톡 템플릿 등록과 검수

final created = await client.noticeTemplates.create(NoticeTemplateRequest(
  kakaoSenderKey: kakaoSenderKey,
  templateName: '주문 접수 안내',
  templateContent: '#{name}님, 주문 #{orderNo}이 접수되었습니다.',
  templateMessageType: 'BA',       // BA 기본형 / EX 부가정보형 / AD 채널추가형 / MI 복합형
  templateEmphasizeType: 'NONE',   // NONE / TEXT / ITEM_LIST / IMAGE
  categoryCode: '001001',

  // sendgo 자체 정책 게이트 — 카카오 심사와 별개다
  messagePurpose: 'order_delivery',
  legalBasis: 'transaction',
  benefitOrigin: 'none',
  expiryType: 'none',
));

final templateCode = created['data']['template']['templateCode'] as String;

// 검수 요청 — 증빙이 필요하면 파일도 붙인다 (첨부가 있으면 comment 필수)
await client.noticeTemplates.requestInspection(templateCode);

// 결과는 비동기다. 웹훅이 없으므로 폴링한다
final synced = await client.noticeTemplates.sync(templateCode);
synced['data']['template']['inspectionStatus'];   // REG → REQ → APR / REJ

optInReviewConfirmed · ctaClearConfirmed · policyConfirmed 는 기본값이 true 지만, 내용을 실제로 검토한 뒤에 그대로 두어야 합니다 — 이 값은 법적 확인의 기록입니다.

정책 필드 조합이 본문과 어긋나면 저장 단계에서 POLICY_VALIDATION_FAILED 로 막힙니다. 여기서 걸리는 문안은 카카오 심사에서도 거의 반려되므로, 며칠 기다렸다 반려당하는 것보다 즉시 아는 편이 낫습니다.

await client.noticeTemplates.list(kakaoSenderKey: kakaoSenderKey, inspectionStatus: 'APR');
await client.noticeTemplates.show(templateCode);
await client.noticeTemplates.update(templateCode, request);   // 본문이 바뀌면 재검수 필요
await client.noticeTemplates.cancelInspection(templateCode);
await client.noticeTemplates.cancelApproval(templateCode);
await client.noticeTemplates.release(templateCode);           // 휴면 해제
await client.noticeTemplates.delete(templateCode);            // sendgo 목록에서만 삭제된다
await client.noticeTemplates.categories();

이미지 템플릿과 검수 첨부는 multipart 로 나갑니다.

final image = SendgoMultipartFile(
  fieldName: 'image',
  fileName: 'banner.jpg',
  bytes: await File('banner.jpg').readAsBytes(),
);

await client.noticeTemplates.createWithImage(request, image);
await client.noticeTemplates.requestInspection(
  templateCode,
  comment: '주문 확인 화면 첨부',
  attachments: [image],
);

삭제 동작이 채널마다 다릅니다. 알림톡 템플릿은 카카오에 삭제 API 가 없어 sendgo 목록에서만 빠지고 동기화하면 되살아납니다. 브랜드메시지 템플릿은 카카오 쪽에서도 실제로 삭제됩니다.

브랜드메시지 템플릿

final created = await client.brandTemplates.create(const BrandTemplateRequest(
  kakaoSenderKey: 'sender-key',
  templateName: '여름 세일 안내',
  templateType: 'FI',   // FT/FI/FW/FL/FC/FM/FP/FA — 서버가 chatBubbleType 으로 변환
  templateContent: '여름 세일이 시작되었습니다.',
  imageUrl: 'https://mud-kage.kakao.com/....jpg',
));

// 동보 발송(targeting='F')에는 변수가 없는 템플릿만 쓸 수 있다
created['data']['template']['containsVariables'];

await client.brandTemplates.list(kakaoSenderKey: kakaoSenderKey);
await client.brandTemplates.sync(templateCode);
await client.brandTemplates.import(kakaoSenderKey);   // 카카오에 있는 템플릿 가져오기
await client.brandTemplates.delete(templateCode);     // 카카오에서도 삭제된다

발신번호 등록 신청

// 계정 종류에 맞는 유형과 유형별 필수 서류
await client.senderRegistration.numberTypes();

// 형식·중복 미리 확인
final check = await client.senderRegistration.validate('02-1234-5678', 'team_main');

final created = await client.senderRegistration.create(
  const SenderRegistrationRequest(
    senderAlias: '고객센터 대표번호',
    senderNumberType: 'team_main',   // personal_other / team_main / team_other_company
    phoneE164: '02-1234-5678',
  ),
  [
    SendgoMultipartFile(
      fieldName: 'csuCertificate',
      fileName: 'csu.pdf',
      bytes: await File('csu.pdf').readAsBytes(),
    ),
  ],
);

created['data']['sender']['status'];   // PENDING — 운영자 승인 후 SUCCESS

await client.senderRegistration.list();
await client.senderRegistration.update(senderKey, senderAlias: '새 이름');
await client.senderRegistration.delete(senderKey);

휴대폰 유형도 API 로 접수할 수 있습니다. 콘솔의 PASS 본인인증 대신 신분증 사본(identityDocument)을 첨부하면 sendgo 운영자가 직접 확인합니다. 이 경로로 접수된 건은 응답의 identityVerificationMethod 가 document 이고 자동 승인되지 않습니다 — 운영자 확인 전까지 PENDING 입니다.

유형별 필수 서류는 numberTypes() 응답의 requiredDocuments 로 확인하세요. 반려되면 rejectionReason 에 사유가 담깁니다.

문자 템플릿

await client.messageTemplates.create(const MessageTemplateRequest(
  messageTranType: 'LMS',
  messageTranSubject: '주문 안내',   // LMS·MMS 는 필수
  messageTranMsg: '주문이 접수되었습니다.',
));

await client.messageTemplates.list(messageType: 'LMS');
await client.messageTemplates.update(templateKey, request);
await client.messageTemplates.delete(templateKey);

이벤트 웹훅 — 심사 결과를 밀어 받기

final created = await client.webhook.subscribe(
  'https://reseller.example.com/hooks/sendgo',
);

// 시크릿은 이 응답에서 한 번만 나온다. 즉시 저장한다.
final secret = created['data']['secret'] as String?;

await client.webhook.show();          // 구독 설정 + 마지막 전송 결과
await client.webhook.test();          // 배선 확인
await client.webhook.unsubscribe();

받는 쪽(Dart 서버 / Cloud Functions)에서는 원본 바이트로 서명을 검증합니다.

final raw = await utf8.decoder.bind(request).join();

if (!WebhookService.verifySignature(
      utf8.encode(raw),
      request.headers.value('X-Sendgo-Signature') ?? '',
      secret,
    )) {
  request.response.statusCode = 401;
  await request.response.close();
  return;
}

final payload = jsonDecode(raw) as Map<String, dynamic>;
// payload['event'] — sender.status_changed / notice_template.inspection_status_changed / ...

이벤트 목록은 WebhookEvents.all 로 확인할 수 있습니다.

카카오 이미지 업로드

브랜드메시지 템플릿의 imageUrl 은 카카오가 호스팅하는 URL 이어야 합니다.

final uploaded = await client.kakaoImages.upload(
  'default',
  SendgoMultipartFile(
    fieldName: 'image',
    fileName: 'banner.jpg',
    bytes: await File('banner.jpg').readAsBytes(),
  ),
);

await client.kakaoImages.uploadMany('carousel_feed', slides);
await client.kakaoImages.types();   // 유형별 필드·최대 개수

수신거부(080) 동기화

// 증분만 가져간다. 하루 한 번이면 충분하다.
await client.rejectedNumbers.list(since: '2026-09-01', count: 500);

---

변경 사항

1.3.0 (2026-09-11)

• 관리 API 추가 — 콘솔에서만 되던 등록·심사를 코드로 처리합니다. client.kakaoSenders(채널 인증·등록·동기화, 브랜드메시지 M/N 신청), client.noticeTemplates(알림톡 템플릿 CRUD·검수 요청·승인 취소·휴면 해제), client.brandTemplates(브랜드메시지 템플릿 CRUD·동기화·가져오기), client.senderRegistration(발신번호 등록 신청·중복 확인·유형 안내), client.messageTemplates(문자 상용구 템플릿 CRUD).
• SendgoHttpClient 에 put·patch·postMultipart 를 추가했습니다. 서류 첨부와 이미지 템플릿은 JSON 으로 보낼 수 없습니다.
• 요청 모델과 첨부용 SendgoMultipartFile 을 추가했습니다.
• 휴대폰 발신번호도 API 로 접수됩니다. 콘솔의 PASS 본인인증 대신 identityDocument(신분증 사본)를 첨부하면 sendgo 운영자가 확인합니다. 이 경로는 자동 승인되지 않고 항상 PENDING 으로 시작합니다.
• 이벤트 웹훅 추가 — 발신번호 승인, 알림톡 검수 결과, 채널 차단, 브랜드메시지 타겟팅 결과를 구독해 받습니다. 서명은 받은 원본 바이트로 검증합니다(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 에 추가했습니다.

라이선스

MIT License © 2026 Sendgo

---

패키지 정보

• 패키지: sendgo_flutter (pub.dev)
• 저장소: send-go/flutter
• 레지스트리: https://pub.dev/packages/sendgo_flutter
• 라이선스: MIT

API 키 발급 방법

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