team-telnyx Telnyx Messaging - 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.
Send a message
Send a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool.
POST /messages — Required: to
response, err := client.Messages.Send(context.TODO(), telnyx.MessageSendParams{
To: "+18445550001",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
Retrieve a message
Note: This API endpoint can only retrieve messages that are no older than 10 days since their creation.
GET /messages/{id}
message, err := client.Messages.Get(context.TODO(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", message.Data)
Cancel a scheduled message
Cancel a scheduled message that has not yet been sent.
DELETE /messages/{id}
response, err := client.Messages.CancelScheduled(context.TODO(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.ID)
Send a Whatsapp message
POST /messages/whatsapp — Required: from, to, whatsapp_message
response, err := client.Messages.SendWhatsapp(context.TODO(), telnyx.MessageSendWhatsappParams{
From: "+13125551234",
To: "+13125551234",
WhatsappMessage: telnyx.MessageSendWhatsappParamsWhatsappMessage{},
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
Send a group MMS message
POST /messages/group_mms — Required: from, to
response, err := client.Messages.SendGroupMms(context.TODO(), telnyx.MessageSendGroupMmsParams{
From: "+13125551234",
To: []string{"+18655551234", "+14155551234"},
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
Send a long code message
POST /messages/long_code — Required: from, to
response, err := client.Messages.SendLongCode(context.TODO(), telnyx.MessageSendLongCodeParams{
From: "+18445550001",
To: "+13125550002",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
Send a message using number pool
POST /messages/number_pool — Required: to, messaging_profile_id
response, err := client.Messages.SendNumberPool(context.TODO(), telnyx.MessageSendNumberPoolParams{
MessagingProfileID: "abc85f64-5717-4562-b3fc-2c9600000000",
To: "+13125550002",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
Schedule a message
Schedule a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool.
POST /messages/schedule — Required: to
response, err := client.Messages.Schedule(context.TODO(), telnyx.MessageScheduleParams{
To: "+18445550001",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
Send a short code message
POST /messages/short_code — Required: from, to
response, err := client.Messages.SendShortCode(context.TODO(), telnyx.MessageSendShortCodeParams{
From: "+18445550001",
To: "+18445550001",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
List opt-outs
Retrieve a list of opt-out blocks.
GET /messaging_optouts
page, err := client.MessagingOptouts.List(context.TODO(), telnyx.MessagingOptoutListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
Retrieve a phone number with messaging settings
GET /phone_numbers/{id}/messaging
messaging, err := client.PhoneNumbers.Messaging.Get(context.TODO(), "id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", messaging.Data)
Update the messaging profile and/or messaging product of a phone number
PATCH /phone_numbers/{id}/messaging
messaging, err := client.PhoneNumbers.Messaging.Update(
context.TODO(),
"id",
telnyx.PhoneNumberMessagingUpdateParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", messaging.Data)
List phone numbers with messaging settings
GET /phone_numbers/messaging
page, err := client.PhoneNumbers.Messaging.List(context.TODO(), telnyx.PhoneNumberMessagingListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
Retrieve a mobile phone number with messaging settings
GET /mobile_phone_numbers/{id}/messaging
messaging, err := client.MobilePhoneNumbers.Messaging.Get(context.TODO(), "id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", messaging.Data)
List mobile phone numbers with messaging settings
GET /mobile_phone_numbers/messaging
page, err := client.MobilePhoneNumbers.Messaging.List(context.TODO(), telnyx.MobilePhoneNumberMessagingListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
Bulk update phone number profiles
POST /messaging_numbers/bulk_updates — Required: messaging_profile_id, numbers
messagingNumbersBulkUpdate, err := client.MessagingNumbersBulkUpdates.New(context.TODO(), telnyx.MessagingNumbersBulkUpdateNewParams{
MessagingProfileID: "00000000-0000-0000-0000-000000000000",
Numbers: []string{"+18880000000", "+18880000001", "+18880000002"},
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", messagingNumbersBulkUpdate.Data)
Retrieve bulk update status
GET /messaging_numbers/bulk_updates/{order_id}
messagingNumbersBulkUpdate, err := client.MessagingNumbersBulkUpdates.Get(context.TODO(), "order_id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", messagingNumbersBulkUpdate.Data)
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).
| Event | Description |
|---|---|
deliveryUpdate |
Delivery Update |
inboundMessage |
Inbound Message |
replacedLinkClick |
Replaced Link Click |