voicemessage

Documentation

Index

• type Params
• type VoiceMessage
  • func Create(c messagebird.Client, recipients []string, body string, params *Params) (*VoiceMessage, error)
  • func Read(c messagebird.Client, id string) (*VoiceMessage, error)
• type VoiceMessageList
  • func List(c messagebird.Client) (*VoiceMessageList, error)

Types

type Params

type Params struct {
	Originator        string
	Reference         string
	Language          string
	Voice             string
	Repeat            int
	IfMachine         string
	ScheduledDatetime time.Time
}

Params struct provides additional VoiceMessage details.

type VoiceMessage

type VoiceMessage struct {
	ID                string
	HRef              string
	Originator        string
	Body              string
	Reference         string
	Language          string
	Voice             string
	Repeat            int
	IfMachine         string
	ScheduledDatetime *time.Time
	CreatedDatetime   *time.Time
	Recipients        messagebird.Recipients
}

VoiceMessage wraps data needed to transform text messages into voice messages. Voice messages are identified by a unique random ID. With this ID you can always check the status of the voice message through the provided endpoint.

func Create

func Create(c messagebird.Client, recipients []string, body string, params *Params) (*VoiceMessage, error)

Create a new voice message for one or more recipients.

func Read

func Read(c messagebird.Client, id string) (*VoiceMessage, error)

Read retrieves the information of an existing VoiceMessage.

type VoiceMessageList

type VoiceMessageList struct {
	Offset     int
	Limit      int
	Count      int
	TotalCount int
	Links      map[string]*string
	Items      []VoiceMessage
}

VoiceMessageList represents a list of VoiceMessages.

func List

func List(c messagebird.Client) (*VoiceMessageList, error)

List retrieves all VoiceMessages of the user.