Install the SDK

This page collects the installation steps and a first send for each language SDK, based on the repository READMEs (1.2.0).

Before you start

  1. In the console, go to Bizgo > Developer tools > Key management (비즈고 > 개발 도구 > KEY 관리), issue an API Key, and register the public IP of the server that will call the API.
  2. Set the key as an environment variable. Never put the key in code or a repository. Every SDK reads the key from BIZGO_API_KEY.
Bash
export BIZGO_API_KEY=...

Every example below sends to the sandbox (no real delivery). To send in production, omit the environment setting or set it to Production.

Accepted ≠ delivered. The send result only tells you the request was accepted. Get the final outcome from reports.

Java SDK

Repository: bizgo-sdk-comm-java · Java 17 or later

Groovy
// Gradle
implementation 'io.github.icomm-api:bizgo-sdk-comm-java:1.2.0'
XML
<!-- Maven -->
<dependency>
  <groupId>io.github.icomm-api</groupId>
  <artifactId>bizgo-sdk-comm-java</artifactId>
  <version>1.2.0</version>
</dependency>
Java
import io.github.icommapi.bizgo.Bizgo;
import io.github.icommapi.bizgo.Environment;
import io.github.icommapi.bizgo.models.SendResult;

try (Bizgo client = Bizgo.builder().environment(Environment.SANDBOX).build()) {
    SendResult result = client.send().sms("01000000000", "01000000000", "[Bizgo] Your code is 123456.");
    System.out.println(result.getMsgKeys());
}

1.2.0 is not compatible with 1.1.x and earlier (net.bizgo.client.BizgoClient).

Node.js SDK

Repository: bizgo-sdk-comm-js · Node.js 18 or later

Bash
npm install @bizgo/bizgo-sdk-comm-js
TypeScript
import { Bizgo, Environment } from '@bizgo/bizgo-sdk-comm-js';

const client = new Bizgo({ environment: Environment.SANDBOX });

const result = await client.send.sms({ to: '01000000000', from: '01000000000', text: '[Bizgo] Your code is 123456.' });
console.log(result.msgKeys);

With CommonJS, use const { Bizgo, Environment } = require('@bizgo/bizgo-sdk-comm-js');. Use the SDK on the server only.

1.2.0 is not compatible with 1.0.x. If you installed with a ^1 range, your next install will pull in 1.2.0, so pin 1.0.3 until you migrate.

Python SDK

Repository: bizgo-sdk-comm-python · Python 3.10 or later

Bash
pip install bizgo-sdk-comm
Python
from bizgo import Bizgo, Environment

with Bizgo(environment=Environment.SANDBOX) as client:
    result = client.send.sms(to="01000000000", from_="01000000000", text="[Bizgo] Your code is 123456.")

print(result.msg_keys)

The async client is AsyncBizgo.

Go SDK

Repository: bizgo-sdk-comm-go · Go 1.26 or later

Bash
go get github.com/icomm-api/bizgo-sdk-comm-go@v1.2.0
Go
import "github.com/icomm-api/bizgo-sdk-comm-go" // package name: bizgo

client, err := bizgo.NewClient(bizgo.WithEnvironment(bizgo.Sandbox))
if err != nil {
    log.Fatal(err)
}
result, err := client.Send.SMS(ctx, bizgo.SMSParams{
    To:   bizgo.To("01000000000"),
    From: "01000000000",
    Text: "[Bizgo] Your code is 123456.",
})
if err != nil {
    log.Fatal(err)
}
fmt.Println(result.MsgKeys())

PHP SDK

Repository: bizgo-sdk-comm-php · PHP 8.2 or later (extensions: curl, json, mbstring)

Bash
composer require icomm-api/bizgo-sdk-comm:^1.2
PHP
use Bizgo\BizgoClient;
use Bizgo\Environment;

$client = new BizgoClient(environment: Environment::Sandbox);

$result = $client->send->sms(to: '01000000000', from: '01000000000', text: '[Bizgo] Your code is 123456.');
$result->msgKeys();

PHP 8.1 and earlier are not supported. If you use the earlier PHP 5 or PHP 7 SDK, see the migration section of the README.

C# SDK

Repository: bizgo-sdk-comm-cs · .NET 8, .NET Standard 2.0 (.NET Framework 4.6.1 or later)

Bash
dotnet add package Bizgo.Sdk.Comm --version 1.2.0
C#
using Bizgo;

using var client = new BizgoClient(new BizgoClientOptions { Environment = BizgoEnvironment.Sandbox });

var result = await client.Send.SmsAsync("01000000000", from: "01000000000", text: "[Bizgo] Your code is 123456.");
Console.WriteLine(string.Join(",", result.MsgKeys));

Unified send request

The SDK's unified send (omni) builds the API request body below. When messageFlow holds several messages, the next one is sent as a fallback if the previous one fails.

JSON
{
  "destinations": [{ "to": "01000000000" }],
  "messageFlow": [
    { "sms": { "from": "01000000000", "text": "SDK test message." } }
  ]
}
  1. Send a single SMS in the sandbox.
  2. Receive reports (polling or webhook, whichever you run in production).
  3. Test a fallback scenario (for example, AlimTalk fails → SMS).