telnyx-numbers-go

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Telnyx Numbers - Go

Installation

安装

bash

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

bash

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.

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

已按上述方式初始化。

Get country coverage

查询国家覆盖范围

GET /country_coverage

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

GET /country_coverage

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

Get coverage for a specific country

查询特定国家的覆盖范围

GET /country_coverage/countries/{country_code}

	response, err := client.CountryCoverage.GetCountry(context.TODO(), "US")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

GET /country_coverage/countries/{country_code}

	response, err := client.CountryCoverage.GetCountry(context.TODO(), "US")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

Create an inventory coverage request

创建库存覆盖范围请求

Creates an inventory coverage request.

GET /inventory_coverage

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

创建库存覆盖范围请求。

GET /inventory_coverage

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

List number reservations

列出号码预留记录

Gets a paginated list of phone number reservations.

GET /number_reservations

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

获取电话号码预留的分页列表。

GET /number_reservations

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

Create a number reservation

创建号码预留

Creates a Phone Number Reservation for multiple numbers.

POST /number_reservations

Optional:

created_at

(date-time),

customer_reference

(string),

id

(uuid),

phone_numbers

(array[object]),

record_type

(string),

status

(enum),

updated_at

(date-time)

	numberReservation, err := client.NumberReservations.New(context.TODO(), telnyx.NumberReservationNewParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", numberReservation.Data)

为多个号码创建电话号码预留。

POST /number_reservations

可选参数:

created_at

(日期时间),

customer_reference

(字符串),

id

(uuid),

phone_numbers

(对象数组),

record_type

(字符串),

status

(枚举),

updated_at

(日期时间)

	numberReservation, err := client.NumberReservations.New(context.TODO(), telnyx.NumberReservationNewParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", numberReservation.Data)

Retrieve a number reservation

查询号码预留详情

Gets a single phone number reservation.

GET /number_reservations/{number_reservation_id}

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

获取单个电话号码预留信息。

GET /number_reservations/{number_reservation_id}

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

Extend a number reservation

延长号码预留有效期

Extends reservation expiry time on all phone numbers.

POST /number_reservations/{number_reservation_id}/actions/extend

	response, err := client.NumberReservations.Actions.Extend(context.TODO(), "number_reservation_id")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

延长所有电话号码的预留到期时间。

POST /number_reservations/{number_reservation_id}/actions/extend

	response, err := client.NumberReservations.Actions.Extend(context.TODO(), "number_reservation_id")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

List number orders

列出号码订单

Get a paginated list of number orders.

GET /number_orders

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

获取号码订单的分页列表。

GET /number_orders

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

Create a number order

创建号码订单

Creates a phone number order.

POST /number_orders

Optional:

billing_group_id

(string),

connection_id

(string),

customer_reference

(string),

messaging_profile_id

(string),

phone_numbers

(array[object])

	numberOrder, err := client.NumberOrders.New(context.TODO(), telnyx.NumberOrderNewParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", numberOrder.Data)

创建电话号码订单。

POST /number_orders

可选参数:

billing_group_id

(字符串),

connection_id

(字符串),

customer_reference

(字符串),

messaging_profile_id

(字符串),

phone_numbers

(对象数组)

	numberOrder, err := client.NumberOrders.New(context.TODO(), telnyx.NumberOrderNewParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", numberOrder.Data)

Retrieve a number order

查询号码订单详情

Get an existing phone number order.

GET /number_orders/{number_order_id}

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

获取现有电话号码订单信息。

GET /number_orders/{number_order_id}

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

Update a number order

更新号码订单

Updates a phone number order.

PATCH /number_orders/{number_order_id}

Optional:

customer_reference

(string),

regulatory_requirements

(array[object])

	numberOrder, err := client.NumberOrders.Update(
		context.TODO(),
		"number_order_id",
		telnyx.NumberOrderUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", numberOrder.Data)

更新电话号码订单信息。

PATCH /number_orders/{number_order_id}

可选参数:

customer_reference

(字符串),

regulatory_requirements

(对象数组)

	numberOrder, err := client.NumberOrders.Update(
		context.TODO(),
		"number_order_id",
		telnyx.NumberOrderUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", numberOrder.Data)

List number block orders

列出号码批量订单

Get a paginated list of number block orders.

GET /number_block_orders

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

获取号码批量订单的分页列表。

GET /number_block_orders

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

Create a number block order

创建号码批量订单

Creates a phone number block order.

POST /number_block_orders

— Required:

starting_number

range

Optional:

connection_id

(string),

created_at

(date-time),

customer_reference

(string),

errors

(string),

id

(uuid),

messaging_profile_id

(string),

phone_numbers_count

(integer),

record_type

(string),

requirements_met

(boolean),

status

(enum),

updated_at

(date-time)

	numberBlockOrder, err := client.NumberBlockOrders.New(context.TODO(), telnyx.NumberBlockOrderNewParams{
		Range:          10,
		StartingNumber: "+19705555000",
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", numberBlockOrder.Data)

创建电话号码批量订单。

POST /number_block_orders

— 必填参数:

starting_number

range

可选参数:

connection_id

(字符串),

created_at

(日期时间),

customer_reference

(字符串),

errors

(字符串),

id

(uuid),

messaging_profile_id

(字符串),

phone_numbers_count

(整数),

record_type

(字符串),

requirements_met

(布尔值),

status

(枚举),

updated_at

(日期时间)

	numberBlockOrder, err := client.NumberBlockOrders.New(context.TODO(), telnyx.NumberBlockOrderNewParams{
		Range:          10,
		StartingNumber: "+19705555000",
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", numberBlockOrder.Data)

Retrieve a number block order

查询号码批量订单详情

Get an existing phone number block order.

GET /number_block_orders/{number_block_order_id}

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

获取现有电话号码批量订单信息。

GET /number_block_orders/{number_block_order_id}

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

Retrieve a list of phone numbers associated to orders

查询订单关联的电话号码列表

Get a list of phone numbers associated to orders.

GET /number_order_phone_numbers

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

获取与订单关联的电话号码列表。

GET /number_order_phone_numbers

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

Update requirement group for a phone number order

更新电话号码订单的需求组

POST /number_order_phone_numbers/{id}/requirement_group

— Required:

requirement_group_id

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

POST /number_order_phone_numbers/{id}/requirement_group

— 必填参数:

requirement_group_id

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

Retrieve a single phone number within a number order.

查询号码订单中的单个电话号码

Get an existing phone number in number order.

GET /number_order_phone_numbers/{number_order_phone_number_id}

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

获取号码订单中的单个现有电话号码信息。

GET /number_order_phone_numbers/{number_order_phone_number_id}

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

Update requirements for a single phone number within a number order.

更新号码订单中单个电话号码的要求

Updates requirements for a single phone number within a number order.

PATCH /number_order_phone_numbers/{number_order_phone_number_id}

Optional:

regulatory_requirements

(array[object])

	response, err := client.NumberOrderPhoneNumbers.UpdateRequirements(
		context.TODO(),
		"number_order_phone_number_id",
		telnyx.NumberOrderPhoneNumberUpdateRequirementsParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

更新号码订单中单个电话号码的要求信息。

PATCH /number_order_phone_numbers/{number_order_phone_number_id}

可选参数:

regulatory_requirements

(对象数组)

	response, err := client.NumberOrderPhoneNumbers.UpdateRequirements(
		context.TODO(),
		"number_order_phone_number_id",
		telnyx.NumberOrderPhoneNumberUpdateRequirementsParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

List sub number orders

列出子号码订单

Get a paginated list of sub number orders.

GET /sub_number_orders

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

获取子号码订单的分页列表。

GET /sub_number_orders

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

Update requirement group for a sub number order

更新子号码订单的需求组

POST /sub_number_orders/{id}/requirement_group

— Required:

requirement_group_id

	response, err := client.SubNumberOrders.UpdateRequirementGroup(
		context.TODO(),
		"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
		telnyx.SubNumberOrderUpdateRequirementGroupParams{
			RequirementGroupID: "a4b201f9-8646-4e54-a7d2-b2e403eeaf8c",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

POST /sub_number_orders/{id}/requirement_group

— 必填参数:

requirement_group_id

	response, err := client.SubNumberOrders.UpdateRequirementGroup(
		context.TODO(),
		"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
		telnyx.SubNumberOrderUpdateRequirementGroupParams{
			RequirementGroupID: "a4b201f9-8646-4e54-a7d2-b2e403eeaf8c",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

Retrieve a sub number order

查询子号码订单详情

Get an existing sub number order.

GET /sub_number_orders/{sub_number_order_id}

	subNumberOrder, err := client.SubNumberOrders.Get(
		context.TODO(),
		"sub_number_order_id",
		telnyx.SubNumberOrderGetParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", subNumberOrder.Data)

获取现有子号码订单信息。

GET /sub_number_orders/{sub_number_order_id}

	subNumberOrder, err := client.SubNumberOrders.Get(
		context.TODO(),
		"sub_number_order_id",
		telnyx.SubNumberOrderGetParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", subNumberOrder.Data)

Update a sub number order's requirements

更新子号码订单的要求

Updates a sub number order.

PATCH /sub_number_orders/{sub_number_order_id}

Optional:

regulatory_requirements

(array[object])

	subNumberOrder, err := client.SubNumberOrders.Update(
		context.TODO(),
		"sub_number_order_id",
		telnyx.SubNumberOrderUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", subNumberOrder.Data)

更新子号码订单信息。

PATCH /sub_number_orders/{sub_number_order_id}

可选参数:

regulatory_requirements

(对象数组)

	subNumberOrder, err := client.SubNumberOrders.Update(
		context.TODO(),
		"sub_number_order_id",
		telnyx.SubNumberOrderUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", subNumberOrder.Data)

Cancel a sub number order

取消子号码订单

Allows you to cancel a sub number order in 'pending' status.

PATCH /sub_number_orders/{sub_number_order_id}/cancel

	response, err := client.SubNumberOrders.Cancel(context.TODO(), "sub_number_order_id")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

允许取消状态为“pending”的子号码订单。

PATCH /sub_number_orders/{sub_number_order_id}/cancel

	response, err := client.SubNumberOrders.Cancel(context.TODO(), "sub_number_order_id")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

Create a sub number orders report

创建子号码订单报告

Create a CSV report for sub number orders.

POST /sub_number_orders/report

Optional:

country_code

(string),

created_at_gt

(date-time),

created_at_lt

(date-time),

customer_reference

(string),

order_request_id

(uuid),

status

(enum)

	subNumberOrdersReport, err := client.SubNumberOrdersReport.New(context.TODO(), telnyx.SubNumberOrdersReportNewParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", subNumberOrdersReport.Data)

创建子号码订单的CSV报告。

POST /sub_number_orders/report

可选参数:

country_code

(字符串),

created_at_gt

(日期时间),

created_at_lt

(日期时间),

customer_reference

(字符串),

order_request_id

(uuid),

status

(枚举)

	subNumberOrdersReport, err := client.SubNumberOrdersReport.New(context.TODO(), telnyx.SubNumberOrdersReportNewParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", subNumberOrdersReport.Data)

Retrieve a sub number orders report

查询子号码订单报告

Get the status and details of a sub number orders report.

GET /sub_number_orders/report/{report_id}

	subNumberOrdersReport, err := client.SubNumberOrdersReport.Get(context.TODO(), "12ade33a-21c0-473b-b055-b3c836e1c293")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", subNumberOrdersReport.Data)

获取子号码订单报告的状态和详情。

GET /sub_number_orders/report/{report_id}

	subNumberOrdersReport, err := client.SubNumberOrdersReport.Get(context.TODO(), "12ade33a-21c0-473b-b055-b3c836e1c293")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", subNumberOrdersReport.Data)

Download a sub number orders report

下载子号码订单报告

Download the CSV file for a completed sub number orders report.

GET /sub_number_orders/report/{report_id}/download

	response, err := client.SubNumberOrdersReport.Download(context.TODO(), "12ade33a-21c0-473b-b055-b3c836e1c293")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response)

下载已完成的子号码订单报告CSV文件。

GET /sub_number_orders/report/{report_id}/download

	response, err := client.SubNumberOrdersReport.Download(context.TODO(), "12ade33a-21c0-473b-b055-b3c836e1c293")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response)

List Advanced Orders

列出高级订单

GET /advanced_orders

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

GET /advanced_orders

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

Create Advanced Order

创建高级订单

POST /advanced_orders

Optional:

area_code

(string),

comments

(string),

country_code

(string),

customer_reference

(string),

features

(array[object]),

phone_number_type

(enum),

quantity

(integer),

requirement_group_id

(uuid)

	advancedOrder, err := client.AdvancedOrders.New(context.TODO(), telnyx.AdvancedOrderNewParams{
		AdvancedOrder: telnyx.AdvancedOrderParam{},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", advancedOrder.ID)

POST /advanced_orders

可选参数:

area_code

(字符串),

comments

(字符串),

country_code

(字符串),

customer_reference

(字符串),

features

(对象数组),

phone_number_type

(枚举),

quantity

(整数),

requirement_group_id

(uuid)

	advancedOrder, err := client.AdvancedOrders.New(context.TODO(), telnyx.AdvancedOrderNewParams{
		AdvancedOrder: telnyx.AdvancedOrderParam{},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", advancedOrder.ID)

Update Advanced Order

更新高级订单

PATCH /advanced_orders/{advanced-order-id}/requirement_group

Optional:

area_code

(string),

comments

(string),

country_code

(string),

customer_reference

(string),

features

(array[object]),

phone_number_type

(enum),

quantity

(integer),

requirement_group_id

(uuid)

	response, err := client.AdvancedOrders.UpdateRequirementGroup(
		context.TODO(),
		"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
		telnyx.AdvancedOrderUpdateRequirementGroupParams{
			AdvancedOrder: telnyx.AdvancedOrderParam{},
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.ID)

PATCH /advanced_orders/{advanced-order-id}/requirement_group

可选参数:

area_code

(字符串),

comments

(字符串),

country_code

(字符串),

customer_reference

(字符串),

features

(对象数组),

phone_number_type

(枚举),

quantity

(整数),

requirement_group_id

(uuid)

	response, err := client.AdvancedOrders.UpdateRequirementGroup(
		context.TODO(),
		"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
		telnyx.AdvancedOrderUpdateRequirementGroupParams{
			AdvancedOrder: telnyx.AdvancedOrderParam{},
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.ID)

Get Advanced Order

查询高级订单详情

GET /advanced_orders/{order_id}

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

GET /advanced_orders/{order_id}

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

List inexplicit number orders

列出模糊号码订单

Get a paginated list of inexplicit number orders.

GET /inexplicit_number_orders

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

获取模糊号码订单的分页列表。

GET /inexplicit_number_orders

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

Create an inexplicit number order

创建模糊号码订单

Create an inexplicit number order to programmatically purchase phone numbers without specifying exact numbers.

POST /inexplicit_number_orders

— Required:

ordering_groups

Optional:

billing_group_id

(string),

connection_id

(string),

customer_reference

(string),

messaging_profile_id

(string)

	inexplicitNumberOrder, err := client.InexplicitNumberOrders.New(context.TODO(), telnyx.InexplicitNumberOrderNewParams{
		OrderingGroups: []telnyx.InexplicitNumberOrderNewParamsOrderingGroup{{
			CountRequested:  "count_requested",
			CountryISO:      "US",
			PhoneNumberType: "phone_number_type",
		}},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", inexplicitNumberOrder.Data)

创建模糊号码订单，以编程方式购买电话号码而无需指定具体号码。

POST /inexplicit_number_orders

— 必填参数:

ordering_groups

可选参数:

billing_group_id

(字符串),

connection_id

(字符串),

customer_reference

(字符串),

messaging_profile_id

(字符串)

	inexplicitNumberOrder, err := client.InexplicitNumberOrders.New(context.TODO(), telnyx.InexplicitNumberOrderNewParams{
		OrderingGroups: []telnyx.InexplicitNumberOrderNewParamsOrderingGroup{{
			CountRequested:  "count_requested",
			CountryISO:      "US",
			PhoneNumberType: "phone_number_type",
		}},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", inexplicitNumberOrder.Data)

Retrieve an inexplicit number order

查询模糊号码订单详情

Get an existing inexplicit number order by ID.

GET /inexplicit_number_orders/{id}

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

通过ID获取现有模糊号码订单信息。

GET /inexplicit_number_orders/{id}

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

Retrieve all comments

列出所有评论

GET /comments

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

GET /comments

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

Create a comment

创建评论

POST /comments

Optional:

body

(string),

comment_record_id

(uuid),

comment_record_type

(enum),

commenter

(string),

commenter_type

(enum),

created_at

(date-time),

id

(uuid),

read_at

(date-time),

updated_at

(date-time)

	comment, err := client.Comments.New(context.TODO(), telnyx.CommentNewParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", comment.Data)

POST /comments

可选参数:

body

(字符串),

comment_record_id

(uuid),

comment_record_type

(枚举),

commenter

(字符串),

commenter_type

(枚举),

created_at

(日期时间),

id

(uuid),

read_at

(日期时间),

updated_at

(日期时间)

	comment, err := client.Comments.New(context.TODO(), telnyx.CommentNewParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", comment.Data)

Retrieve a comment

查询评论详情

GET /comments/{id}

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

GET /comments/{id}

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

Mark a comment as read

标记评论为已读

PATCH /comments/{id}/read

	response, err := client.Comments.MarkAsRead(context.TODO(), "id")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

PATCH /comments/{id}/read

	response, err := client.Comments.MarkAsRead(context.TODO(), "id")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

List available phone number blocks

列出可用电话号码批量

GET /available_phone_number_blocks

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

GET /available_phone_number_blocks

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

List available phone numbers

列出可用电话号码

GET /available_phone_numbers

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

GET /available_phone_numbers

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

Retrieve the features for a list of numbers

查询号码列表的功能

POST /numbers_features

— Required:

phone_numbers

	numbersFeature, err := client.NumbersFeatures.New(context.TODO(), telnyx.NumbersFeatureNewParams{
		PhoneNumbers: []string{"string"},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", numbersFeature.Data)

POST /numbers_features

— 必填参数:

phone_numbers

	numbersFeature, err := client.NumbersFeatures.New(context.TODO(), telnyx.NumbersFeatureNewParams{
		PhoneNumbers: []string{"string"},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", numbersFeature.Data)

Webhooks

Webhook

The following webhook events are sent to your configured webhook URL. All webhooks include

telnyx-timestamp

and

telnyx-signature-ed25519

headers for verification (Standard Webhooks compatible).

Event	Description
`numberOrderStatusUpdate`	Number Order Status Update

以下Webhook事件将发送到您配置的Webhook URL。所有Webhook均包含

telnyx-timestamp

和

telnyx-signature-ed25519

头部用于验证（兼容标准Webhook）。

事件	描述
`numberOrderStatusUpdate`	号码订单状态更新

Webhook payload fields

Webhook 负载字段

numberOrderStatusUpdate

Field	Type	Description
`data.event_type`	string	The type of event being sent
`data.id`	uuid	Unique identifier for the event
`data.occurred_at`	date-time	ISO 8601 timestamp of when the event occurred
`data.payload.id`	uuid
`data.payload.record_type`	string
`data.payload.phone_numbers_count`	integer	The count of phone numbers in the number order.
`data.payload.connection_id`	string	Identifies the connection associated with this phone number.
`data.payload.messaging_profile_id`	string	Identifies the messaging profile associated with the phone number.
`data.payload.billing_group_id`	string	Identifies the messaging profile associated with the phone number.
`data.payload.phone_numbers`	array[object]
`data.payload.sub_number_orders_ids`	array[string]
`data.payload.status`	enum	The status of the order.
`data.payload.customer_reference`	string	A customer reference string for customer look ups.
`data.payload.created_at`	date-time	An ISO 8901 datetime string denoting when the number order was created.
`data.payload.updated_at`	date-time	An ISO 8901 datetime string for when the number order was updated.
`data.payload.requirements_met`	boolean	True if all requirements are met for every phone number, false otherwise.
`data.record_type`	string	Type of record
`meta.attempt`	integer	Webhook delivery attempt number
`meta.delivered_to`	uri	URL where the webhook was delivered

numberOrderStatusUpdate

字段	类型	描述
`data.event_type`	字符串	发送的事件类型
`data.id`	uuid	事件的唯一标识符
`data.occurred_at`	日期时间	事件发生的ISO 8601时间戳
`data.payload.id`	uuid
`data.payload.record_type`	字符串
`data.payload.phone_numbers_count`	整数	号码订单中的电话号码数量
`data.payload.connection_id`	字符串	与该电话号码关联的连接ID
`data.payload.messaging_profile_id`	字符串	与该电话号码关联的消息配置文件ID
`data.payload.billing_group_id`	字符串	与该电话号码关联的消息配置文件ID
`data.payload.phone_numbers`	对象数组
`data.payload.sub_number_orders_ids`	字符串数组
`data.payload.status`	枚举	订单状态
`data.payload.customer_reference`	字符串	用于客户查询的客户参考字符串
`data.payload.created_at`	日期时间	号码订单创建时间的ISO 8901日期时间字符串
`data.payload.updated_at`	日期时间	号码订单更新时间的ISO 8901日期时间字符串
`data.payload.requirements_met`	布尔值	如果所有电话号码的要求均已满足则为True，否则为False
`data.record_type`	字符串	记录类型
`meta.attempt`	整数	Webhook投递尝试次数
`meta.delivered_to`	uri	Webhook投递的URL