Telnyx Porting Out - 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")),
  option.WithPublicKey(os.Getenv("TELNYX_PUBLIC_KEY")), // Required for client.Webhooks.Unwrap (webhook verification)
)

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

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:

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, then retry the request (bounded 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")
  }
  return err // Propagate: a failed request must never look like success to the caller
}

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).

Important Notes

Pagination: Use ListAutoPaging() for automatic iteration: iter := client.Resource.ListAutoPaging(ctx, params); for iter.Next() { item := iter.Current() }.

List portout requests

Returns the portout requests according to filters

GET /portouts

    page, err := client.Portouts.List(context.Background(), telnyx.PortoutListParams{})
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%+v\n", page)

Returns: already_ported (boolean), authorized_name (string), carrier_name (string), city (string), created_at (string), current_carrier (string), end_user_name (string), foc_date (string), host_messaging (boolean), id (string), inserted_at (string), lsr (array[string]), phone_numbers (array[string]), pon (string), reason (string | null), record_type (string), rejection_code (integer), requested_foc_date (string), service_address (string), spid (string), state (string), status (enum: pending, authorized, ported, rejected, rejected-pending, canceled), support_key (string), updated_at (string), user_id (uuid), vendor (uuid), zip (string)

List all port-out events

Returns a paginated list of port-out events on your account, such as status changes on port-out requests, with support for filtering.

GET /portouts/events

    page, err := client.Portouts.Events.List(context.Background(), telnyx.PortoutEventListParams{})
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%+v\n", page)

Returns: available_notification_methods (array[string]), created_at (date-time), event_type (enum: portout.status_changed, portout.foc_date_changed, portout.new_comment), id (uuid), payload (object), payload_status (enum: created, completed), portout_id (uuid), record_type (string), updated_at (date-time)

Show a port-out event

Returns the details of a single port-out event, including its type and payload.

GET /portouts/events/{id}

    event, err := client.Portouts.Events.Get(context.Background(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%+v\n", event.Data)

Republish a port-out event

Republishes the specified port-out event, triggering re-delivery of the corresponding webhook to your account.

POST /portouts/events/{id}/republish

    err := client.Portouts.Events.Republish(context.Background(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    if err != nil {
        log.Fatal(err)
    }

List eligible port-out rejection codes for a specific order

Given a port-out ID, list rejection codes that are eligible for that port-out

GET /portouts/rejections/{portout_id}

    response, err := client.Portouts.ListRejectionCodes(
        context.Background(),
        "329d6658-8f93-405d-862f-648776e8afd7",
        telnyx.PortoutListRejectionCodesParams{},
    )
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%+v\n", response.Data)

Returns: code (integer), description (string), reason_required (boolean)

List port-out related reports

List the reports generated about port-out operations.

GET /portouts/reports

    page, err := client.Portouts.Reports.List(context.Background(), telnyx.PortoutReportListParams{})
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%+v\n", page)

Returns: created_at (date-time), document_id (uuid), id (uuid), params (object), record_type (string), report_type (enum: export_portouts_csv), status (enum: pending, completed), updated_at (date-time)

Create a port-out related report

Generate reports about port-out operations.

POST /portouts/reports

    report, err := client.Portouts.Reports.New(context.Background(), telnyx.PortoutReportNewParams{
        Params: telnyx.ExportPortoutsCsvReportParam{
            Filters: telnyx.ExportPortoutsCsvReportFiltersParam{},
        },
        ReportType: telnyx.PortoutReportNewParamsReportTypeExportPortoutsCsv,
    })
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%+v\n", report.Data)

Retrieve a report

Returns the details of a previously requested port-out report, including its status and parameters.

GET /portouts/reports/{id}

    report, err := client.Portouts.Reports.Get(context.Background(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%+v\n", report.Data)

Get a portout request

Returns the portout request based on the ID provided

GET /portouts/{id}

    portout, err := client.Portouts.Get(context.Background(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%+v\n", portout.Data)

List all comments for a portout request

Returns a list of comments for a portout request.

GET /portouts/{id}/comments

    comments, err := client.Portouts.Comments.List(context.Background(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%+v\n", comments.Data)

Returns: body (string), created_at (string), id (string), portout_id (string), record_type (string), user_id (string)

Create a comment on a portout request

Creates a comment on the specified port-out request and returns the created comment.

POST /portouts/{id}/comments

Optional: body (string)

    comment, err := client.Portouts.Comments.New(
        context.Background(),
        "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        telnyx.PortoutCommentNewParams{},
    )
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%+v\n", comment.Data)

Returns: body (string), created_at (string), id (string), portout_id (string), record_type (string), user_id (string)

List supporting documents on a portout request

List every supporting documents for a portout request.

GET /portouts/{id}/supporting_documents

    supportingDocuments, err := client.Portouts.SupportingDocuments.List(context.Background(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%+v\n", supportingDocuments.Data)

Returns: created_at (string), document_id (uuid), id (uuid), portout_id (uuid), record_type (string), type (enum: loa, invoice), updated_at (string)

Create a list of supporting documents on a portout request

Creates a list of supporting documents on a portout request.

POST /portouts/{id}/supporting_documents

Optional: documents (array[object])

    supportingDocument, err := client.Portouts.SupportingDocuments.New(
        context.Background(),
        "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        telnyx.PortoutSupportingDocumentNewParams{},
    )
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%+v\n", supportingDocument.Data)

Returns: created_at (string), document_id (uuid), id (uuid), portout_id (uuid), record_type (string), type (enum: loa, invoice), updated_at (string)

Update Status

Updates the status of the specified port-out request, using the status path segment to authorize or reject the port-out.

PATCH /portouts/{id}/{status} — Required: reason

Optional: host_messaging (boolean)

    response, err := client.Portouts.UpdateStatus(
        context.Background(),
        telnyx.PortoutUpdateStatusParamsStatusAuthorized,
        telnyx.PortoutUpdateStatusParams{
            ID:     "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            Reason: "I do not recognize this transaction",
        },
    )
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%+v\n", response.Data)

telnyx-porting-out-go

Files1

SKILL.mdskills/telnyx-porting-out-go/SKILL.md