Back to Details

telnyx-account-management-go

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
<!-- 由Telnyx OpenAPI规范自动生成，请勿编辑。 -->

Telnyx Account Management - Go

Telnyx 账号管理 - Go

Installation

安装

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

Setup

配置

go
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.
go
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")),
)
以下所有示例均假设
client
已按照上述方式完成初始化。

Error Handling

错误处理

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:
go
import "errors"

result, err := client.Messages.Send(ctx, params)
if err != nil {
  var apiErr *telnyx.Error
  if errors.As(err, &apiErr) {
    switch apiErr.StatusCode {
    case 422:
      fmt.Println("Validation error — check required fields and formats")
    case 429:
      // Rate limited — wait and retry with exponential backoff
      fmt.Println("Rate limited, retrying...")
    default:
      fmt.Printf("API error %d: %s\n", apiErr.StatusCode, apiErr.Error())
    }
  } else {
    fmt.Println("Network error — check connectivity and retry")
  }
}
Common error codes: 
401
invalid API key, 
403
insufficient permissions, 
404
resource not found, 
422
validation error (check field formats), 
429
rate limited (retry with exponential backoff).
所有API调用都可能因网络错误、速率限制(429)、校验错误(422)或认证错误(401)失败。在生产代码中请务必做好错误处理：
go
import "errors"

result, err := client.Messages.Send(ctx, params)
if err != nil {
  var apiErr *telnyx.Error
  if errors.As(err, &apiErr) {
    switch apiErr.StatusCode {
    case 422:
      fmt.Println("校验错误——请检查必填字段和格式")
    case 429:
      // 触发速率限制——请等待并使用指数退避策略重试
      fmt.Println("触发速率限制，正在重试...")
    default:
      fmt.Printf("API错误 %d: %s\n", apiErr.StatusCode, apiErr.Error())
    }
  } else {
    fmt.Println("网络错误——请检查网络连接并重试")
  }
}
常见错误码：
401
API密钥无效，
403
权限不足，
404
资源不存在，
422
校验错误（请检查字段格式），
429
触发速率限制（使用指数退避策略重试）。

Important Notes

重要注意事项

  • Pagination: Use 
    ListAutoPaging()
    for automatic iteration: 
    iter := client.Resource.ListAutoPaging(ctx, params); for iter.Next() { item := iter.Current() }
    .
  • 分页： 使用
    ListAutoPaging()
    实现自动遍历：
    iter := client.Resource.ListAutoPaging(ctx, params); for iter.Next() { item := iter.Current() }
    。

Lists accounts managed by the current user.

列出当前用户管理的账号

Lists the accounts managed by the current user. Users need to be explictly approved by Telnyx in order to become manager accounts.
GET /managed_accounts
go
	page, err := client.ManagedAccounts.List(context.Background(), telnyx.ManagedAccountListParams{})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", page)
Returns: 
api_user
(string), 
created_at
(string), 
email
(email), 
id
(uuid), 
managed_account_allow_custom_pricing
(boolean), 
manager_account_id
(string), 
organization_name
(string), 
record_type
(enum: managed_account), 
rollup_billing
(boolean), 
updated_at
(string)
列出当前用户管理的所有账号。用户需要获得Telnyx的明确批准才能成为管理账号。
GET /managed_accounts
go
	page, err := client.ManagedAccounts.List(context.Background(), telnyx.ManagedAccountListParams{})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", page)
返回参数：
api_user
(字符串)、
created_at
(字符串)、
email
(邮箱)、
id
(uuid)、
managed_account_allow_custom_pricing
(布尔值)、
manager_account_id
(字符串)、
organization_name
(字符串)、
record_type
(枚举值：managed_account)、
rollup_billing
(布尔值)、
updated_at
(字符串)

Create a new managed account.

创建新的托管账号

Create a new managed account owned by the authenticated user. You need to be explictly approved by Telnyx in order to become a manager account.
POST /managed_accounts
— Required: 
business_name
Optional: 
email
(string), 
managed_account_allow_custom_pricing
(boolean), 
password
(string), 
rollup_billing
(boolean)
go
	managedAccount, err := client.ManagedAccounts.New(context.Background(), telnyx.ManagedAccountNewParams{
		BusinessName: "Larry's Cat Food Inc",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", managedAccount.Data)
Returns: 
api_key
(string), 
api_token
(string), 
api_user
(string), 
balance
(object), 
created_at
(string), 
email
(email), 
id
(uuid), 
managed_account_allow_custom_pricing
(boolean), 
manager_account_id
(string), 
organization_name
(string), 
record_type
(enum: managed_account), 
rollup_billing
(boolean), 
updated_at
(string)
创建一个归当前认证用户所有的新托管账号。你需要获得Telnyx的明确批准才能成为管理账号。
POST /managed_accounts
—— 必填参数：
business_name
可选参数：
email
(字符串)、
managed_account_allow_custom_pricing
(布尔值)、
password
(字符串)、
rollup_billing
(布尔值)
go
	managedAccount, err := client.ManagedAccounts.New(context.Background(), telnyx.ManagedAccountNewParams{
		BusinessName: "Larry's Cat Food Inc",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", managedAccount.Data)
返回参数：
api_key
(字符串)、
api_token
(字符串)、
api_user
(字符串)、
balance
(对象)、
created_at
(字符串)、
email
(邮箱)、
id
(uuid)、
managed_account_allow_custom_pricing
(布尔值)、
manager_account_id
(字符串)、
organization_name
(字符串)、
record_type
(枚举值：managed_account)、
rollup_billing
(布尔值)、
updated_at
(字符串)

Display information about allocatable global outbound channels for the current user.

查询当前用户可分配的全局外呼通道信息

Display information about allocatable global outbound channels for the current user. Only usable by account managers.
GET /managed_accounts/allocatable_global_outbound_channels
go
	response, err := client.ManagedAccounts.GetAllocatableGlobalOutboundChannels(context.Background())
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)
Returns: 
allocatable_global_outbound_channels
(integer), 
managed_account_allow_custom_pricing
(boolean), 
record_type
(string), 
total_global_channels_allocated
(integer)
查询当前用户可分配的全局外呼通道信息，仅管理账号可使用。
GET /managed_accounts/allocatable_global_outbound_channels
go
	response, err := client.ManagedAccounts.GetAllocatableGlobalOutboundChannels(context.Background())
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)
返回参数：
allocatable_global_outbound_channels
(整数)、
managed_account_allow_custom_pricing
(布尔值)、
record_type
(字符串)、
total_global_channels_allocated
(整数)

Retrieve a managed account

获取单个托管账号信息

Retrieves the details of a single managed account.
GET /managed_accounts/{id}
go
	managedAccount, err := client.ManagedAccounts.Get(context.Background(), "id")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", managedAccount.Data)
Returns: 
api_key
(string), 
api_token
(string), 
api_user
(string), 
balance
(object), 
created_at
(string), 
email
(email), 
id
(uuid), 
managed_account_allow_custom_pricing
(boolean), 
manager_account_id
(string), 
organization_name
(string), 
record_type
(enum: managed_account), 
rollup_billing
(boolean), 
updated_at
(string)
获取单个托管账号的详细信息。
GET /managed_accounts/{id}
go
	managedAccount, err := client.ManagedAccounts.Get(context.Background(), "id")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", managedAccount.Data)
返回参数：
api_key
(字符串)、
api_token
(字符串)、
api_user
(字符串)、
balance
(对象)、
created_at
(字符串)、
email
(邮箱)、
id
(uuid)、
managed_account_allow_custom_pricing
(布尔值)、
manager_account_id
(字符串)、
organization_name
(字符串)、
record_type
(枚举值：managed_account)、
rollup_billing
(布尔值)、
updated_at
(字符串)

Update a managed account

更新托管账号

Update a single managed account.
PATCH /managed_accounts/{id}
Optional: 
managed_account_allow_custom_pricing
(boolean)
go
	managedAccount, err := client.ManagedAccounts.Update(
		context.Background(),
		"id",
		telnyx.ManagedAccountUpdateParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", managedAccount.Data)
Returns: 
api_key
(string), 
api_token
(string), 
api_user
(string), 
balance
(object), 
created_at
(string), 
email
(email), 
id
(uuid), 
managed_account_allow_custom_pricing
(boolean), 
manager_account_id
(string), 
organization_name
(string), 
record_type
(enum: managed_account), 
rollup_billing
(boolean), 
updated_at
(string)
更新单个托管账号的信息。
PATCH /managed_accounts/{id}
可选参数：
managed_account_allow_custom_pricing
(布尔值)
go
	managedAccount, err := client.ManagedAccounts.Update(
		context.Background(),
		"id",
		telnyx.ManagedAccountUpdateParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", managedAccount.Data)
返回参数：
api_key
(字符串)、
api_token
(字符串)、
api_user
(字符串)、
balance
(对象)、
created_at
(字符串)、
email
(邮箱)、
id
(uuid)、
managed_account_allow_custom_pricing
(布尔值)、
manager_account_id
(字符串)、
organization_name
(字符串)、
record_type
(枚举值：managed_account)、
rollup_billing
(布尔值)、
updated_at
(字符串)

Disables a managed account

禁用托管账号

Disables a managed account, forbidding it to use Telnyx services, including sending or receiving phone calls and SMS messages. Ongoing phone calls will not be affected. The managed account and its sub-users will no longer be able to log in via the mission control portal.
POST /managed_accounts/{id}/actions/disable
go
	response, err := client.ManagedAccounts.Actions.Disable(context.Background(), "id")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)
Returns: 
api_key
(string), 
api_token
(string), 
api_user
(string), 
balance
(object), 
created_at
(string), 
email
(email), 
id
(uuid), 
managed_account_allow_custom_pricing
(boolean), 
manager_account_id
(string), 
organization_name
(string), 
record_type
(enum: managed_account), 
rollup_billing
(boolean), 
updated_at
(string)
禁用托管账号，禁止其使用Telnyx服务，包括拨打/接听电话和发送/接收短信。正在进行的通话不会受到影响。该托管账号及其子用户将无法再通过任务控制门户登录。
POST /managed_accounts/{id}/actions/disable
go
	response, err := client.ManagedAccounts.Actions.Disable(context.Background(), "id")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)
返回参数：
api_key
(字符串)、
api_token
(字符串)、
api_user
(字符串)、
balance
(对象)、
created_at
(字符串)、
email
(邮箱)、
id
(uuid)、
managed_account_allow_custom_pricing
(布尔值)、
manager_account_id
(字符串)、
organization_name
(字符串)、
record_type
(枚举值：managed_account)、
rollup_billing
(布尔值)、
updated_at
(字符串)

Enables a managed account

启用托管账号

Enables a managed account and its sub-users to use Telnyx services.
POST /managed_accounts/{id}/actions/enable
Optional: 
reenable_all_connections
(boolean)
go
	response, err := client.ManagedAccounts.Actions.Enable(
		context.Background(),
		"id",
		telnyx.ManagedAccountActionEnableParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)
Returns: 
api_key
(string), 
api_token
(string), 
api_user
(string), 
balance
(object), 
created_at
(string), 
email
(email), 
id
(uuid), 
managed_account_allow_custom_pricing
(boolean), 
manager_account_id
(string), 
organization_name
(string), 
record_type
(enum: managed_account), 
rollup_billing
(boolean), 
updated_at
(string)
启用托管账号及其子用户的Telnyx服务访问权限。
POST /managed_accounts/{id}/actions/enable
可选参数：
reenable_all_connections
(布尔值)
go
	response, err := client.ManagedAccounts.Actions.Enable(
		context.Background(),
		"id",
		telnyx.ManagedAccountActionEnableParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)
返回参数：
api_key
(字符串)、
api_token
(字符串)、
api_user
(字符串)、
balance
(对象)、
created_at
(字符串)、
email
(邮箱)、
id
(uuid)、
managed_account_allow_custom_pricing
(布尔值)、
manager_account_id
(字符串)、
organization_name
(字符串)、
record_type
(枚举值：managed_account)、
rollup_billing
(布尔值)、
updated_at
(字符串)

Update the amount of allocatable global outbound channels allocated to a specific managed account.

更新指定托管账号的可分配全局外呼通道配额

PATCH /managed_accounts/{id}/update_global_channel_limit
Optional: 
channel_limit
(integer)
go
	response, err := client.ManagedAccounts.UpdateGlobalChannelLimit(
		context.Background(),
		"id",
		telnyx.ManagedAccountUpdateGlobalChannelLimitParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)
Returns: 
channel_limit
(integer), 
email
(string), 
id
(string), 
manager_account_id
(string), 
record_type
(string)
PATCH /managed_accounts/{id}/update_global_channel_limit
可选参数：
channel_limit
(整数)
go
	response, err := client.ManagedAccounts.UpdateGlobalChannelLimit(
		context.Background(),
		"id",
		telnyx.ManagedAccountUpdateGlobalChannelLimitParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)
返回参数：
channel_limit
(整数)、
email
(字符串)、
id
(字符串)、
manager_account_id
(字符串)、
record_type
(字符串)

List organization users

列出组织用户

Returns a list of the users in your organization.
GET /organizations/users
go
	page, err := client.Organizations.Users.List(context.Background(), telnyx.OrganizationUserListParams{})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", page)
Returns: 
created_at
(string), 
email
(email), 
groups
(array[object]), 
id
(string), 
last_sign_in_at
(string | null), 
organization_user_bypasses_sso
(boolean), 
record_type
(string), 
user_status
(enum: enabled, disabled, blocked)
返回你的组织下的所有用户列表。
GET /organizations/users
go
	page, err := client.Organizations.Users.List(context.Background(), telnyx.OrganizationUserListParams{})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", page)
返回参数：
created_at
(字符串)、
email
(邮箱)、
groups
(对象数组)、
id
(字符串)、
last_sign_in_at
(字符串 | 空)、
organization_user_bypasses_sso
(布尔值)、
record_type
(字符串)、
user_status
(枚举值：enabled, disabled, blocked)

Get organization users groups report

获取组织用户组报告

Returns a report of all users in your organization with their group memberships. This endpoint returns all users without pagination and always includes group information. The report can be retrieved in JSON or CSV format by sending specific content-type headers.
GET /organizations/users/users_groups_report
go
	response, err := client.Organizations.Users.GetGroupsReport(context.Background(), telnyx.OrganizationUserGetGroupsReportParams{})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)
Returns: 
created_at
(string), 
email
(email), 
groups
(array[object]), 
id
(string), 
last_sign_in_at
(string | null), 
organization_user_bypasses_sso
(boolean), 
record_type
(string), 
user_status
(enum: enabled, disabled, blocked)
返回组织内所有用户及其所属用户组的报告。该接口返回所有用户无需分页，且始终包含用户组信息。你可以通过指定content-type请求头来获取JSON或CSV格式的报告。
GET /organizations/users/users_groups_report
go
	response, err := client.Organizations.Users.GetGroupsReport(context.Background(), telnyx.OrganizationUserGetGroupsReportParams{})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)
返回参数：
created_at
(字符串)、
email
(邮箱)、
groups
(对象数组)、
id
(字符串)、
last_sign_in_at
(字符串 | 空)、
organization_user_bypasses_sso
(布尔值)、
record_type
(字符串)、
user_status
(枚举值：enabled, disabled, blocked)

Get organization user

获取单个组织用户信息

Returns a user in your organization.
GET /organizations/users/{id}
go
	user, err := client.Organizations.Users.Get(
		context.Background(),
		"id",
		telnyx.OrganizationUserGetParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", user.Data)
Returns: 
created_at
(string), 
email
(email), 
groups
(array[object]), 
id
(string), 
last_sign_in_at
(string | null), 
organization_user_bypasses_sso
(boolean), 
record_type
(string), 
user_status
(enum: enabled, disabled, blocked)
返回你组织内的单个用户信息。
GET /organizations/users/{id}
go
	user, err := client.Organizations.Users.Get(
		context.Background(),
		"id",
		telnyx.OrganizationUserGetParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", user.Data)
返回参数：
created_at
(字符串)、
email
(邮箱)、
groups
(对象数组)、
id
(字符串)、
last_sign_in_at
(字符串 | 空)、
organization_user_bypasses_sso
(布尔值)、
record_type
(字符串)、
user_status
(枚举值：enabled, disabled, blocked)

Delete organization user

删除组织用户

Deletes a user in your organization.
POST /organizations/users/{id}/actions/remove
go
	action, err := client.Organizations.Users.Actions.Remove(context.Background(), "id")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", action.Data)
Returns: 
created_at
(string), 
email
(email), 
groups
(array[object]), 
id
(string), 
last_sign_in_at
(string | null), 
organization_user_bypasses_sso
(boolean), 
record_type
(string), 
user_status
(enum: enabled, disabled, blocked)
删除你组织内的指定用户。
POST /organizations/users/{id}/actions/remove
go
	action, err := client.Organizations.Users.Actions.Remove(context.Background(), "id")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", action.Data)
返回参数：
created_at
(字符串)、
email
(邮箱)、
groups
(对象数组)、
id
(字符串)、
last_sign_in_at
(字符串 | 空)、
organization_user_bypasses_sso
(布尔值)、
record_type
(字符串)、
user_status
(枚举值：enabled, disabled, blocked)