Telnyx Account – Go

Installation

go get github.com/team-telnyx/telnyx-go

Setup

import (
  "context"
  "fmt"
  "os"

  "github.com/team-telnyx/telnyx-go"
  "github.com/team-telnyx/telnyx-go/option"
)

client := telnyx.NewClient(
  option.WithAPIKey(os.Getenv("TELNYX_API_KEY")),
)

All examples below assume client is already initialized as shown above.

List Audit Logs

Retrieve a list of audit log entries.

GET /audit_events

	page, err := client.AuditEvents.List(context.TODO(), telnyx.AuditEventListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)

Get user balance details

GET /balance

	balance, err := client.Balance.Get(context.TODO())
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", balance.Data)

Search detail records

Search for any detail record across the Telnyx Platform

GET /detail_records

	page, err := client.DetailRecords.List(context.TODO(), telnyx.DetailRecordListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)

List invoices

Retrieve a paginated list of invoices.

GET /invoices

	page, err := client.Invoices.List(context.TODO(), telnyx.InvoiceListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)

Get invoice by ID

Retrieve a single invoice by its unique identifier.

GET /invoices/{id}

	invoice, err := client.Invoices.Get(
		context.TODO(),
		"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
		telnyx.InvoiceGetParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", invoice.Data)

List auto recharge preferences

Returns the payment auto recharge preferences.

GET /payments/auto_recharge_prefs

	autoRechargePrefs, err := client.Payment.AutoRechargePrefs.List(context.TODO())
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", autoRechargePrefs.Data)

Update auto recharge preferences

Update payment auto recharge preferences.

PATCH /payments/auto_recharge_prefs

Optional: enabled (boolean), invoice_enabled (boolean), preference (enum), recharge_amount (string), threshold_amount (string)

	autoRechargePref, err := client.Payment.AutoRechargePrefs.Update(context.TODO(), telnyx.PaymentAutoRechargePrefUpdateParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", autoRechargePref.Data)

List User Tags

List all user tags.

GET /user_tags

	userTags, err := client.UserTags.List(context.TODO(), telnyx.UserTagListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", userTags.Data)

List webhook deliveries

Lists webhook_deliveries for the authenticated user

GET /webhook_deliveries

	page, err := client.WebhookDeliveries.List(context.TODO(), telnyx.WebhookDeliveryListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)

Find webhook_delivery details by ID

Provides webhook_delivery debug data, such as timestamps, delivery status and attempts.

GET /webhook_deliveries/{id}

	webhookDelivery, err := client.WebhookDeliveries.Get(context.TODO(), "C9C0797E-901D-4349-A33C-C2C8F31A92C2")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", webhookDelivery.Data)