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

Telnyx Sip - 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

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

List all Access IP Ranges

GET /accessipranges

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

Returns: cidrblock (string), createdat (date-time), description (string), id (string), status (enum: pending, added), updatedat (date-time), userid (string)

Create new Access IP Range

POST /accessipranges — Required: cidr_block

Optional: description (string)

	accessIPRange, err := client.AccessIPRanges.New(context.Background(), telnyx.AccessIPRangeNewParams{
		CidrBlock: "203.0.113.0/24",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", accessIPRange.ID)

Returns: cidrblock (string), createdat (date-time), description (string), id (string), status (enum: pending, added), updatedat (date-time), userid (string)

Delete access IP ranges

DELETE /accessipranges/{accessiprange_id}

	accessIPRange, err := client.AccessIPRanges.Delete(context.Background(), "access_ip_range_id")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", accessIPRange.ID)

Returns: cidrblock (string), createdat (date-time), description (string), id (string), status (enum: pending, added), updatedat (date-time), userid (string)

List connections

Returns a list of your connections irrespective of type.

GET /connections

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

Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), connectionname (string), createdat (string), id (string), outboundvoiceprofileid (string), recordtype (string), tags (array[string]), updatedat (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookevent_url (uri)

Retrieve a connection

Retrieves the high-level details of an existing connection. To retrieve specific authentication information, use the endpoint for the specific connection type.

GET /connections/{id}

	connection, err := client.Connections.Get(context.Background(), "id")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", connection.Data)

Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), connectionname (string), createdat (string), id (string), outboundvoiceprofileid (string), recordtype (string), tags (array[string]), updatedat (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookevent_url (uri)

List credential connections

Returns a list of your credential connections.

GET /credential_connections

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

Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), sipuricallingpreference (enum: disabled, unrestricted, internal), tags (array[string]), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer | null)

Create a credential connection

Creates a credential connection.

POST /credentialconnections — Required: username, password, connection_name

Optional: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), rtcpsettings (object), sipuricallingpreference (enum: disabled, unrestricted, internal), tags (array[string]), webhookapiversion (enum: 1, 2, texml), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)

	credentialConnection, err := client.CredentialConnections.New(context.Background(), telnyx.CredentialConnectionNewParams{
		ConnectionName: "my name",
		Password:       "my123secure456password789",
		UserName:       "myusername123",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", credentialConnection.Data)

Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), sipuricallingpreference (enum: disabled, unrestricted, internal), tags (array[string]), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer | null)

Retrieve a credential connection

Retrieves the details of an existing credential connection.

GET /credential_connections/{id}

	credentialConnection, err := client.CredentialConnections.Get(context.Background(), "id")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", credentialConnection.Data)

Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), sipuricallingpreference (enum: disabled, unrestricted, internal), tags (array[string]), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer | null)

Update a credential connection

Updates settings of an existing credential connection.

PATCH /credential_connections/{id}

Optional: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), rtcpsettings (object), sipuricallingpreference (enum: disabled, unrestricted, internal), tags (array[string]), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)

	credentialConnection, err := client.CredentialConnections.Update(
		context.Background(),
		"id",
		telnyx.CredentialConnectionUpdateParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", credentialConnection.Data)

Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), sipuricallingpreference (enum: disabled, unrestricted, internal), tags (array[string]), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer | null)

Delete a credential connection

Deletes an existing credential connection.

DELETE /credential_connections/{id}

	credentialConnection, err := client.CredentialConnections.Delete(context.Background(), "id")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", credentialConnection.Data)

Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), sipuricallingpreference (enum: disabled, unrestricted, internal), tags (array[string]), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer | null)

Check a Credential Connection Registration Status

Checks the registrationstatus for a credential connection, (registrationstatus) as well as the timestamp for the last SIP registration event (registrationstatusupdated_at)

POST /credentialconnections/{id}/actions/checkregistration_status

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

Returns: ipaddress (string), lastregistration (string), port (integer), recordtype (string), sipusername (string), status (enum: Not Applicable, Not Registered, Failed, Expired, Registered, Unregistered), transport (string), user_agent (string)

List FQDN connections

Returns a list of your FQDN connections.

GET /fqdn_connections

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

Returns: active (boolean), adjustdtmftimestamp (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostenabled (boolean), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), ignoredtmfduration (boolean), ignoremarkbit (boolean), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), microsoftteamssbc (boolean), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), rtppasscodecsonstreamchange (boolean), sendnormalizedtimestamps (boolean), tags (array[string]), thirdpartycontrolenabled (boolean), transportprotocol (enum: UDP, TCP, TLS), txtname (string), txtttl (integer), txtvalue (string), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)

Create an FQDN connection

Creates a FQDN connection.

POST /fqdnconnections — Required: connectionname

Optional: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), microsoftteamssbc (boolean), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)

	fqdnConnection, err := client.FqdnConnections.New(context.Background(), telnyx.FqdnConnectionNewParams{
		ConnectionName: "my-resource",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", fqdnConnection.Data)

Returns: active (boolean), adjustdtmftimestamp (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostenabled (boolean), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), ignoredtmfduration (boolean), ignoremarkbit (boolean), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), microsoftteamssbc (boolean), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), rtppasscodecsonstreamchange (boolean), sendnormalizedtimestamps (boolean), tags (array[string]), thirdpartycontrolenabled (boolean), transportprotocol (enum: UDP, TCP, TLS), txtname (string), txtttl (integer), txtvalue (string), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)

Retrieve an FQDN connection

Retrieves the details of an existing FQDN connection.

GET /fqdn_connections/{id}

	fqdnConnection, err := client.FqdnConnections.Get(context.Background(), "1293384261075731499")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", fqdnConnection.Data)

Returns: active (boolean), adjustdtmftimestamp (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostenabled (boolean), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), ignoredtmfduration (boolean), ignoremarkbit (boolean), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), microsoftteamssbc (boolean), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), rtppasscodecsonstreamchange (boolean), sendnormalizedtimestamps (boolean), tags (array[string]), thirdpartycontrolenabled (boolean), transportprotocol (enum: UDP, TCP, TLS), txtname (string), txtttl (integer), txtvalue (string), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)

Update an FQDN connection

Updates settings of an existing FQDN connection.

PATCH /fqdn_connections/{id}

Optional: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer | null)

	fqdnConnection, err := client.FqdnConnections.Update(
		context.Background(),
		"1293384261075731499",
		telnyx.FqdnConnectionUpdateParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", fqdnConnection.Data)

Returns: active (boolean), adjustdtmftimestamp (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostenabled (boolean), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), ignoredtmfduration (boolean), ignoremarkbit (boolean), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), microsoftteamssbc (boolean), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), rtppasscodecsonstreamchange (boolean), sendnormalizedtimestamps (boolean), tags (array[string]), thirdpartycontrolenabled (boolean), transportprotocol (enum: UDP, TCP, TLS), txtname (string), txtttl (integer), txtvalue (string), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)

Delete an FQDN connection

Deletes an FQDN connection.

DELETE /fqdn_connections/{id}

	fqdnConnection, err := client.FqdnConnections.Delete(context.Background(), "1293384261075731499")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", fqdnConnection.Data)

Returns: active (boolean), adjustdtmftimestamp (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostenabled (boolean), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), ignoredtmfduration (boolean), ignoremarkbit (boolean), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), microsoftteamssbc (boolean), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), password (string), recordtype (string), rtcpsettings (object), rtppasscodecsonstreamchange (boolean), sendnormalizedtimestamps (boolean), tags (array[string]), thirdpartycontrolenabled (boolean), transportprotocol (enum: UDP, TCP, TLS), txtname (string), txtttl (integer), txtvalue (string), updatedat (string), username (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)

List FQDNs

Get all FQDNs belonging to the user that match the given filters.

GET /fqdns

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

Returns: connectionid (string), createdat (string), dnsrecordtype (string), fqdn (string), id (string), port (integer), recordtype (string), updatedat (string)

Create an FQDN

Create a new FQDN object.

POST /fqdns — Required: fqdn, dnsrecordtype, connection_id

Optional: port (integer | null)

	fqdn, err := client.Fqdns.New(context.Background(), telnyx.FqdnNewParams{
		ConnectionID:  "1516447646313612565",
		DNSRecordType: "a",
		Fqdn:          "example.com",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", fqdn.Data)

Returns: connectionid (string), createdat (string), dnsrecordtype (string), fqdn (string), id (string), port (integer), recordtype (string), updatedat (string)

Retrieve an FQDN

Return the details regarding a specific FQDN.

GET /fqdns/{id}

	fqdn, err := client.Fqdns.Get(context.Background(), "1517907029795014409")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", fqdn.Data)

Returns: connectionid (string), createdat (string), dnsrecordtype (string), fqdn (string), id (string), port (integer), recordtype (string), updatedat (string)

Update an FQDN

Update the details of a specific FQDN.

PATCH /fqdns/{id}

Optional: connectionid (string), dnsrecord_type (string), fqdn (string), port (integer | null)

	fqdn, err := client.Fqdns.Update(
		context.Background(),
		"1517907029795014409",
		telnyx.FqdnUpdateParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", fqdn.Data)

Returns: connectionid (string), createdat (string), dnsrecordtype (string), fqdn (string), id (string), port (integer), recordtype (string), updatedat (string)

Delete an FQDN

Delete an FQDN.

DELETE /fqdns/{id}

	fqdn, err := client.Fqdns.Delete(context.Background(), "1517907029795014409")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", fqdn.Data)

Returns: connectionid (string), createdat (string), dnsrecordtype (string), fqdn (string), id (string), port (integer), recordtype (string), updatedat (string)

List Ip connections

Returns a list of your IP connections.

GET /ip_connections

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

Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), recordtype (string), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), updatedat (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)

Create an Ip connection

Creates an IP connection.

POST /ip_connections

Optional: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer | null)

	ipConnection, err := client.IPConnections.New(context.Background(), telnyx.IPConnectionNewParams{
		ConnectionName: "my-ip-connection",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", ipConnection.Data)

Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), recordtype (string), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), updatedat (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)

Retrieve an Ip connection

Retrieves the details of an existing ip connection.

GET /ip_connections/{id}

	ipConnection, err := client.IPConnections.Get(context.Background(), "id")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", ipConnection.Data)

Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), recordtype (string), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), updatedat (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)

Update an Ip connection

Updates settings of an existing IP connection.

PATCH /ip_connections/{id}

Optional: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer | null)

	ipConnection, err := client.IPConnections.Update(
		context.Background(),
		"id",
		telnyx.IPConnectionUpdateParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", ipConnection.Data)

Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), recordtype (string), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), updatedat (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)

Delete an Ip connection

Deletes an existing IP connection.

DELETE /ip_connections/{id}

	ipConnection, err := client.IPConnections.Delete(context.Background(), "id")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", ipConnection.Data)

Returns: active (boolean), anchorsiteoverride (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), androidpushcredentialid (string | null), callcostinwebhooks (boolean), connectionname (string), createdat (string), defaultonholdcomfortnoiseenabled (boolean), dtmftype (enum: RFC 2833, Inband, SIP INFO), encodecontactheaderenabled (boolean), encryptedmedia (enum: SRTP, None), id (string), inbound (object), iospushcredentialid (string | null), jitterbuffer (object), noisesuppression (enum: inbound, outbound, both, disabled), noisesuppressiondetails (object), onnett38passthroughenabled (boolean), outbound (object), recordtype (string), rtcpsettings (object), tags (array[string]), transportprotocol (enum: UDP, TCP, TLS), updatedat (string), webhookapiversion (enum: 1, 2), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer | null)

List Ips

Get all IPs belonging to the user that match the given filters.

GET /ips

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

Returns: connectionid (string), createdat (string), id (string), ipaddress (string), port (integer), recordtype (string), updated_at (string)

Create an Ip

Create a new IP object.

POST /ips — Required: ip_address

Optional: connection_id (string), port (integer)

	ip, err := client.IPs.New(context.Background(), telnyx.IPNewParams{
		IPAddress: "192.168.0.0",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", ip.Data)

Returns: connectionid (string), createdat (string), id (string), ipaddress (string), port (integer), recordtype (string), updated_at (string)

Retrieve an Ip

Return the details regarding a specific IP.

GET /ips/{id}

	ip, err := client.IPs.Get(context.Background(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", ip.Data)

Returns: connectionid (string), createdat (string), id (string), ipaddress (string), port (integer), recordtype (string), updated_at (string)

Update an Ip

Update the details of a specific IP.

PATCH /ips/{id} — Required: ip_address

Optional: connection_id (string), port (integer)

	ip, err := client.IPs.Update(
		context.Background(),
		"6a09cdc3-8948-47f0-aa62-74ac943d6c58",
		telnyx.IPUpdateParams{
			IPAddress: "192.168.0.0",
		},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", ip.Data)

Returns: connectionid (string), createdat (string), id (string), ipaddress (string), port (integer), recordtype (string), updated_at (string)

Delete an Ip

Delete an IP.

DELETE /ips/{id}

	ip, err := client.IPs.Delete(context.Background(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", ip.Data)

Returns: connectionid (string), createdat (string), id (string), ipaddress (string), port (integer), recordtype (string), updated_at (string)

Get all outbound voice profiles

Get all outbound voice profiles belonging to the user that match the given filters.

GET /outboundvoiceprofiles

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

Returns: billinggroupid (uuid), callrecording (object), callingwindow (object), concurrentcalllimit (integer | null), connectionscount (integer), createdat (string), dailyspendlimit (string), dailyspendlimitenabled (boolean), enabled (boolean), id (string), maxdestinationrate (number), name (string), recordtype (string), serviceplan (enum: global), tags (array[string]), traffictype (enum: conversational), updatedat (string), usagepaymentmethod (enum: rate-deck), whitelisteddestinations (array[string])

Create an outbound voice profile

Create an outbound voice profile.

POST /outboundvoiceprofiles — Required: name

Optional: billinggroupid (uuid), callrecording (object), callingwindow (object), concurrentcalllimit (integer | null), dailyspendlimit (string), dailyspendlimitenabled (boolean), enabled (boolean), maxdestinationrate (number), serviceplan (enum: global), tags (array[string]), traffictype (enum: conversational), usagepaymentmethod (enum: rate-deck), whitelisteddestinations (array[string])

	outboundVoiceProfile, err := client.OutboundVoiceProfiles.New(context.Background(), telnyx.OutboundVoiceProfileNewParams{
		Name: "office",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", outboundVoiceProfile.Data)

Returns: billinggroupid (uuid), callrecording (object), callingwindow (object), concurrentcalllimit (integer | null), connectionscount (integer), createdat (string), dailyspendlimit (string), dailyspendlimitenabled (boolean), enabled (boolean), id (string), maxdestinationrate (number), name (string), recordtype (string), serviceplan (enum: global), tags (array[string]), traffictype (enum: conversational), updatedat (string), usagepaymentmethod (enum: rate-deck), whitelisteddestinations (array[string])

Retrieve an outbound voice profile

Retrieves the details of an existing outbound voice profile.

GET /outboundvoiceprofiles/{id}

	outboundVoiceProfile, err := client.OutboundVoiceProfiles.Get(context.Background(), "1293384261075731499")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", outboundVoiceProfile.Data)

Returns: billinggroupid (uuid), callrecording (object), callingwindow (object), concurrentcalllimit (integer | null), connectionscount (integer), createdat (string), dailyspendlimit (string), dailyspendlimitenabled (boolean), enabled (boolean), id (string), maxdestinationrate (number), name (string), recordtype (string), serviceplan (enum: global), tags (array[string]), traffictype (enum: conversational), updatedat (string), usagepaymentmethod (enum: rate-deck), whitelisteddestinations (array[string])

Updates an existing outbound voice profile.

PATCH /outboundvoiceprofiles/{id} — Required: name

Optional: billinggroupid (uuid), callrecording (object), callingwindow (object), concurrentcalllimit (integer | null), dailyspendlimit (string), dailyspendlimitenabled (boolean), enabled (boolean), maxdestinationrate (number), serviceplan (enum: global), tags (array[string]), traffictype (enum: conversational), usagepaymentmethod (enum: rate-deck), whitelisteddestinations (array[string])

	outboundVoiceProfile, err := client.OutboundVoiceProfiles.Update(
		context.Background(),
		"1293384261075731499",
		telnyx.OutboundVoiceProfileUpdateParams{
			Name: "office",
		},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", outboundVoiceProfile.Data)

Returns: billinggroupid (uuid), callrecording (object), callingwindow (object), concurrentcalllimit (integer | null), connectionscount (integer), createdat (string), dailyspendlimit (string), dailyspendlimitenabled (boolean), enabled (boolean), id (string), maxdestinationrate (number), name (string), recordtype (string), serviceplan (enum: global), tags (array[string]), traffictype (enum: conversational), updatedat (string), usagepaymentmethod (enum: rate-deck), whitelisteddestinations (array[string])

Delete an outbound voice profile

Deletes an existing outbound voice profile.

DELETE /outboundvoiceprofiles/{id}

	outboundVoiceProfile, err := client.OutboundVoiceProfiles.Delete(context.Background(), "1293384261075731499")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", outboundVoiceProfile.Data)

Returns: billinggroupid (uuid), callrecording (object), callingwindow (object), concurrentcalllimit (integer | null), connectionscount (integer), createdat (string), dailyspendlimit (string), dailyspendlimitenabled (boolean), enabled (boolean), id (string), maxdestinationrate (number), name (string), recordtype (string), serviceplan (enum: global), tags (array[string]), traffictype (enum: conversational), updatedat (string), usagepaymentmethod (enum: rate-deck), whitelisteddestinations (array[string])