sendgo / laravel
Sendgo Laravel SDK — 카카오 알림톡/브랜드메시지, SMS/LMS/MMS Laravel 통합
Requires
- php: >=8.2
- illuminate/support: ^10.0|^11.0|^12.0|^13.0
- sendgo/php: ^1.0
Requires (Dev)
- orchestra/testbench: ^8.0|^9.0
- phpunit/phpunit: ^11.0
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Laravel에서 카카오 알림톡, 브랜드메시지, SMS를 가장 쉽게 발송하는 공식 Laravel 패키지
sendgo/laravel은 sendgo/php 코어를 확장한 Laravel 전용 패키지입니다.
ServiceProvider 자동 등록, Facade, Config 게시 등 Laravel 통합을 완벽하게 제공합니다.
목차
- 설치
- 빠른 시작
- Facade 사용법
- 상세 사용법
- 서비스 클래스 패턴
- Notification Channel
- 관리 API
- Queue / Job 비동기 발송
- 예외 처리
- 설정 옵션
- 자주 묻는 질문
설치
composer require sendgo/laravel
Laravel의 패키지 자동 검색(Package Auto-Discovery)으로 ServiceProvider와 Facade가 자동 등록됩니다.
지원 버전은 Laravel 10 · 11 · 12 · 13 입니다.
빠른 시작
1단계 — 환경변수 설정 (.env)
SENDGO_ACCESS_KEY=your_access_key SENDGO_SECRET_KEY=your_secret_key SENDGO_KAKAO_SENDER_KEY=your_kakao_key SENDGO_SMS_SENDER_KEY=your_sms_key SENDGO_API_VERSION=v2
2단계 (선택) — 설정 파일 게시
php artisan vendor:publish --tag=sendgo-config
3단계 — 알림톡 전송
<?php use Sendgo\Php\Sendgo; class OrderController extends Controller { public function __construct(private Sendgo $sendgo) {} public function confirm(Order $order): JsonResponse { $this->sendgo->alimtalk->send([ 'templateCode' => 'ORDER_CONFIRM_001', 'contacts' => [ [ 'contact' => $order->user->phone, 'name' => $order->user->name, 'var1' => $order->number, 'var2' => number_format($order->total) . '원', ], ], ]); return response()->json(['success' => true]); } }
Facade 사용법
<?php use Sendgo\Laravel\Facades\Sendgo; // 알림톡 발송 Sendgo::alimtalk()->send([ 'templateCode' => 'ORDER_CONFIRM_001', 'contacts' => [['contact' => '01012345678', 'var1' => 'ORD-001']], ]); // SMS 발송 Sendgo::sms()->sendSms([ 'content' => '[인증] 인증번호: 123456', 'contacts' => [['contact' => '01012345678']], ]);
상세 사용법
알림톡
<?php use Sendgo\Php\Sendgo; // 다건 발송 app(Sendgo::class)->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원'], ], ]); // 예약 발송 app(Sendgo::class)->alimtalk->send([ 'templateCode' => 'PROMO_SUMMER_2026', 'scheduleType' => 'SCHEDULED', 'at' => '2026-07-28 09:00:00', 'contacts' => [['contact' => '01012345678', 'var1' => '여름 한정 50% 할인']], ]); // SMS 자동 대체 발송 app(Sendgo::class)->alimtalk->send([ 'templateCode' => 'DELIVERY_START_001', 'replaceSms' => 'Y', 'smsSubject' => '[배송 시작 안내]', 'smsContent' => "주문하신 상품이 출고되었습니다.\n송장번호: #{var2}", 'contacts' => [['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.
<?php // 텍스트형 app(Sendgo::class)->friendtalk->send([ 'content' => '안녕하세요! 7월 한정 특가 이벤트를 확인해보세요.', 'contacts' => [['contact' => '01012345678']], ]); // 이미지형 app(Sendgo::class)->friendtalk->send([ 'messageType' => 'FI', 'content' => '이번 주 특가 상품을 확인하세요!', 'imageUrl' => 'https://cdn.example.com/banner.jpg', 'imageLink' => 'https://example.com/event', 'contacts' => [['contact' => '01012345678']], ]); // 버튼 포함 app(Sendgo::class)->friendtalk->send([ 'content' => '7월 쿠폰이 도착했습니다! 지금 바로 사용하세요.', 'buttons' => [ ['name' => '쿠폰 받기', 'type' => 'WL', 'linkMo' => 'https://example.com/coupon'], ['name' => '고객센터', 'type' => 'WL', 'linkMo' => 'https://example.com/cs'], ], 'contacts' => [['contact' => '01012345678']], ]);
SMS / LMS / MMS
<?php // SMS (90자 이하) app(Sendgo::class)->sms->sendSms([ 'content' => '[Sendgo] 인증번호: 123456 (5분 이내 입력)', 'contacts' => [['contact' => '01012345678']], ]); // LMS (장문, 2,000자 이하) app(Sendgo::class)->sms->sendLms([ 'subject' => '[중요] 서비스 점검 안내', 'content' => "안녕하세요. 서비스 점검이 예정되어 있습니다.\n\n■ 일시: 2026-07-25 02:00 ~ 06:00\n■ 영향: 전체 서비스", 'contacts' => [['contact' => '01012345678']], ]); // MMS (이미지 포함) app(Sendgo::class)->sms->sendMms([ 'subject' => '[이벤트] 7월 특가', 'content' => '이번 달 특가 상품을 확인하세요!', 'contacts' => [['contact' => '01011111111'], ['contact' => '01022222222']], ]);
서비스 클래스 패턴
<?php // app/Services/NotificationService.php namespace App\Services; use Sendgo\Php\Sendgo; use Sendgo\Php\Exception\SendgoException; use Illuminate\Support\Facades\Log; class NotificationService { public function __construct(private Sendgo $sendgo) {} public function sendOrderConfirm(string $phone, string $orderNo, int $amount): void { $this->sendgo->alimtalk->send([ 'templateCode' => 'ORDER_CONFIRM_001', 'contacts' => [ ['contact' => $phone, 'var1' => $orderNo, 'var2' => number_format($amount) . '원'], ], ]); } public function sendShippingAlert(string $phone, string $trackingNo): void { $this->sendgo->alimtalk->send([ 'templateCode' => 'SHIPPING_001', 'replaceSms' => 'Y', 'smsContent' => "배송이 시작되었습니다.\n송장번호: {$trackingNo}", 'contacts' => [['contact' => $phone, 'var1' => $trackingNo]], ]); } public function sendVerificationCode(string $phone, string $code): void { try { // 알림톡 우선, 실패 시 SMS 대체 $this->sendgo->alimtalk->send([ 'templateCode' => 'VERIFY_CODE_001', 'replaceSms' => 'Y', 'smsContent' => "[인증] 인증번호: {$code} (5분 이내 입력)", 'contacts' => [['contact' => $phone, 'var1' => $code]], ]); } catch (SendgoException $e) { Log::error('Sendgo 인증번호 발송 실패', [ 'phone' => $phone, 'error_code' => $e->getErrorCode(), 'status' => $e->getStatusCode(), ]); throw $e; } } }
<?php // app/Providers/AppServiceProvider.php use App\Services\NotificationService; use Sendgo\Php\Sendgo; // ServiceProvider에 이미 Singleton으로 등록되어 있어 자동 주입 가능 $this->app->bind(NotificationService::class, function ($app) { return new NotificationService($app->make(Sendgo::class)); });
Notification Channel
ServiceProvider 가 알림 채널 세 개를 등록합니다. 별도 설정 없이 via() 에
채널 이름을 넣고, 같은 이름의 to...() 메서드에서 SDK 페이로드를 그대로
반환하면 됩니다.
via() 이름 |
알림 객체 메서드 | 발송 채널 |
|---|---|---|
sendgo_alimtalk |
toSendgoAlimtalk() |
카카오 알림톡 |
sendgo_sms |
toSendgoSms() |
SMS / LMS / MMS |
sendgo_brand_message |
toSendgoBrandMessage() |
카카오 브랜드메시지 (v2 전용) |
to...() 가 없거나 빈 배열을 반환하면 그 채널로는 발송하지 않습니다. 조건부로
건너뛰고 싶을 때 쓰세요.
<?php // app/Notifications/OrderConfirmedNotification.php namespace App\Notifications; use Illuminate\Notifications\Notification; use Sendgo\Php\Sendgo; class OrderConfirmedNotification extends Notification { public function __construct(private string $orderNo, private int $amount) {} public function via(object $notifiable): array { return ['sendgo_alimtalk']; } public function toSendgoAlimtalk(object $notifiable): array { return [ 'templateCode' => 'ORDER_CONFIRM_001', 'contacts' => [ [ 'contact' => $notifiable->phone, 'var1' => $this->orderNo, 'var2' => number_format($this->amount) . '원', ], ], ]; } }
Queue / Job 비동기 발송
<?php // app/Jobs/SendAlimtalkJob.php namespace App\Jobs; use Illuminate\Bus\Queueable; use Illuminate\Contracts\Queue\ShouldQueue; use Illuminate\Foundation\Bus\Dispatchable; use Illuminate\Queue\InteractsWithQueue; use Illuminate\Queue\SerializesModels; use Sendgo\Php\Sendgo; use Sendgo\Php\Exception\SendgoException; use Illuminate\Support\Facades\Log; class SendAlimtalkJob implements ShouldQueue { use Dispatchable, InteractsWithQueue, Queueable, SerializesModels; public int $tries = 3; public int $backoff = 10; public function __construct( private string $templateCode, private array $contacts, ) {} public function handle(Sendgo $sendgo): void { $sendgo->alimtalk->send([ 'templateCode' => $this->templateCode, 'contacts' => $this->contacts, ]); } public function failed(SendgoException $e): void { Log::error('알림톡 발송 실패', [ 'templateCode' => $this->templateCode, 'error_code' => $e->getErrorCode(), ]); } } // 디스패치 예시 SendAlimtalkJob::dispatch('ORDER_CONFIRM_001', [ ['contact' => '01012345678', 'var1' => 'ORD-001'], ])->onQueue('notifications');
예외 처리
<?php use Sendgo\Php\Exception\SendgoException; try { app(Sendgo::class)->alimtalk->send([...]); } catch (SendgoException $e) { Log::error('Sendgo 발송 실패', [ 'status' => $e->getStatusCode(), 'error_code' => $e->getErrorCode(), 'endpoint' => $e->getEndpoint(), ]); match ($e->getErrorCode()) { 'INVALID_ACCESS_KEY', 'INVALID_SECRET_KEY' => alertOps('Sendgo 인증키 오류'), 'INVALID_TEMPLATE_CODE' => logger()->warning('존재하지 않는 템플릿'), 'PAYMENT_REQUIRED' => alertOps('Sendgo 크레딧 부족'), 'IP_NOT_ALLOWED' => alertOps('허용되지 않은 IP'), default => null, }; }
설정 옵션
config/sendgo.php (vendor:publish 후 커스터마이징 가능):
| 키 | 환경변수 | 기본값 | 설명 |
|---|---|---|---|
access_key |
SENDGO_ACCESS_KEY |
— | Sendgo 액세스 키 |
secret_key |
SENDGO_SECRET_KEY |
— | Sendgo 시크릿 키 |
kakao_sender_key |
SENDGO_KAKAO_SENDER_KEY |
null |
카카오 발신프로필 키 |
sms_sender_key |
SENDGO_SMS_SENDER_KEY |
null |
SMS 발신자 키 |
api_version |
SENDGO_API_VERSION |
'v2' |
API 버전 |
url |
SENDGO_URL |
'https://sendgo.io' |
API 기본 URL |
자주 묻는 질문 (FAQ)
Q. sendgo/php와의 차이는 무엇인가요?
A. sendgo/php는 프레임워크 독립적인 순수 PHP 코어 패키지입니다. sendgo/laravel은 이를 확장해 ServiceProvider 자동 등록, Facade, .env 설정 바인딩 등 Laravel 통합을 추가합니다.
Q. Laravel 10, 11, 12 모두 지원하나요?
A. 네, illuminate/support ^10.0|^11.0|^12.0을 지원합니다.
Q. Facade를 사용하지 않고 DI로만 쓸 수 있나요?
A. 네, Sendgo\Php\Sendgo를 생성자에서 타입힌트로 주입받아 사용할 수 있습니다.
Q. 테스트 시 Sendgo를 Mock 처리하려면?
A. Sendgo\Php\Sendgo를 Mockery나 PHPUnit Mock으로 교체하면 됩니다.
관련 패키지
| 언어/프레임워크 | 패키지 | GitHub |
|---|---|---|
| PHP (순수) | sendgo/php |
php |
| Spring Boot | io.sendgo:sendgo-spring |
spring |
| Node.js | @sendgo/node |
node |
| Python | sendgo-python |
python |
| 전체 목록 | — | send-go GitHub 조직 |
브랜드메시지 · 짧은 URL
이 패키지는 코어(sendgo/php)의 클라이언트를 그대로 노출하므로, 코어에 있는 채널이
모두 그대로 쓸 수 있습니다. 두 기능 모두 v2 전용입니다.
| 기능 | 접근 |
|---|---|
| 카카오 브랜드메시지 (친구톡의 후속 채널) | Sendgo::brandMessage() |
| 짧은 URL (단축 + 클릭 반응 분석) | Sendgo::shortUrl() |
브랜드메시지는 채널 친구가 아닌 수신자에게도 보낼 수 있고(targeting = N),
수신 동의한 전체 채널 친구에게 동보 발송할 수도 있습니다(targeting = F).
짧은 URL 은 메시지 본문의 링크를 줄이고 클릭 반응(일별 추이·디바이스·유입경로·국가)을 집계합니다.
사용 예시와 파라미터는 코어 README 와 SDK 가이드 를 참고하세요.
관리 API — 채널·템플릿·발신번호 등록 (v2 전용)
콘솔에서만 되던 등록·심사를 파사드로 처리합니다. 코어(sendgo/php)의 서비스를
그대로 노출하므로 파라미터는 코어와 같습니다.
| 파사드 | 하는 일 | 계정 |
|---|---|---|
Sendgo::kakaoSenders() |
카카오 채널 인증·등록·동기화, 브랜드메시지 M/N 신청 | 기업 |
Sendgo::noticeTemplates() |
알림톡 템플릿 CRUD, 검수 요청·취소, 승인 취소, 휴면 해제 | 기업 |
Sendgo::brandTemplates() |
브랜드메시지 템플릿 CRUD, 동기화, 가져오기 | 기업 |
Sendgo::senderRegistration() |
발신번호 등록 신청, 중복 확인, 유형 안내 | 개인·기업 |
Sendgo::messageTemplates() |
문자 상용구 템플릿 CRUD | 개인·기업 |
Sendgo::kakaoImages() |
카카오 이미지 업로드 — 템플릿용 URL 발급 | 기업 |
Sendgo::rejectedNumbers() |
수신거부(080) 번호 조회 | 개인·기업 |
Sendgo::webhook() |
이벤트 웹훅 구독 — 심사 결과 수신 | 개인·기업 |
sendgo.io 콘솔에 들어올 일이 없습니다. 휴대폰 발신번호는 PASS 대신 신분증 사본을 받아 sendgo 운영자가 대신 심사합니다. 사람이 개입하는 지점은 카카오 채널 인증번호 하나뿐이고, 그것도 여러분 화면에서 입력받으면 됩니다. 심사가 붙는 것들은 비동기라 웹훅으로 결과를 받으세요.
use Sendgo\Laravel\Facades\Sendgo; // 카카오 채널 — 2단계 Sendgo::kakaoSenders()->requestToken('@my-channel', '01012345678'); $created = Sendgo::kakaoSenders()->create([ 'token' => $request->input('code'), // 사용자가 문자로 받은 인증번호 'yellowId' => '@my-channel', 'phoneNumber' => '01012345678', 'categoryCode' => '001001', ]); // 알림톡 템플릿 등록 → 검수 요청 → 폴링 $template = Sendgo::noticeTemplates()->create([ 'kakaoSenderKey' => $created['data']['sender']['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, ]); $code = $template['data']['template']['templateCode']; Sendgo::noticeTemplates()->requestInspection($code); // 승인 확인은 스케줄러에서 — 배포 파이프라인 안에서 기다리지 마세요 $status = Sendgo::noticeTemplates()->sync($code)['data']['template']['inspectionStatus']; // 발신번호 등록 신청 (서류 첨부) Sendgo::senderRegistration()->create( [ 'senderAlias' => '고객센터 대표번호', 'senderNumberType' => 'team_main', 'phoneE164' => '02-1234-5678', ], ['csuCertificate' => $request->file('csu')->getRealPath()], );
스케줄러로 승인 여부를 확인하는 패턴:
// routes/console.php Schedule::call(function () { foreach (PendingTemplate::whereNull('approved_at')->get() as $pending) { $result = Sendgo::noticeTemplates()->sync($pending->template_code); $status = $result['data']['template']['inspectionStatus']; if ($status === 'APR') { $pending->update(['approved_at' => now()]); } elseif ($status === 'REJ') { $pending->update(['rejected_reason' => json_encode($result['data']['template']['comments'])]); } } })->everyThirtyMinutes();
전체 파라미터와 오류 코드는 코어 README 와 API 문서 를 참고하세요.
변경 사항
1.3.0 (2026-09-11)
- 관리 API 파사드 노출 —
Sendgo::kakaoSenders(),Sendgo::noticeTemplates(),Sendgo::brandTemplates(),Sendgo::senderRegistration(),Sendgo::messageTemplates(). 콘솔에서만 되던 등록·심사를 코드로 처리합니다. - 알림 채널을 실제로 등록했습니다. README 는 처음부터
via: ['sendgo_alimtalk']예시를 실었지만 채널 등록이 없어 문서대로 따라 하면Driver [sendgo_alimtalk] not supported.로 죽었습니다. 이제sendgo_alimtalk·sendgo_sms·sendgo_brand_message세 채널이 동작합니다. - Laravel 13 지원 —
illuminate/support제약에^13.0을 더했습니다. 이전에는 Laravel 13 앱에서 설치 자체가 되지 않아 코어를 직접 바인딩해야 했습니다. - 이벤트 웹훅 추가 — 발신번호 승인, 알림톡 검수 결과, 채널 차단, 브랜드메시지 타겟팅 결과를 구독해 받습니다. 서명은 받은 원본 바이트로 검증합니다(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)
- 파사드에
shortUrl()문서화 (@method주석) — IDE 자동완성 대응
라이선스
MIT License © 2026 Sendgo
키워드: 카카오 알림톡 Laravel, 카카오 친구톡 Laravel, SMS 발송 Laravel, 알림톡 Laravel 패키지, Laravel 카카오 API 연동, Laravel Notification Channel, Sendgo Laravel SDK