sendgo-python 1.0.1__tar.gz → 1.2.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sendgo-python
3
- Version: 1.0.1
3
+ Version: 1.2.0
4
4
  Summary: Sendgo Python SDK — 카카오 알림톡/친구톡, SMS/LMS/MMS
5
5
  Author-email: Sendgo <dev@sendgo.io>
6
6
  License: MIT
@@ -27,7 +27,7 @@ Requires-Dist: httpx>=0.27; extra == "async"
27
27
 
28
28
  # sendgo-python
29
29
 
30
- > **Python / Django / FastAPI에서 카카오 알림톡, 친구톡, SMS를 가장 쉽게 발송하는 SDK**
30
+ > **Python / Django / FastAPI에서 카카오 알림톡, 브랜드메시지, SMS를 가장 쉽게 발송하는 SDK**
31
31
 
32
32
  [![PyPI version](https://img.shields.io/pypi/v/sendgo-python?logo=pypi)](https://pypi.org/project/sendgo-python/)
33
33
  [![Python](https://img.shields.io/badge/Python-3.10%2B-3776AB?logo=python)](https://python.org)
@@ -184,6 +184,19 @@ client.alimtalk.send(
184
184
 
185
185
  ### 카카오 친구톡
186
186
 
187
+ > ⚠️ **Deprecated — 친구톡은 카카오 정책에 따라 2025-12-31 종료되었습니다.**
188
+ > 2026-01-01 부터 친구톡 발송 요청은 카카오 측에서 **브랜드메시지(자유형)** 로 자동 대체 발송됩니다.
189
+ > 호출은 계속 성공하며, 자유 본문 타입(`FT`/`FI`/`FW`)을 개별 수신자에게 보내는 경로는
190
+ > 현재 이것뿐이므로 기존 코드를 당장 바꿀 필요는 없습니다.
191
+ >
192
+ > 다음의 경우에는 **브랜드메시지**를 사용하세요.
193
+ > - 템플릿 기반 리치 타입 (`FL`/`FC`/`FM`/`FP`/`FA`)
194
+ > - 채널 친구가 **아닌** 수신자 (`targeting` = `N` / `I`)
195
+ > - 수신 동의한 전체 채널 친구 동보 (`targeting` = `F`)
196
+ >
197
+ > 메시지 타입은 1:1 대응되며 변환은 서버가 처리합니다 — `FT`→`BT`, `FI`→`BI`, `FW`→`BW`,
198
+ > `FL`→`BL`, `FC`→`BC`, `FM`→`BM`, `FP`→`BP`, `FA`→`BA`.
199
+
187
200
  ```python
188
201
  # 텍스트형
189
202
  client.friendtalk.send(
@@ -232,6 +245,42 @@ client.sms.send_mms(
232
245
 
233
246
  ---
234
247
 
248
+ ## 브랜드메시지 사용법
249
+
250
+ 브랜드메시지는 친구톡의 후속 채널입니다. 메시지 타입이 친구톡과 1:1 대응되며
251
+ (`FT`→`BT`, `FI`→`BI`, `FW`→`BW`, `FL`→`BL`, `FC`→`BC`, `FM`→`BM`, `FP`→`BP`, `FA`→`BA`),
252
+ 요청에는 **친구톡 코드를 그대로** 넘기고 변환은 서버가 처리합니다.
253
+
254
+ 친구톡과 달리 다음이 가능합니다.
255
+
256
+ - 채널 친구가 **아닌** 수신자에게 발송 (`targeting: N`)
257
+ - 수신 동의한 **전체 채널 친구 동보** 발송 (`targeting: F`, 수신자 목록 불필요)
258
+ - 리스트·캐러셀·커머스·동영상 등 **템플릿 기반 리치 메시지**
259
+
260
+ > v2 전용입니다. 자유 본문 타입(`FT`/`FI`/`FW`)을 개별 수신자에게 보낼 때는 여전히 친구톡 API 를 쓰세요 — 이 엔드포인트는 그 조합에 `NOT_A_BRAND_MESSAGE` 를 반환합니다. 친구톡 요청은 카카오 측에서 브랜드메시지(자유형)로 대체 발송됩니다.
261
+
262
+ ```python
263
+ # 단건 발송 — 채널 친구 대상
264
+ client.brand_message.send(
265
+ targeting="M",
266
+ message_type="FL",
267
+ friend_template_uuid="9cd5460b-6458-4edc-9b11-c26d3013c340",
268
+ contacts=[{"contact": "01012345678", "var1": "29,000원"}],
269
+ )
270
+
271
+ # 동보 발송 — 수신 동의한 전체 채널 친구 (contacts 불필요)
272
+ client.brand_message.broadcast(
273
+ message_type="FW",
274
+ friend_template_uuid="9cd5460b-6458-4edc-9b11-c26d3013c340",
275
+ )
276
+
277
+ # 캠페인 조회 (from 은 예약어이므로 from_ 사용)
278
+ campaigns = client.brand_message.campaigns(from_="2026-08-01", count=10)
279
+ one = client.brand_message.campaign("1f0a6d0e-6b3b-4f0f-9b2f-2f6f6a1b7c11")
280
+ ```
281
+
282
+ ---
283
+
235
284
  ## 프레임워크 통합
236
285
 
237
286
  ### Django
@@ -419,6 +468,56 @@ A. Sendgo 플랜별로 TPS 제한이 있습니다. [요금 정책](https://sendg
419
468
 
420
469
  ---
421
470
 
471
+ ## 짧은 URL
472
+
473
+ 짧은 URL 은 메시지 본문의 링크를 줄이고, 그 링크가 실제로 눌렸는지 집계합니다.
474
+ 문자는 바이트 수가 요금과 직결되므로 링크를 줄이면 그만큼 본문을 더 쓸 수 있습니다.
475
+
476
+ 같은 원본 URL 을 다시 줄이면 **기존 링크가 그대로 반환**됩니다. 캠페인별로 반응을
477
+ 따로 집계하려면 `forceNew` 로 새 코드를 만드세요.
478
+
479
+ `deactivate` 는 링크를 삭제하지 않고 리다이렉트만 중지합니다. 이미 발송한 메시지의
480
+ 링크를 무효화할 때 쓰며, 누적 통계는 남고 이후 접속은 `410 Gone` 이 됩니다.
481
+
482
+ ```python
483
+ # 짧은 URL 생성 (v2 전용)
484
+ created = sendgo.short_url.create(
485
+ target_url="https://example.com/promotions/summer-sale",
486
+ title="여름 세일 랜딩",
487
+ )
488
+
489
+ code = created["data"]["code"]
490
+ link = created["data"]["shortUrl"]
491
+
492
+ # 반응 통계 — 일별 추이 + 디바이스/유입경로/국가별 분해
493
+ # `from` 은 파이썬 예약어이므로 `from_` 을 쓴다
494
+ stats = sendgo.short_url.stats(code, from_="2026-08-01")
495
+
496
+ sendgo.short_url.list(count=10)
497
+ sendgo.short_url.show(code)
498
+ sendgo.short_url.deactivate(code) # 리다이렉트만 중지, 통계는 남는다
499
+ ```
500
+
501
+ `stats` 는 일별 추이(`daily`)와 디바이스(`byDevice`)·유입경로(`byReferer`)·국가(`byCountry`)별
502
+ 분해를 반환합니다. 일별 추이는 사전 집계 표에서 읽으므로 클릭이 많아도 응답 시간이 일정합니다.
503
+
504
+ ## 변경 사항
505
+
506
+ ### 1.2.0 (2026-08-14)
507
+
508
+ - **친구톡 Deprecated 표기** — 친구톡은 카카오 정책에 따라 2025-12-31 종료되었고,
509
+ 2026-01-01 부터 발송 요청이 브랜드메시지(자유형)로 자동 대체 발송됩니다.
510
+ 관련 API 에 각 언어의 표준 deprecation 표기를 달았습니다.
511
+ - 자유 본문 타입(`FT`/`FI`/`FW`)의 개별 발송 경로는 아직 친구톡 API 뿐이라는 점을
512
+ 문서에 명시했습니다 — 브랜드메시지 API 는 그 조합에 `NOT_A_BRAND_MESSAGE` 를 반환합니다.
513
+ - 브랜드메시지 전환 안내와 메시지 타입 1:1 대응표를 README 에 추가했습니다.
514
+
515
+ ### 1.1.0 (2026-08-11)
516
+
517
+ - 짧은 URL 추가 — `client.short_url`
518
+ - `HttpClient.delete()` 추가
519
+ - **버전 단일화** — `__init__.py` 에 하드코딩된 `__version__` 을 제거하고 `importlib.metadata` 로 `pyproject.toml` 값을 읽는다. 두 곳이 어긋나 릴리스가 실패한 적이 있다.
520
+
422
521
  ## 라이선스
423
522
 
424
523
  MIT License © 2026 [Sendgo](https://sendgo.io)
@@ -1,6 +1,6 @@
1
1
  # sendgo-python
2
2
 
3
- > **Python / Django / FastAPI에서 카카오 알림톡, 친구톡, SMS를 가장 쉽게 발송하는 SDK**
3
+ > **Python / Django / FastAPI에서 카카오 알림톡, 브랜드메시지, SMS를 가장 쉽게 발송하는 SDK**
4
4
 
5
5
  [![PyPI version](https://img.shields.io/pypi/v/sendgo-python?logo=pypi)](https://pypi.org/project/sendgo-python/)
6
6
  [![Python](https://img.shields.io/badge/Python-3.10%2B-3776AB?logo=python)](https://python.org)
@@ -157,6 +157,19 @@ client.alimtalk.send(
157
157
 
158
158
  ### 카카오 친구톡
159
159
 
160
+ > ⚠️ **Deprecated — 친구톡은 카카오 정책에 따라 2025-12-31 종료되었습니다.**
161
+ > 2026-01-01 부터 친구톡 발송 요청은 카카오 측에서 **브랜드메시지(자유형)** 로 자동 대체 발송됩니다.
162
+ > 호출은 계속 성공하며, 자유 본문 타입(`FT`/`FI`/`FW`)을 개별 수신자에게 보내는 경로는
163
+ > 현재 이것뿐이므로 기존 코드를 당장 바꿀 필요는 없습니다.
164
+ >
165
+ > 다음의 경우에는 **브랜드메시지**를 사용하세요.
166
+ > - 템플릿 기반 리치 타입 (`FL`/`FC`/`FM`/`FP`/`FA`)
167
+ > - 채널 친구가 **아닌** 수신자 (`targeting` = `N` / `I`)
168
+ > - 수신 동의한 전체 채널 친구 동보 (`targeting` = `F`)
169
+ >
170
+ > 메시지 타입은 1:1 대응되며 변환은 서버가 처리합니다 — `FT`→`BT`, `FI`→`BI`, `FW`→`BW`,
171
+ > `FL`→`BL`, `FC`→`BC`, `FM`→`BM`, `FP`→`BP`, `FA`→`BA`.
172
+
160
173
  ```python
161
174
  # 텍스트형
162
175
  client.friendtalk.send(
@@ -205,6 +218,42 @@ client.sms.send_mms(
205
218
 
206
219
  ---
207
220
 
221
+ ## 브랜드메시지 사용법
222
+
223
+ 브랜드메시지는 친구톡의 후속 채널입니다. 메시지 타입이 친구톡과 1:1 대응되며
224
+ (`FT`→`BT`, `FI`→`BI`, `FW`→`BW`, `FL`→`BL`, `FC`→`BC`, `FM`→`BM`, `FP`→`BP`, `FA`→`BA`),
225
+ 요청에는 **친구톡 코드를 그대로** 넘기고 변환은 서버가 처리합니다.
226
+
227
+ 친구톡과 달리 다음이 가능합니다.
228
+
229
+ - 채널 친구가 **아닌** 수신자에게 발송 (`targeting: N`)
230
+ - 수신 동의한 **전체 채널 친구 동보** 발송 (`targeting: F`, 수신자 목록 불필요)
231
+ - 리스트·캐러셀·커머스·동영상 등 **템플릿 기반 리치 메시지**
232
+
233
+ > v2 전용입니다. 자유 본문 타입(`FT`/`FI`/`FW`)을 개별 수신자에게 보낼 때는 여전히 친구톡 API 를 쓰세요 — 이 엔드포인트는 그 조합에 `NOT_A_BRAND_MESSAGE` 를 반환합니다. 친구톡 요청은 카카오 측에서 브랜드메시지(자유형)로 대체 발송됩니다.
234
+
235
+ ```python
236
+ # 단건 발송 — 채널 친구 대상
237
+ client.brand_message.send(
238
+ targeting="M",
239
+ message_type="FL",
240
+ friend_template_uuid="9cd5460b-6458-4edc-9b11-c26d3013c340",
241
+ contacts=[{"contact": "01012345678", "var1": "29,000원"}],
242
+ )
243
+
244
+ # 동보 발송 — 수신 동의한 전체 채널 친구 (contacts 불필요)
245
+ client.brand_message.broadcast(
246
+ message_type="FW",
247
+ friend_template_uuid="9cd5460b-6458-4edc-9b11-c26d3013c340",
248
+ )
249
+
250
+ # 캠페인 조회 (from 은 예약어이므로 from_ 사용)
251
+ campaigns = client.brand_message.campaigns(from_="2026-08-01", count=10)
252
+ one = client.brand_message.campaign("1f0a6d0e-6b3b-4f0f-9b2f-2f6f6a1b7c11")
253
+ ```
254
+
255
+ ---
256
+
208
257
  ## 프레임워크 통합
209
258
 
210
259
  ### Django
@@ -392,6 +441,56 @@ A. Sendgo 플랜별로 TPS 제한이 있습니다. [요금 정책](https://sendg
392
441
 
393
442
  ---
394
443
 
444
+ ## 짧은 URL
445
+
446
+ 짧은 URL 은 메시지 본문의 링크를 줄이고, 그 링크가 실제로 눌렸는지 집계합니다.
447
+ 문자는 바이트 수가 요금과 직결되므로 링크를 줄이면 그만큼 본문을 더 쓸 수 있습니다.
448
+
449
+ 같은 원본 URL 을 다시 줄이면 **기존 링크가 그대로 반환**됩니다. 캠페인별로 반응을
450
+ 따로 집계하려면 `forceNew` 로 새 코드를 만드세요.
451
+
452
+ `deactivate` 는 링크를 삭제하지 않고 리다이렉트만 중지합니다. 이미 발송한 메시지의
453
+ 링크를 무효화할 때 쓰며, 누적 통계는 남고 이후 접속은 `410 Gone` 이 됩니다.
454
+
455
+ ```python
456
+ # 짧은 URL 생성 (v2 전용)
457
+ created = sendgo.short_url.create(
458
+ target_url="https://example.com/promotions/summer-sale",
459
+ title="여름 세일 랜딩",
460
+ )
461
+
462
+ code = created["data"]["code"]
463
+ link = created["data"]["shortUrl"]
464
+
465
+ # 반응 통계 — 일별 추이 + 디바이스/유입경로/국가별 분해
466
+ # `from` 은 파이썬 예약어이므로 `from_` 을 쓴다
467
+ stats = sendgo.short_url.stats(code, from_="2026-08-01")
468
+
469
+ sendgo.short_url.list(count=10)
470
+ sendgo.short_url.show(code)
471
+ sendgo.short_url.deactivate(code) # 리다이렉트만 중지, 통계는 남는다
472
+ ```
473
+
474
+ `stats` 는 일별 추이(`daily`)와 디바이스(`byDevice`)·유입경로(`byReferer`)·국가(`byCountry`)별
475
+ 분해를 반환합니다. 일별 추이는 사전 집계 표에서 읽으므로 클릭이 많아도 응답 시간이 일정합니다.
476
+
477
+ ## 변경 사항
478
+
479
+ ### 1.2.0 (2026-08-14)
480
+
481
+ - **친구톡 Deprecated 표기** — 친구톡은 카카오 정책에 따라 2025-12-31 종료되었고,
482
+ 2026-01-01 부터 발송 요청이 브랜드메시지(자유형)로 자동 대체 발송됩니다.
483
+ 관련 API 에 각 언어의 표준 deprecation 표기를 달았습니다.
484
+ - 자유 본문 타입(`FT`/`FI`/`FW`)의 개별 발송 경로는 아직 친구톡 API 뿐이라는 점을
485
+ 문서에 명시했습니다 — 브랜드메시지 API 는 그 조합에 `NOT_A_BRAND_MESSAGE` 를 반환합니다.
486
+ - 브랜드메시지 전환 안내와 메시지 타입 1:1 대응표를 README 에 추가했습니다.
487
+
488
+ ### 1.1.0 (2026-08-11)
489
+
490
+ - 짧은 URL 추가 — `client.short_url`
491
+ - `HttpClient.delete()` 추가
492
+ - **버전 단일화** — `__init__.py` 에 하드코딩된 `__version__` 을 제거하고 `importlib.metadata` 로 `pyproject.toml` 값을 읽는다. 두 곳이 어긋나 릴리스가 실패한 적이 있다.
493
+
395
494
  ## 라이선스
396
495
 
397
496
  MIT License © 2026 [Sendgo](https://sendgo.io)
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "sendgo-python"
7
- version = "1.0.1"
7
+ version = "1.2.0"
8
8
  description = "Sendgo Python SDK — 카카오 알림톡/친구톡, SMS/LMS/MMS"
9
9
  readme = "README.md"
10
10
  license = {text = "MIT"}
@@ -0,0 +1,34 @@
1
+ """
2
+ Sendgo Python SDK — 카카오 알림톡/친구톡, SMS/LMS/MMS
3
+
4
+ 사용법:
5
+ from sendgo import Sendgo
6
+
7
+ client = Sendgo(
8
+ access_key="your_access_key",
9
+ secret_key="your_secret_key",
10
+ kakao_sender_key="your_kakao_key",
11
+ sms_sender_key="your_sms_key",
12
+ api_version="v2",
13
+ )
14
+
15
+ client.alimtalk.send(
16
+ template_code="ORDER_CONFIRM_001",
17
+ contacts=[{"contact": "01012345678", "var1": "ORD-001"}],
18
+ )
19
+ """
20
+
21
+ from .brand_message import BrandMessageService
22
+ from .short_url import ShortUrlService
23
+ from .client import Sendgo
24
+ from .exceptions import SendgoError
25
+
26
+ __all__ = ["Sendgo", "SendgoError", "BrandMessageService", "ShortUrlService"]
27
+ try:
28
+ from importlib.metadata import PackageNotFoundError, version as _pkg_version
29
+
30
+ # 버전은 pyproject.toml 이 단일 출처다. 여기에 값을 또 적으면
31
+ # 릴리스마다 두 곳을 맞춰야 하고, 실제로 어긋난 적이 있다.
32
+ __version__ = _pkg_version("sendgo-python")
33
+ except PackageNotFoundError: # 설치되지 않은 소스 트리에서 import 한 경우
34
+ __version__ = "0.0.0.dev0"
@@ -0,0 +1,157 @@
1
+ from __future__ import annotations
2
+
3
+ from typing import Any, Literal
4
+
5
+ from .http_client import HttpClient
6
+
7
+ BrandMessageType = Literal["FT", "FI", "FW", "FL", "FM", "FC", "FA", "FP"]
8
+ BrandMessageTargeting = Literal["M", "N", "I", "F"]
9
+
10
+
11
+ class BrandMessageService:
12
+ """카카오 브랜드메시지 전송 서비스.
13
+
14
+ 브랜드메시지는 친구톡의 후속 채널로, 메시지 타입이 친구톡과 1:1 대응됩니다
15
+ (FT→BT, FI→BI, FW→BW, FL→BL, FC→BC, FM→BM, FP→BP, FA→BA).
16
+ ``message_type`` 에는 친구톡 코드를 그대로 넘기고, 변환은 서버가 처리합니다.
17
+
18
+ 친구톡과 달리 채널 친구가 아닌 수신자에게도 보낼 수 있고(``targeting="N"``),
19
+ 수신 동의한 전체 채널 친구에게 동보 발송할 수 있습니다(``targeting="F"``).
20
+
21
+ Example::
22
+
23
+ # 단건 발송 — 채널 친구 대상
24
+ client.brand_message.send(
25
+ targeting="M",
26
+ message_type="FL",
27
+ friend_template_uuid="9cd5460b-6458-4edc-9b11-c26d3013c340",
28
+ contacts=[{"contact": "01012345678", "var1": "29,000원"}],
29
+ )
30
+
31
+ # 동보 발송 — 수신 동의한 전체 채널 친구 (contacts 불필요)
32
+ client.brand_message.broadcast(
33
+ message_type="FW",
34
+ friend_template_uuid="9cd5460b-6458-4edc-9b11-c26d3013c340",
35
+ )
36
+ """
37
+
38
+ def __init__(self, http: HttpClient, kakao_sender_key: str | None, sms_sender_key: str | None) -> None:
39
+ self._http = http
40
+ self._kakao_sender_key = kakao_sender_key
41
+ self._sms_sender_key = sms_sender_key
42
+
43
+ def send(
44
+ self,
45
+ *,
46
+ friend_template_uuid: str,
47
+ message_type: BrandMessageType = "FT",
48
+ targeting: BrandMessageTargeting = "M",
49
+ contacts: list[dict] | None = None,
50
+ content: str | None = None,
51
+ schedule_type: Literal["DIRECTLY", "SCHEDULED"] = "DIRECTLY",
52
+ at: str | None = None,
53
+ buttons: list[dict] | None = None,
54
+ image_url: str | None = None,
55
+ image_link: str | None = None,
56
+ ad_flag: Literal["Y", "N"] = "Y",
57
+ adult: Literal["Y", "N"] = "N",
58
+ push_alarm: Literal["Y", "N"] = "Y",
59
+ header: str | None = None,
60
+ coupon: dict | None = None,
61
+ item: dict | None = None,
62
+ commerce: dict | None = None,
63
+ list_: list[dict] | None = None,
64
+ head: dict | None = None,
65
+ tail: dict | None = None,
66
+ video: dict | None = None,
67
+ additional_content: str | None = None,
68
+ friend_group_key: str | None = None,
69
+ replace_sms: Literal["Y", "N"] = "N",
70
+ sms_subject: str | None = None,
71
+ sms_content: str | None = None,
72
+ reject_service_id: str | None = None,
73
+ webhooks: list[str] | None = None,
74
+ ) -> dict:
75
+ """브랜드메시지를 전송합니다.
76
+
77
+ ``targeting`` 이 ``"M"`` / ``"N"`` / ``"I"`` 이면 ``contacts`` 가 필요하고
78
+ 응답 ``data`` 에 발송 건수(``sentCount``)가 담깁니다. ``"F"`` 는 동보 발송이라
79
+ ``contacts`` 없이 접수 여부(``accepted``)만 반환됩니다 — 그 경우
80
+ :meth:`broadcast` 가 더 명확합니다.
81
+
82
+ ``list_`` 는 파이썬 내장 ``list`` 와 충돌을 피하기 위한 이름이며,
83
+ 요청에는 ``list`` 로 전송됩니다.
84
+ """
85
+ body: dict[str, Any] = {
86
+ "at": at,
87
+ "scheduleType": schedule_type,
88
+ "targeting": targeting,
89
+ "messageType": message_type,
90
+ "friendTemplateUuid": friend_template_uuid,
91
+ "content": content,
92
+ "buttons": buttons or [],
93
+ "imageUrl": image_url,
94
+ "imageLink": image_link,
95
+ "adFlag": ad_flag,
96
+ "adult": adult,
97
+ "pushAlarm": push_alarm,
98
+ "header": header,
99
+ "coupon": coupon,
100
+ "item": item,
101
+ "commerce": commerce,
102
+ "list": list_,
103
+ "head": head,
104
+ "tail": tail,
105
+ "video": video,
106
+ "additionalContent": additional_content,
107
+ "friendGroupKey": friend_group_key,
108
+ "replaceSms": replace_sms,
109
+ "smsSubject": sms_subject if replace_sms == "Y" else None,
110
+ "smsContent": sms_content if replace_sms == "Y" else None,
111
+ "rejectServiceId": reject_service_id,
112
+ "webhooks": webhooks or [],
113
+ "kakaoSenderKey": self._kakao_sender_key,
114
+ "senderKey": self._sms_sender_key,
115
+ }
116
+
117
+ # A broadcast has no recipient list; sending an empty ``contacts`` would be
118
+ # rejected as an invalid request, so the key is omitted entirely.
119
+ if targeting != "F":
120
+ body["contacts"] = contacts or []
121
+
122
+ return self._http.post("brand-messages/send", body)
123
+
124
+ def broadcast(self, **kwargs: Any) -> dict:
125
+ """동보 발송 — 수신 동의한 전체 채널 친구 (``targeting="F"``).
126
+
127
+ 수신자 목록은 카카오 측에서 확장하므로 ``contacts`` 를 넘기지 않습니다.
128
+ 결과는 :meth:`campaigns` / :meth:`campaign` 으로 확인합니다.
129
+ """
130
+ kwargs.pop("contacts", None)
131
+ kwargs["targeting"] = "F"
132
+
133
+ return self.send(**kwargs)
134
+
135
+ def campaigns(
136
+ self,
137
+ *,
138
+ from_: str | None = None,
139
+ to: str | None = None,
140
+ count: int | None = None,
141
+ ) -> dict:
142
+ """브랜드메시지 캠페인 목록을 조회합니다.
143
+
144
+ ``from_`` 은 파이썬 예약어 ``from`` 을 피하기 위한 이름이며,
145
+ 요청에는 ``from`` 으로 전송됩니다.
146
+ """
147
+ return self._http.get(
148
+ "brand-messages",
149
+ {"from": from_, "to": to, "count": count},
150
+ )
151
+
152
+ def campaign(self, campaign_id: str) -> dict:
153
+ """브랜드메시지 캠페인 상세를 조회합니다.
154
+
155
+ :param campaign_id: 발송 응답의 ``campaignId`` (UUID)
156
+ """
157
+ return self._http.get(f"brand-messages/{campaign_id}")
@@ -1,8 +1,10 @@
1
1
  from __future__ import annotations
2
2
 
3
3
  from .alimtalk import AlimtalkService
4
+ from .brand_message import BrandMessageService
4
5
  from .friendtalk import FriendtalkService
5
6
  from .http_client import HttpClient
7
+ from .short_url import ShortUrlService
6
8
  from .sms import SmsService
7
9
  from .token_manager import TokenManager
8
10
 
@@ -45,6 +47,11 @@ class Sendgo:
45
47
  token_manager = TokenManager(base_url, access_key, secret_key, api_version)
46
48
  http = HttpClient(token_manager, base_url, api_version)
47
49
 
48
- self.alimtalk = AlimtalkService(http, kakao_sender_key, sms_sender_key)
49
- self.friendtalk = FriendtalkService(http, kakao_sender_key, sms_sender_key)
50
- self.sms = SmsService(http, sms_sender_key)
50
+ self.alimtalk = AlimtalkService(http, kakao_sender_key, sms_sender_key)
51
+ # Deprecated 친구톡은 2025-12-31 종료. brand_message 를 사용한다.
52
+ self.friendtalk = FriendtalkService(http, kakao_sender_key, sms_sender_key)
53
+ # 카카오 브랜드메시지 — 친구톡의 후속 채널. v2 전용.
54
+ self.brand_message = BrandMessageService(http, kakao_sender_key, sms_sender_key)
55
+ # 짧은 URL — 링크 단축과 클릭 반응 분석. v2 전용.
56
+ self.short_url = ShortUrlService(http)
57
+ self.sms = SmsService(http, sms_sender_key)
@@ -1,5 +1,6 @@
1
1
  from __future__ import annotations
2
2
 
3
+ import warnings
3
4
  from typing import Any, Literal
4
5
 
5
6
  from .http_client import HttpClient
@@ -10,6 +11,17 @@ FriendtalkMessageType = Literal["FT", "FI", "FW", "FL", "FM", "FC", "FA", "FP"]
10
11
  class FriendtalkService:
11
12
  """카카오 친구톡 전송 서비스.
12
13
 
14
+ .. deprecated::
15
+ 친구톡은 카카오 정책에 따라 2025-12-31 종료되었습니다. 2026-01-01 부터
16
+ 친구톡 발송 요청은 카카오 측에서 브랜드메시지(자유형)로 자동 대체 발송되므로,
17
+ 이 서비스를 호출해도 실제로 나가는 것은 브랜드메시지입니다.
18
+ 신규 연동은 :class:`~sendgo.brand_message.BrandMessageService`
19
+ (``client.brand_message``) 를 사용하세요. 다만 자유 본문 타입(FT/FI/FW)을
20
+ 개별 수신자에게 보내는 경로는 아직 이 서비스뿐입니다 — 브랜드메시지 API 는
21
+ 그 조합에 ``NOT_A_BRAND_MESSAGE`` 를 반환합니다.
22
+ 메시지 타입은 1:1 대응됩니다 — FT→BT, FI→BI, FW→BW, FL→BL,
23
+ FC→BC, FM→BM, FP→BP, FA→BA.
24
+
13
25
  Example::
14
26
 
15
27
  client.friendtalk.send(
@@ -42,7 +54,19 @@ class FriendtalkService:
42
54
  sms_subject: str | None = None,
43
55
  sms_content: str | None = None,
44
56
  ) -> dict:
45
- """친구톡을 전송합니다."""
57
+ """친구톡을 전송합니다.
58
+
59
+ .. deprecated::
60
+ 2025-12-31 종료. ``client.brand_message.send()`` 를 사용하세요.
61
+ """
62
+ # 파이썬의 DeprecationWarning 은 기본적으로 숨겨지므로 운영 로그를 더럽히지
63
+ # 않으면서, 테스트(-W error)나 개발 모드(-X dev)에서는 확실히 드러난다.
64
+ warnings.warn(
65
+ "친구톡은 2025-12-31 종료되어 2026-01-01 부터 브랜드메시지(자유형)로 "
66
+ "자동 대체 발송됩니다. client.brand_message.send() 를 사용하세요.",
67
+ DeprecationWarning,
68
+ stacklevel=2,
69
+ )
46
70
  body: dict[str, Any] = {
47
71
  "at": at,
48
72
  "scheduleType": schedule_type,
@@ -17,15 +17,34 @@ class HttpClient:
17
17
  self._session.headers.update({"Content-Type": "application/json"})
18
18
 
19
19
  def post(self, path: str, body: dict) -> dict:
20
- return self._do_post(path, body, is_retry=False)
20
+ return self._request("POST", path, body=body, is_retry=False)
21
21
 
22
- def _do_post(self, path: str, body: dict, *, is_retry: bool) -> dict:
22
+ def get(self, path: str, params: dict | None = None) -> dict:
23
+ """GET request, used by the campaign lookup endpoints."""
24
+ return self._request("GET", path, params=params, is_retry=False)
25
+
26
+ def delete(self, path: str) -> dict:
27
+ """`_request()` drives the verb, so DELETE only needs to skip the body."""
28
+ return self._request("DELETE", path, is_retry=False)
29
+
30
+ def _request(
31
+ self,
32
+ method: str,
33
+ path: str,
34
+ *,
35
+ body: dict | None = None,
36
+ params: dict | None = None,
37
+ is_retry: bool,
38
+ ) -> dict:
23
39
  url = f"{self._base_url}/api/{self._api_version}/{path}"
24
40
  token = self._token_manager.get_token()
25
41
 
26
- resp = self._session.post(
42
+ resp = self._session.request(
43
+ method,
27
44
  url,
28
45
  json=body,
46
+ # Drop unset filters so the server applies its own defaults.
47
+ params={k: v for k, v in (params or {}).items() if v is not None} or None,
29
48
  headers={"Authorization": self._make_bearer(token)},
30
49
  timeout=15,
31
50
  )
@@ -37,7 +56,7 @@ class HttpClient:
37
56
  endpoint = path.split("/")[-1]
38
57
  if not is_retry and self._token_manager.should_refresh(resp.status_code, error_code):
39
58
  self._token_manager.invalidate()
40
- return self._do_post(path, body, is_retry=True)
59
+ return self._request(method, path, body=body, params=params, is_retry=True)
41
60
  raise SendgoError.from_response(resp.status_code, response_body, endpoint, self._api_version)
42
61
 
43
62
  return response_body
@@ -0,0 +1,86 @@
1
+ """짧은 URL — 메시지에 넣는 링크를 줄이고 클릭 반응을 집계한다."""
2
+
3
+ from __future__ import annotations
4
+
5
+ from typing import Any
6
+ from urllib.parse import quote
7
+
8
+ from .http_client import HttpClient
9
+
10
+
11
+ class ShortUrlService:
12
+ """짧은 URL 서비스. v2 전용이다.
13
+
14
+ Example:
15
+ created = client.short_url.create(
16
+ target_url="https://example.com/promotions/summer-sale",
17
+ title="여름 세일 랜딩",
18
+ )
19
+
20
+ # created["data"]["shortUrl"] 를 문자/알림톡 본문에 넣는다.
21
+ stats = client.short_url.stats(created["data"]["code"])
22
+ """
23
+
24
+ def __init__(self, http: HttpClient) -> None:
25
+ self._http = http
26
+
27
+ def create(
28
+ self,
29
+ *,
30
+ target_url: str,
31
+ title: str | None = None,
32
+ expires_at: str | None = None,
33
+ force_new: bool = False,
34
+ ) -> dict[str, Any]:
35
+ """짧은 URL 을 만든다.
36
+
37
+ 같은 원본 URL 을 다시 줄이면 기존 링크가 그대로 반환된다.
38
+ 캠페인별로 반응을 분리해 집계하려면 ``force_new=True`` 를 쓴다.
39
+ """
40
+ body: dict[str, Any] = {"targetUrl": target_url, "forceNew": force_new}
41
+
42
+ if title is not None:
43
+ body["title"] = title
44
+ if expires_at is not None:
45
+ body["expiresAt"] = expires_at
46
+
47
+ return self._http.post("short-urls", body)
48
+
49
+ def list(
50
+ self,
51
+ *,
52
+ from_: str | None = None,
53
+ to: str | None = None,
54
+ count: int | None = None,
55
+ ) -> dict[str, Any]:
56
+ """목록 조회. ``from`` 은 파이썬 예약어이므로 ``from_`` 을 쓴다."""
57
+ params = {"from": from_, "to": to, "count": count}
58
+
59
+ return self._http.get("short-urls", {k: v for k, v in params.items() if v is not None})
60
+
61
+ def show(self, code: str) -> dict[str, Any]:
62
+ """상세 조회."""
63
+ return self._http.get(f"short-urls/{quote(code, safe='')}")
64
+
65
+ def stats(
66
+ self,
67
+ code: str,
68
+ *,
69
+ from_: str | None = None,
70
+ to: str | None = None,
71
+ ) -> dict[str, Any]:
72
+ """반응 통계. 일별 추이와 디바이스/유입경로/국가별 분해를 반환한다."""
73
+ params = {"from": from_, "to": to}
74
+
75
+ return self._http.get(
76
+ f"short-urls/{quote(code, safe='')}/stats",
77
+ {k: v for k, v in params.items() if v is not None},
78
+ )
79
+
80
+ def deactivate(self, code: str) -> dict[str, Any]:
81
+ """리다이렉트를 중지한다.
82
+
83
+ 링크는 삭제되지 않고 누적 통계도 남는다. 이후 그 링크로 들어오면
84
+ 410 Gone 이 반환된다.
85
+ """
86
+ return self._http.delete(f"short-urls/{quote(code, safe='')}")
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sendgo-python
3
- Version: 1.0.1
3
+ Version: 1.2.0
4
4
  Summary: Sendgo Python SDK — 카카오 알림톡/친구톡, SMS/LMS/MMS
5
5
  Author-email: Sendgo <dev@sendgo.io>
6
6
  License: MIT
@@ -27,7 +27,7 @@ Requires-Dist: httpx>=0.27; extra == "async"
27
27
 
28
28
  # sendgo-python
29
29
 
30
- > **Python / Django / FastAPI에서 카카오 알림톡, 친구톡, SMS를 가장 쉽게 발송하는 SDK**
30
+ > **Python / Django / FastAPI에서 카카오 알림톡, 브랜드메시지, SMS를 가장 쉽게 발송하는 SDK**
31
31
 
32
32
  [![PyPI version](https://img.shields.io/pypi/v/sendgo-python?logo=pypi)](https://pypi.org/project/sendgo-python/)
33
33
  [![Python](https://img.shields.io/badge/Python-3.10%2B-3776AB?logo=python)](https://python.org)
@@ -184,6 +184,19 @@ client.alimtalk.send(
184
184
 
185
185
  ### 카카오 친구톡
186
186
 
187
+ > ⚠️ **Deprecated — 친구톡은 카카오 정책에 따라 2025-12-31 종료되었습니다.**
188
+ > 2026-01-01 부터 친구톡 발송 요청은 카카오 측에서 **브랜드메시지(자유형)** 로 자동 대체 발송됩니다.
189
+ > 호출은 계속 성공하며, 자유 본문 타입(`FT`/`FI`/`FW`)을 개별 수신자에게 보내는 경로는
190
+ > 현재 이것뿐이므로 기존 코드를 당장 바꿀 필요는 없습니다.
191
+ >
192
+ > 다음의 경우에는 **브랜드메시지**를 사용하세요.
193
+ > - 템플릿 기반 리치 타입 (`FL`/`FC`/`FM`/`FP`/`FA`)
194
+ > - 채널 친구가 **아닌** 수신자 (`targeting` = `N` / `I`)
195
+ > - 수신 동의한 전체 채널 친구 동보 (`targeting` = `F`)
196
+ >
197
+ > 메시지 타입은 1:1 대응되며 변환은 서버가 처리합니다 — `FT`→`BT`, `FI`→`BI`, `FW`→`BW`,
198
+ > `FL`→`BL`, `FC`→`BC`, `FM`→`BM`, `FP`→`BP`, `FA`→`BA`.
199
+
187
200
  ```python
188
201
  # 텍스트형
189
202
  client.friendtalk.send(
@@ -232,6 +245,42 @@ client.sms.send_mms(
232
245
 
233
246
  ---
234
247
 
248
+ ## 브랜드메시지 사용법
249
+
250
+ 브랜드메시지는 친구톡의 후속 채널입니다. 메시지 타입이 친구톡과 1:1 대응되며
251
+ (`FT`→`BT`, `FI`→`BI`, `FW`→`BW`, `FL`→`BL`, `FC`→`BC`, `FM`→`BM`, `FP`→`BP`, `FA`→`BA`),
252
+ 요청에는 **친구톡 코드를 그대로** 넘기고 변환은 서버가 처리합니다.
253
+
254
+ 친구톡과 달리 다음이 가능합니다.
255
+
256
+ - 채널 친구가 **아닌** 수신자에게 발송 (`targeting: N`)
257
+ - 수신 동의한 **전체 채널 친구 동보** 발송 (`targeting: F`, 수신자 목록 불필요)
258
+ - 리스트·캐러셀·커머스·동영상 등 **템플릿 기반 리치 메시지**
259
+
260
+ > v2 전용입니다. 자유 본문 타입(`FT`/`FI`/`FW`)을 개별 수신자에게 보낼 때는 여전히 친구톡 API 를 쓰세요 — 이 엔드포인트는 그 조합에 `NOT_A_BRAND_MESSAGE` 를 반환합니다. 친구톡 요청은 카카오 측에서 브랜드메시지(자유형)로 대체 발송됩니다.
261
+
262
+ ```python
263
+ # 단건 발송 — 채널 친구 대상
264
+ client.brand_message.send(
265
+ targeting="M",
266
+ message_type="FL",
267
+ friend_template_uuid="9cd5460b-6458-4edc-9b11-c26d3013c340",
268
+ contacts=[{"contact": "01012345678", "var1": "29,000원"}],
269
+ )
270
+
271
+ # 동보 발송 — 수신 동의한 전체 채널 친구 (contacts 불필요)
272
+ client.brand_message.broadcast(
273
+ message_type="FW",
274
+ friend_template_uuid="9cd5460b-6458-4edc-9b11-c26d3013c340",
275
+ )
276
+
277
+ # 캠페인 조회 (from 은 예약어이므로 from_ 사용)
278
+ campaigns = client.brand_message.campaigns(from_="2026-08-01", count=10)
279
+ one = client.brand_message.campaign("1f0a6d0e-6b3b-4f0f-9b2f-2f6f6a1b7c11")
280
+ ```
281
+
282
+ ---
283
+
235
284
  ## 프레임워크 통합
236
285
 
237
286
  ### Django
@@ -419,6 +468,56 @@ A. Sendgo 플랜별로 TPS 제한이 있습니다. [요금 정책](https://sendg
419
468
 
420
469
  ---
421
470
 
471
+ ## 짧은 URL
472
+
473
+ 짧은 URL 은 메시지 본문의 링크를 줄이고, 그 링크가 실제로 눌렸는지 집계합니다.
474
+ 문자는 바이트 수가 요금과 직결되므로 링크를 줄이면 그만큼 본문을 더 쓸 수 있습니다.
475
+
476
+ 같은 원본 URL 을 다시 줄이면 **기존 링크가 그대로 반환**됩니다. 캠페인별로 반응을
477
+ 따로 집계하려면 `forceNew` 로 새 코드를 만드세요.
478
+
479
+ `deactivate` 는 링크를 삭제하지 않고 리다이렉트만 중지합니다. 이미 발송한 메시지의
480
+ 링크를 무효화할 때 쓰며, 누적 통계는 남고 이후 접속은 `410 Gone` 이 됩니다.
481
+
482
+ ```python
483
+ # 짧은 URL 생성 (v2 전용)
484
+ created = sendgo.short_url.create(
485
+ target_url="https://example.com/promotions/summer-sale",
486
+ title="여름 세일 랜딩",
487
+ )
488
+
489
+ code = created["data"]["code"]
490
+ link = created["data"]["shortUrl"]
491
+
492
+ # 반응 통계 — 일별 추이 + 디바이스/유입경로/국가별 분해
493
+ # `from` 은 파이썬 예약어이므로 `from_` 을 쓴다
494
+ stats = sendgo.short_url.stats(code, from_="2026-08-01")
495
+
496
+ sendgo.short_url.list(count=10)
497
+ sendgo.short_url.show(code)
498
+ sendgo.short_url.deactivate(code) # 리다이렉트만 중지, 통계는 남는다
499
+ ```
500
+
501
+ `stats` 는 일별 추이(`daily`)와 디바이스(`byDevice`)·유입경로(`byReferer`)·국가(`byCountry`)별
502
+ 분해를 반환합니다. 일별 추이는 사전 집계 표에서 읽으므로 클릭이 많아도 응답 시간이 일정합니다.
503
+
504
+ ## 변경 사항
505
+
506
+ ### 1.2.0 (2026-08-14)
507
+
508
+ - **친구톡 Deprecated 표기** — 친구톡은 카카오 정책에 따라 2025-12-31 종료되었고,
509
+ 2026-01-01 부터 발송 요청이 브랜드메시지(자유형)로 자동 대체 발송됩니다.
510
+ 관련 API 에 각 언어의 표준 deprecation 표기를 달았습니다.
511
+ - 자유 본문 타입(`FT`/`FI`/`FW`)의 개별 발송 경로는 아직 친구톡 API 뿐이라는 점을
512
+ 문서에 명시했습니다 — 브랜드메시지 API 는 그 조합에 `NOT_A_BRAND_MESSAGE` 를 반환합니다.
513
+ - 브랜드메시지 전환 안내와 메시지 타입 1:1 대응표를 README 에 추가했습니다.
514
+
515
+ ### 1.1.0 (2026-08-11)
516
+
517
+ - 짧은 URL 추가 — `client.short_url`
518
+ - `HttpClient.delete()` 추가
519
+ - **버전 단일화** — `__init__.py` 에 하드코딩된 `__version__` 을 제거하고 `importlib.metadata` 로 `pyproject.toml` 값을 읽는다. 두 곳이 어긋나 릴리스가 실패한 적이 있다.
520
+
422
521
  ## 라이선스
423
522
 
424
523
  MIT License © 2026 [Sendgo](https://sendgo.io)
@@ -2,10 +2,12 @@ README.md
2
2
  pyproject.toml
3
3
  sendgo/__init__.py
4
4
  sendgo/alimtalk.py
5
+ sendgo/brand_message.py
5
6
  sendgo/client.py
6
7
  sendgo/exceptions.py
7
8
  sendgo/friendtalk.py
8
9
  sendgo/http_client.py
10
+ sendgo/short_url.py
9
11
  sendgo/sms.py
10
12
  sendgo/token_manager.py
11
13
  sendgo_python.egg-info/PKG-INFO
@@ -1,25 +0,0 @@
1
- """
2
- Sendgo Python SDK — 카카오 알림톡/친구톡, SMS/LMS/MMS
3
-
4
- 사용법:
5
- from sendgo import Sendgo
6
-
7
- client = Sendgo(
8
- access_key="your_access_key",
9
- secret_key="your_secret_key",
10
- kakao_sender_key="your_kakao_key",
11
- sms_sender_key="your_sms_key",
12
- api_version="v2",
13
- )
14
-
15
- client.alimtalk.send(
16
- template_code="ORDER_CONFIRM_001",
17
- contacts=[{"contact": "01012345678", "var1": "ORD-001"}],
18
- )
19
- """
20
-
21
- from .client import Sendgo
22
- from .exceptions import SendgoError
23
-
24
- __all__ = ["Sendgo", "SendgoError"]
25
- __version__ = "1.0.0"
File without changes