SDK overview

The SDKs are language-specific client libraries that let you call the Communication API reliably from your application code.

Supported languages and runtimes

Every SDK is generated from the same spec (bizgo-api-spec, OpenAPI 3.1) and is versioned together. The current version is 1.2.0.

LanguageRepositoryPackageRuntime baseline
Javabizgo-sdk-comm-javaMaven Central io.github.icomm-api:bizgo-sdk-comm-javaJava 17 or later
Node.jsbizgo-sdk-comm-jsnpm @bizgo/bizgo-sdk-comm-jsNode.js 18 or later (ESM and CommonJS, TypeScript types included)
Pythonbizgo-sdk-comm-pythonPyPI bizgo-sdk-commPython 3.10 or later
Gobizgo-sdk-comm-gogithub.com/icomm-api/bizgo-sdk-comm-goGo 1.26 or later
PHPbizgo-sdk-comm-phpComposer icomm-api/bizgo-sdk-commPHP 8.2 or later
C#bizgo-sdk-comm-csNuGet Bizgo.Sdk.Comm.NET 8, .NET Standard 2.0 (.NET Framework 4.6.1 or later)

Common features

  • Authentication: API KEY, read from the BIZGO_API_KEY environment variable.
  • Environments: sandbox (no real delivery) and production (https://mars.ibapi.kr).
  • Sending: every channel goes through the unified send (/api/omni). When you pass several messages, the next one is sent as a fallback if the previous one fails.
  • Validation before sending: required fields, misspelled fields, byte length (SMS 90 bytes and so on, EUC-KR), characters outside EUC-KR (emoji), and the 200-recipient limit.
  • Extras: bulk sending, client-side rate limiting, report polling and webhook signature verification, testing tools, and observability (hooks, OpenTelemetry).

Migrating from earlier SDKs

1.2.0 is not compatible with the earlier SDKs. Bumping the version number alone will not compile, so read the migration section of each repository README first.

Earlier1.2.0
Java 1.1.x and earlier (net.bizgo.client.BizgoClient)bizgo-sdk-comm-java 1.2.0
Node.js 1.0.xbizgo-sdk-comm-js 1.2.0
infobank-omni-sdk-python (ID/password auth)bizgo-sdk-comm-python
infobank-omni-sdk-go (ID/password auth)bizgo-sdk-comm-go
infobank-omni-sdk-php5, infobank-omni-sdk-php7bizgo-sdk-comm-php (PHP 8.2 or later)
Infobank.Omni.Sdk.Cs (ID/password auth)bizgo-sdk-comm-cs