team-telnyx/telnyx-verify-go

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Verify - 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.

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

Important Notes

• Phone numbers must be in E.164 format (e.g., +13125550001). Include the + prefix and country code. No spaces, dashes, or parentheses.
• Pagination: Use ListAutoPaging() for automatic iteration: iter := client.Resource.ListAutoPaging(ctx, params); for iter.Next() { item := iter.Current() }.

Lookup phone number data

Returns information about the provided phone number.

GET /number_lookup/{phone_number}

	numberLookup, err := client.NumberLookup.Get(
		context.Background(),
		"+18665552368",
		telnyx.NumberLookupGetParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", numberLookup.Data)

Returns: caller_name (object), carrier (object), country_code (string), fraud (string | null), national_format (string), phone_number (string), portability (object), record_type (string)

List verifications by phone number

GET /verifications/by_phone_number/{phone_number}

	byPhoneNumbers, err := client.Verifications.ByPhoneNumber.List(context.Background(), "+13035551234")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", byPhoneNumbers.Data)

Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall), updated_at (string), verify_profile_id (uuid)

Verify verification code by phone number

POST /verifications/by_phone_number/{phone_number}/actions/verify — Required: code, verify_profile_id

	verifyVerificationCodeResponse, err := client.Verifications.ByPhoneNumber.Actions.Verify(
		context.Background(),
		"+13035551234",
		telnyx.VerificationByPhoneNumberActionVerifyParams{
			Code:            "17686",
			VerifyProfileID: "12ade33a-21c0-473b-b055-b3c836e1c292",
		},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", verifyVerificationCodeResponse.Data)

Returns: phone_number (string), response_code (enum: accepted, rejected)

Trigger Call verification

POST /verifications/call — Required: phone_number, verify_profile_id

Optional: custom_code (string | null), extension (string | null), timeout_secs (integer)

	createVerificationResponse, err := client.Verifications.TriggerCall(context.Background(), telnyx.VerificationTriggerCallParams{
		PhoneNumber:     "+13035551234",
		VerifyProfileID: "12ade33a-21c0-473b-b055-b3c836e1c292",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", createVerificationResponse.Data)

Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall), updated_at (string), verify_profile_id (uuid)

Trigger Flash call verification

POST /verifications/flashcall — Required: phone_number, verify_profile_id

Optional: timeout_secs (integer)

	createVerificationResponse, err := client.Verifications.TriggerFlashcall(context.Background(), telnyx.VerificationTriggerFlashcallParams{
		PhoneNumber:     "+13035551234",
		VerifyProfileID: "12ade33a-21c0-473b-b055-b3c836e1c292",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", createVerificationResponse.Data)

Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall), updated_at (string), verify_profile_id (uuid)

Trigger SMS verification

POST /verifications/sms — Required: phone_number, verify_profile_id

Optional: custom_code (string | null), timeout_secs (integer)

	createVerificationResponse, err := client.Verifications.TriggerSMS(context.Background(), telnyx.VerificationTriggerSMSParams{
		PhoneNumber:     "+13035551234",
		VerifyProfileID: "12ade33a-21c0-473b-b055-b3c836e1c292",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", createVerificationResponse.Data)

Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall), updated_at (string), verify_profile_id (uuid)

Retrieve verification

GET /verifications/{verification_id}

	verification, err := client.Verifications.Get(context.Background(), "12ade33a-21c0-473b-b055-b3c836e1c292")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", verification.Data)

Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall), updated_at (string), verify_profile_id (uuid)

Verify verification code by ID

POST /verifications/{verification_id}/actions/verify

Optional: code (string), status (enum: accepted, rejected)

	verifyVerificationCodeResponse, err := client.Verifications.Actions.Verify(
		context.Background(),
		"12ade33a-21c0-473b-b055-b3c836e1c292",
		telnyx.VerificationActionVerifyParams{
		Code: "12345",
	},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", verifyVerificationCodeResponse.Data)

Returns: phone_number (string), response_code (enum: accepted, rejected)

List all Verify profiles

Gets a paginated list of Verify profiles.

GET /verify_profiles

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

Returns: call (object), created_at (string), flashcall (object), id (uuid), language (string), name (string), rcs (object), record_type (enum: verification_profile), sms (object), updated_at (string), webhook_failover_url (string), webhook_url (string)

Create a Verify profile

Creates a new Verify profile to associate verifications with.

POST /verify_profiles — Required: name

Optional: call (object), flashcall (object), language (string), rcs (object), sms (object), webhook_failover_url (string), webhook_url (string)

	verifyProfileData, err := client.VerifyProfiles.New(context.Background(), telnyx.VerifyProfileNewParams{
		Name: "Test Profile",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", verifyProfileData.Data)

Returns: call (object), created_at (string), flashcall (object), id (uuid), language (string), name (string), rcs (object), record_type (enum: verification_profile), sms (object), updated_at (string), webhook_failover_url (string), webhook_url (string)

Retrieve Verify profile message templates

List all Verify profile message templates.

GET /verify_profiles/templates

	response, err := client.VerifyProfiles.GetTemplates(context.Background())
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)

Returns: id (uuid), text (string)

Create message template

Create a new Verify profile message template.

POST /verify_profiles/templates — Required: text

	messageTemplate, err := client.VerifyProfiles.NewTemplate(context.Background(), telnyx.VerifyProfileNewTemplateParams{
		Text: "Your {{app_name}} verification code is: {{code}}.",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", messageTemplate.Data)

Returns: id (uuid), text (string)

Update message template

Update an existing Verify profile message template.

PATCH /verify_profiles/templates/{template_id} — Required: text

	messageTemplate, err := client.VerifyProfiles.UpdateTemplate(
		context.Background(),
		"12ade33a-21c0-473b-b055-b3c836e1c292",
		telnyx.VerifyProfileUpdateTemplateParams{
			Text: "Your {{app_name}} verification code is: {{code}}.",
		},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", messageTemplate.Data)

Returns: id (uuid), text (string)

Retrieve Verify profile

Gets a single Verify profile.

GET /verify_profiles/{verify_profile_id}

	verifyProfileData, err := client.VerifyProfiles.Get(context.Background(), "12ade33a-21c0-473b-b055-b3c836e1c292")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", verifyProfileData.Data)

Returns: call (object), created_at (string), flashcall (object), id (uuid), language (string), name (string), rcs (object), record_type (enum: verification_profile), sms (object), updated_at (string), webhook_failover_url (string), webhook_url (string)

Update Verify profile

PATCH /verify_profiles/{verify_profile_id}

Optional: call (object), flashcall (object), language (string), name (string), rcs (object), sms (object), webhook_failover_url (string), webhook_url (string)

	verifyProfileData, err := client.VerifyProfiles.Update(
		context.Background(),
		"12ade33a-21c0-473b-b055-b3c836e1c292",
		telnyx.VerifyProfileUpdateParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", verifyProfileData.Data)

Returns: call (object), created_at (string), flashcall (object), id (uuid), language (string), name (string), rcs (object), record_type (enum: verification_profile), sms (object), updated_at (string), webhook_failover_url (string), webhook_url (string)

Delete Verify profile

DELETE /verify_profiles/{verify_profile_id}

	verifyProfileData, err := client.VerifyProfiles.Delete(context.Background(), "12ade33a-21c0-473b-b055-b3c836e1c292")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", verifyProfileData.Data)

Returns: call (object), created_at (string), flashcall (object), id (uuid), language (string), name (string), rcs (object), record_type (enum: verification_profile), sms (object), updated_at (string), webhook_failover_url (string), webhook_url (string)