SIPBridge 開発者ドキュメント

x-api-key: sb_live_your_private_key
Content-Type: application/json

Authorization: Bearer sb_live_your_private_key
Content-Type: application/json

curl -X GET https://api.sipbridge.dev/api/v1/status \
  -H "x-api-key: sb_live_your_private_key"

{
  "ok": true,
  "system": {
    "version": "2.4.1",
    "uptime": "up 14 days, 6 hours"
  },
  "stats": {
    "totalCalls": 1248,
    "successRate": 97.8,
    "avgDuration": 142,
    "inboundCalls": 834,
    "outboundCalls": 414
  },
  "numbers": [
    {
      "id": "num_1783006777874",
      "sipUser": "4689****",
      "status": "active",
      "forwardUri": "sip.retellai.com"
    }
  ]
}

curl -X GET https://api.sipbridge.dev/api/v1/numbers \
  -H "x-api-key: sb_live_your_private_key"

{
  "ok": true,
  "numbers": [
    {
      "id": "num_1783006777874",
      "sipUser": "4689****",
      "sipDomain": "softphone.spc.brastel.ne.jp",
      "phoneNumber": "050-0000-0000",
      "forwardUri": "sip.retellai.com",
      "status": "active",
      "createdAt": "2026-06-15T08:30:00Z"
    },
    {
      "id": "num_1783006889012",
      "sipUser": "5243****",
      "sipDomain": "softphone.spc.brastel.ne.jp",
      "phoneNumber": "050-1234-5678",
      "forwardUri": "sip.vapi.ai",
      "status": "active",
      "createdAt": "2026-07-01T12:00:00Z"
    }
  ]
}

curl -X POST https://api.sipbridge.dev/api/v1/numbers \
  -H "x-api-key: sb_live_your_private_key" \
  -H "Content-Type: application/json" \
  -d '{
    "sipUser": "example_sip_user",
    "sipPassword": "your_password",
    "sipDomain": "softphone.spc.brastel.ne.jp",
    "phoneNumber": "050-0000-0000",
    "forwardUri": "sip.retellai.com"
  }'

{
  "ok": true,
  "message": "番号を登録し、プロビジョニングを完了しました",
  "number": {
    "id": "num_1783006777874",
    "sipUser": "exam****",
    "sipDomain": "softphone.spc.brastel.ne.jp",
    "phoneNumber": "050-0000-0000",
    "forwardUri": "sip.retellai.com",
    "status": "active",
    "createdAt": "2026-07-08T10:00:00Z"
  }
}

{
  "ok": false,
  "error": "VALIDATION_ERROR",
  "message": "sipUser は必須フィールドです"
}

{
  "ok": false,
  "error": "DUPLICATE_NUMBER",
  "message": "この電話番号は既に登録されています"
}

curl -X DELETE "https://api.sipbridge.dev/api/v1/numbers?id=num_1783006777874" \
  -H "x-api-key: sb_live_your_private_key"

{
  "ok": true,
  "message": "番号を削除しました",
  "deletedId": "num_1783006777874"
}

curl -X GET https://api.sipbridge.dev/api/user/usage \
  -H "x-api-key: sb_live_your_private_key"

{
  "ok": true,
  "balance": 1840,
  "status": "active",
  "usage": {
    "usedSeconds": 2520,
    "usedMinutes": 42,
    "numbersUsed": 2
  }
}

{
  "ok": false,
  "error": "ERROR_CODE",
  "message": "人間が読めるエラーメッセージ"
}

# パッケージのインストール
npm install -g @sipbridge/cli

# またはリポジトリから直接リンク
cd cli
npm install
npm link

# 環境変数の設定（.bashrc / .zshrc に追加を推奨）
export SIPBRIDGE_API_URL="https://api.sipbridge.dev"
export SIPBRIDGE_API_KEY="sb_live_your_api_key_here"

$ sipbridge status

┌─────────────────────────────────────────┐
│         SIPBridge Status                │
├─────────────────┬───────────────────────┤
│ バージョン       │ 2.4.1                │
│ ステータス       │ ● 稼働中             │
│ 稼働時間        │ 14 days, 6 hours      │
├─────────────────┼───────────────────────┤
│ 総通話数        │ 1,248                  │
│ 成功率          │ 97.8%                  │
│ 平均通話時間     │ 142秒                 │
│ 着信           │ 834                     │
│ 发信           │ 414                     │
├─────────────────┼───────────────────────┤
│ 登録番号        │ 2 (残高: ¥1,840)      │
└─────────────────┴───────────────────────┘

$ sipbridge numbers list

┌──────────────────────┬───────────┬──────────────────┬───────────────────┬──────────┐
│ ID                   │ SIPユーザー │ 電話番号          │ 転送先             │ ステータス │
├──────────────────────┼───────────┼──────────────────┼───────────────────┼──────────┤
│ num_1783006777874    │ 4689****  │ 050-0000-0000    │ sip.retellai.com  │ ● active │
│ num_1783006889012    │ 5243****  │ 050-1234-5678    │ sip.vapi.ai       │ ● active │
└──────────────────────┴───────────┴──────────────────┴───────────────────┴──────────┘

2 番号が登録されています

$ sipbridge numbers add \
    --user "example_sip_user" \
    --domain "softphone.spc.brastel.ne.jp" \
    --phone "050-0000-0000" \
    --forward "sip.retellai.com"

Enter SIP Password: **********

✓ 番号を登録しました
  ID:       num_1783006777874
  番号:     050-0000-0000
  転送先:   sip.retellai.com
  ステータス: active

$ sipbridge numbers remove --id "num_1783006777874"

✓ 番号を削除しました (num_1783006777874)