package
7.1.0
Repository: https://github.com/messagebird/go-rest-api.git
Documentation: pkg.go.dev

# Functions

CallByID fetches a call by it's ID.
CallFlowByID fetches a callflow by it's ID.
CallFlows returns a Paginator which iterates over all CallFlows.
Calls returns a Paginator which iterates over all Calls.
CreateTranscription creates a transcription request for an existing recording.
CreateWebHook creates a new webhook the specified url that will be called and security token.
Delete deletes a recording.
InitiateCall initiates an outbound call.
ReadRecording fetches a single Recording based on its call ID, leg ID and the recording ID.
Recordings returns a Paginator which iterates over Recordings.
Webhooks returns a paginator over all webhooks.

# Constants

CallStatusEnded indicates that a call has been terminated.
CallStatusOngoing indicates that a call is active.
CallStatusStarting is the status of a call that is currently being set up.
LegDirectionIncoming is the direction of a leg that is created when a number is called.
LegDirectionOutgoing is the direction of a leg that are created when a call is transferred.
LegStatusBusy indicates that a leg could not be established because the other side is busy.
LegStatusFailed indicates some kind of failure of a leg.
LegStatusHangup indicates that a leg has been hung up.
LegStatusNoAnswer indicates that a leg could not be established because the other side did not pick up.
LegStatusOngoing indicates a healthy leg that is currently participating in a call.
LegStatusRinging indicates that a leg is connected and ringing.
LegStatusStarting indicates that a leg is currently starting.
RecordingStatusDone indicates that a recording is completed and may be downloaded.
RecordingStatusFailed indicates that something went wrong while recording a leg.
RecordingStatusInitialised indicates that the recording has been created but has not begun just yet.
RecordingStatusRecording indicates that recording is currently in progress.

# Structs

A Call describes a voice call which is made to a number.
A CallFlow describes the flow of operations (steps) to be executed when handling an incoming call.
A CallFlowFetchStep fetches a call flow from a remote URL.
A CallFlowHangupStep ends the call.
A CallFlowPauseStep Pauses (silently) for a given duration.
A CallFlowPlayStep plays back an audio file.
A CallFlowRecordStep initiates an audio recording during a call, e.g.
A CallFlowSayStep pronounces a text message with a given voice and language.
CallFlowStepBase contains all common properties for call flow steps.
A CallFlowTransferStep transfers the call to a different phone/server.
No description provided by the author
No description provided by the author
A Leg describes a leg object (inbound or outbound) that belongs to a call.
A Paginator is used to stream the contents of a collection of some type from the MessageBird API.
A Recording describes a voice recording of a leg.
A Transcription is a textual representation of a recording as text.
A Webhook is an HTTP callback to your platform.

# Interfaces

A CallFlowStep is a single step that can be taken in a callflow.

# Type aliases

CallStatus enumerates all valid values for a call status.
LegDirection indicates the direction of some leg in a call.
LegStatus enumerates all valid values for a leg status.
RecordingStatus enumerates all valid values for the status of a recording.