Telnyx Voice – 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.

Answer call

Answer an incoming call.

POST /calls/{call_control_id}/actions/answer

Optional: billing_group_id (uuid), client_state (string), command_id (string), custom_headers (array[object]), preferred_codecs (enum), record (enum), record_channels (enum), record_custom_file_name (string), record_format (enum), record_max_length (int32), record_timeout_secs (int32), record_track (enum), record_trim (enum), send_silence_when_idle (boolean), sip_headers (array[object]), sound_modifications (object), stream_bidirectional_codec (enum), stream_bidirectional_mode (enum), stream_bidirectional_target_legs (enum), stream_codec (enum), stream_track (enum), stream_url (string), transcription (boolean), transcription_config (object), webhook_url (string), webhook_url_method (enum)

	response, err := client.Calls.Actions.Answer(
		context.TODO(),
		"call_control_id",
		telnyx.CallActionAnswerParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

Bridge calls

Bridge two call control calls.

POST /calls/{call_control_id}/actions/bridge — Required: call_control_id

Optional: client_state (string), command_id (string), mute_dtmf (enum), park_after_unbridge (string), play_ringtone (boolean), queue (string), record (enum), record_channels (enum), record_custom_file_name (string), record_format (enum), record_max_length (int32), record_timeout_secs (int32), record_track (enum), record_trim (enum), ringtone (enum), video_room_context (string), video_room_id (uuid)

	response, err := client.Calls.Actions.Bridge(
		context.TODO(),
		"call_control_id",
		telnyx.CallActionBridgeParams{
			CallControlIDToBridgeWith: "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

Dial

Dial a number or SIP URI from a given connection.

POST /calls — Required: connection_id, to, from

Optional: answering_machine_detection (enum), answering_machine_detection_config (object), audio_url (string), billing_group_id (uuid), bridge_intent (boolean), bridge_on_answer (boolean), client_state (string), command_id (string), conference_config (object), custom_headers (array[object]), dialogflow_config (object), enable_dialogflow (boolean), from_display_name (string), link_to (string), media_encryption (enum), media_name (string), park_after_unbridge (string), preferred_codecs (string), record (enum), record_channels (enum), record_custom_file_name (string), record_format (enum), record_max_length (int32), record_timeout_secs (int32), record_track (enum), record_trim (enum), send_silence_when_idle (boolean), sip_auth_password (string), sip_auth_username (string), sip_headers (array[object]), sip_region (enum), sip_transport_protocol (enum), sound_modifications (object), stream_auth_token (string), stream_bidirectional_codec (enum), stream_bidirectional_mode (enum), stream_bidirectional_sampling_rate (enum), stream_bidirectional_target_legs (enum), stream_codec (enum), stream_establish_before_call_originate (boolean), stream_track (enum), stream_url (string), supervise_call_control_id (string), supervisor_role (enum), time_limit_secs (int32), timeout_secs (int32), transcription (boolean), transcription_config (object), webhook_url (string), webhook_url_method (enum)

	response, err := client.Calls.Dial(context.TODO(), telnyx.CallDialParams{
		ConnectionID: "7267xxxxxxxxxxxxxx",
		From:         "+18005550101",
		To: telnyx.CallDialParamsToUnion{
			OfString: telnyx.String("+18005550100"),
		},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

Hangup call

Hang up the call.

POST /calls/{call_control_id}/actions/hangup

Optional: client_state (string), command_id (string)

	response, err := client.Calls.Actions.Hangup(
		context.TODO(),
		"call_control_id",
		telnyx.CallActionHangupParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

Transfer call

Transfer a call to a new destination.

POST /calls/{call_control_id}/actions/transfer — Required: to

Optional: answering_machine_detection (enum), answering_machine_detection_config (object), audio_url (string), client_state (string), command_id (string), custom_headers (array[object]), early_media (boolean), from (string), from_display_name (string), media_encryption (enum), media_name (string), mute_dtmf (enum), park_after_unbridge (string), preferred_codecs (string), record (enum), record_channels (enum), record_custom_file_name (string), record_format (enum), record_max_length (int32), record_timeout_secs (int32), record_track (enum), record_trim (enum), sip_auth_password (string), sip_auth_username (string), sip_headers (array[object]), sip_region (enum), sip_transport_protocol (enum), sound_modifications (object), target_leg_client_state (string), time_limit_secs (int32), timeout_secs (int32), webhook_retries_policies (object), webhook_url (string), webhook_url_method (enum), webhook_urls (object), webhook_urls_method (enum)

	response, err := client.Calls.Actions.Transfer(
		context.TODO(),
		"call_control_id",
		telnyx.CallActionTransferParams{
			To: "+18005550100",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)

List all active calls for given connection

Lists all active calls for given connection.

GET /connections/{connection_id}/active_calls

	page, err := client.Connections.ListActiveCalls(
		context.TODO(),
		"1293384261075731461",
		telnyx.ConnectionListActiveCallsParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)

List call control applications

Return a list of call control applications.

GET /call_control_applications

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

Create a call control application

Create a call control application.

POST /call_control_applications — Required: application_name, webhook_event_url

Optional: active (boolean), anchorsite_override (enum), call_cost_in_webhooks (boolean), dtmf_type (enum), first_command_timeout (boolean), first_command_timeout_secs (integer), inbound (object), outbound (object), redact_dtmf_debug_logging (boolean), webhook_api_version (enum), webhook_event_failover_url (url), webhook_timeout_secs ([‘integer’, ‘null’])

	callControlApplication, err := client.CallControlApplications.New(context.TODO(), telnyx.CallControlApplicationNewParams{
		ApplicationName: "call-router",
		WebhookEventURL: "https://example.com",
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", callControlApplication.Data)

Retrieve a call control application

Retrieves the details of an existing call control application.

GET /call_control_applications/{id}

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

Update a call control application

Updates settings of an existing call control application.

PATCH /call_control_applications/{id} — Required: application_name, webhook_event_url

Optional: active (boolean), anchorsite_override (enum), call_cost_in_webhooks (boolean), dtmf_type (enum), first_command_timeout (boolean), first_command_timeout_secs (integer), inbound (object), outbound (object), redact_dtmf_debug_logging (boolean), tags (array[string]), webhook_api_version (enum), webhook_event_failover_url (url), webhook_timeout_secs ([‘integer’, ‘null’])

	callControlApplication, err := client.CallControlApplications.Update(
		context.TODO(),
		"1293384261075731499",
		telnyx.CallControlApplicationUpdateParams{
			ApplicationName: "call-router",
			WebhookEventURL: "https://example.com",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", callControlApplication.Data)

Delete a call control application

Deletes a call control application.

DELETE /call_control_applications/{id}

	callControlApplication, err := client.CallControlApplications.Delete(context.TODO(), "1293384261075731499")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", callControlApplication.Data)

List call events

Filters call events by given filter parameters.

GET /call_events

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

Webhooks

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

Webhook payload fields

callAnswered

callStreamingStarted

callStreamingStopped

callStreamingFailed

callBridged

callInitiated

callHangup

callRecordingSaved

callMachineDetectionEnded

callMachineGreetingEnded

callMachinePremiumDetectionEnded

callMachinePremiumGreetingEnded