ivr

Documentation

Index

• Constants
• func RegisterClientType(channelType models.ChannelType, constructor ClientConstructor)
• func RequestCallStart(ctx context.Context, config *config.Config, db *sqlx.DB, org *models.OrgAssets, ...) (*models.ChannelSession, error)
• type CallID
• type ClientConstructor
• type IVRClient
  • func GetClient(channel *models.Channel) (IVRClient, error)

Constants

const (
	NilCallID = CallID("")
)

Functions

func RegisterClientType

func RegisterClientType(channelType models.ChannelType, constructor ClientConstructor)

RegisterClientType registers the passed in channel type with the passed in constructor

func RequestCallStart

func RequestCallStart(ctx context.Context, config *config.Config, db *sqlx.DB, org *models.OrgAssets, start *models.FlowStart, c *models.Contact) (*models.ChannelSession, error)

RequestCallStart creates a new ChannelSession for the passed in flow start and contact, returning the created session

Types

type CallID

type CallID string

type ClientConstructor

type ClientConstructor func(c *models.Channel) (IVRClient, error)

ClientConstructor defines our signature for creating a new IVR client from a channel

type IVRClient

type IVRClient interface {
	RequestCall(c *models.Channel, number urns.URN, callbackURL string, statusURL string) (CallID, error)
}

IVRClient defines the interface IVR clients must satisfy

func GetClient

func GetClient(channel *models.Channel) (IVRClient, error)

GetClient creates the right kind of IVRClient for the passed in channel