ایران ناتیفیکیشن
ورودشروع رایگان
SDK

Go SDK

Go SDK for the irnoti API — standard library only.

مخزن کددانلودصفحهٔ پروژه
irnoti (Go)

Go Reference tests license

Go SDK for the irnoti API — standard library only.

go get github.com/irnoti/go-sms-panel-api

c := irnoti.New(os.Getenv("IRNOTI_API_KEY")) // WithBaseURL, WithHTTPClient, WithRetries are optional
res, err := c.SMS.Send(ctx, irnoti.SendParams{LineID: "1", To: []string{"09121234567"}, Text: "Hi", IdempotencyKey: "k1"})
var apiErr *irnoti.APIError
if errors.As(err, &apiErr) && apiErr.IsInsufficientBalance() { /* top up */ }

// net/http handler: verify against the raw body
raw, _ := io.ReadAll(r.Body)
ev, err := irnoti.ParseWebhook(raw, r.Header.Get("X-Irnoti-Signature"), secret, 0)

The module path is github.com/irnoti/go-sms-panel-api.

Quickstart

New here? Follow QUICKSTART.md: install, get a key, send your first (free, sandbox) SMS in 5 minutes.

What can this SDK do? (function reference)

Everything hangs off one client. Each row below is a resource, and links to its section in the API docs at irnoti.com/docs (open the docs panel and look for the section named in the "Docs section" column).

Resource Docs section What it is for Functions
c.SMS SMS Send text messages Send (single / bulk / group / scheduled / gradual), Quote (exact price, no send), Pattern (approved OTP/transactional template), SOS (guaranteed delivery with failover)
c.Messages SMS → Messages Look up sent messages List, Get, Check
c.Batches SMS → Batches Control scheduled/gradual sends Scheduled, Cancel, Pause, Resume
c.Lines SMS → Lines Your sender numbers (you need a line id to send) List
c.Wallet Wallet Balance and history Balance, Transactions
c.Phonebook Phonebook Contact groups and contacts Groups, CreateGroup, DeleteGroup, Contacts, AddContacts, ImportCSV, UpdateContact, DeleteContact
c.Services Services Provider products: regional, targeted, peyamap, smart, messenger, voice, international Prices, InternationalRates, List, Quote, Create, Get, Refresh, Cancel
c.LinkTracker Link tracker SMS with tracked links, A/B variants, holdout Send, Holdouts, SendNow, Campaigns, Campaign
c.NumberBanks Number banks Send to purchased/filtered number banks List, Facets, Quote, Send
c.Verify Verify OTP verification sessions (SMS or bot) Info, Create, List, Get, Cancel, Stats
c.Bots Bot builder Read bots, send messages/OTP through them (creating bots is panel-only) Info, List, Get, Stats, Subscribers, Messages, Send, OTP, ShopOrders, ShopStats
c.Broker Telegram broker Run Telegram bots through a private relay List, Get, Create, Rename, ReplaceToken, Rotate, Delete, Request, Updates, Webhook, SetWebhook, DeleteWebhook
c.Voip VoIP Click-to-call Calls, Price, Call

Top-level helpers:

Function What it does
irnoti.New(apiKey, opts...) Create the client
c.WithAPIKey(key) New independent client for another customer key (multi-tenant)
irnoti.VerifyWebhook(raw, signature, secret, 0) true/false: is this webhook really from irnoti?
irnoti.ParseWebhook(raw, signature, secret, 0) Verify and return the decoded event; fails if the signature is bad
*irnoti.APIError Raised/returned on any non-2xx answer; has .Status, .Code, .Details and helpers like .IsInsufficientBalance()

Every function is a thin wrapper over one HTTP endpoint and returns the API's JSON. Every function takes a context.Context first; go doc github.com/irnoti/go-sms-panel-api SMS.Send (or pkg.go.dev) shows exact signatures.

Typical flow: c.Lines.List → c.SMS.Quote → c.SMS.Send (with IdempotencyKey) → c.Messages.Get / webhook. Use an irn_test_… key and line id sandbox while experimenting: nothing is sent or charged.

Telegram broker

bot, _ := c.Broker.Create(ctx, "Shop bot", botFatherToken) // scope broker.write (account owner); returns the relay "link"
c.Broker.Request(ctx, bot["id"].(string), "sendMessage", irnoti.Object{"chat_id": 123, "text": "Hi"}) // scope broker.request
c.Broker.Updates(ctx, bot["id"].(string), irnoti.UpdatesParams{Limit: 20})                            // pull mode
c.Broker.SetWebhook(ctx, bot["id"].(string), irnoti.WebhookParams{URL: "https://example.com/tg", SecretToken: "s3cret"}) // push mode

Behaviour shared by all irnoti SDKs

  • Auth: Authorization: Bearer irn_live_…. Use an irn_test_… key with lineId: "sandbox" to try sends for free. Keys carry scopes (sms.send, sms.read, wallet.read, phonebook.read|write, bot.send|read, broker.read|write|request, verify.send|read); a missing scope is a 403.
  • Money is integer Rial returned as a string ("1960") — never parse it into a float.
  • Idempotency: every send takes an idempotency key; retrying with the same key never sends twice (replayed: true). Automatic retries apply only to GETs and sends that carry a key.
  • Errors: one error type carrying status, the API's machine code (insufficient_balance, invalid_recipients, no_price, … — empty for plain 401/403/404) and details, with helpers such as isInsufficientBalance / isRateLimited / isUnauthenticated.
  • Limits: send 600 req/min, pattern 1200 req/min per IP (429 when exceeded).
  • Webhooks: verify the raw body against X-Irnoti-Signature: t=<unix>,v1=<hex> (HMAC-SHA256 of "<t>.<body>" with your whsec_… key); signatures older than 5 minutes are rejected.
  • Bot-builder creation/configuration and verify settings are panel-only; Telegram broker bots can be managed through the API.

Sibling SDKs: Laravel · Node.js · Python · Go · PHP. API reference: irnoti.com/docs.

MIT licensed.

Go SDK — آزمایشگاه IRNoti | ایران ناتیفیکیشن