routes

Documentation

Index

• func NewError(ctx *gin.Context, status int, err error)
• func Run(conf *c.Config, client *gen.Client)
• type AddCarrier
• type AddCarrierAddress
• type AddNumberMapping
• type GetCarrier
• type GetCarrierAddress
• type GetNumberMapping
• type HTTPError

Functions

func NewError

func NewError(ctx *gin.Context, status int, err error)

NewError example

func Run

func Run(conf *c.Config, client *gen.Client)

Run will start the server

Types

type AddCarrier

type AddCarrier struct {
	// username to use when authenticating with the carrier
	Username string `json:"username"  example:"my-byoc-twilio-user"`
	// password to use when authenticating with the carrier
	Password string `json:"password"  example:"my-secret-password"`
	// ream the carrier uses in its digest challenge
	Realm string `json:"realm"  example:"sip.twilio.com"`
	// ream the carrier uses in its digest challenge
	Domain string `json:"domain"  example:"my-byoc-account.pstn.twilio.com"`
	// name of the carrier this number is associated with
	Carrier string `json:"carrier_name"  example:"twilio"`
}

@Description: Information required to make outbound calls with this carrier

type AddCarrierAddress

type AddCarrierAddress struct {
	// IP address of the carrier
	IpAddr string `json:"ip_address" example:"192.168.0.1"`
	// number of bits to mask the ip address, used to match entire ip subnets
	Mask int8 `json:"mask" example:"32" format:"int8"`
	// port of the expected traffic comes from, 0 means any port
	Port int16 `json:"port" example:"5060" format:"int16"`
	// name of the carrier this ip is to be identified as
	Carrier string `json:"carrier_name"  example:"twilio"`
}

@Description Identical to GetCarrierAddress except the ID is omitted

type AddNumberMapping

type AddNumberMapping struct {
	// Telephone number associated with the sip_uri
	E164 string `json:"e164" example:"+4412345678"`
	// Number to alias to when this sipuri makes outbound calls
	Alias string `json:"alias" example:"+4412340000"`
	// the sip uri to associate with this number
	SipUri string `json:"sip_uri" example:"sip:AgentSmith@agent.openline.ai"`
	// name of the carrier this number is associated with
	Carrier string `json:"carrier_name"  example:"twilio"`
}

@Description Identical to GetNumberMapping except ID is omittied

type GetCarrier

type GetCarrier struct {
	// the id for this specific carrier record
	ID int `json:"ID"`
	// username to use when authenticating with the carrier
	Username string `json:"username"  example:"my-byoc-twilio-user"`
	// ream the carrier uses in its digest challenge
	Realm string `json:"realm"  example:"sip.twilio.com"`
	// ream the carrier uses in its digest challenge
	Domain string `json:"domain"  example:"my-byoc-account.pstn.twilio.com"`
	// name of the carrier this number is associated with
	Carrier string `json:"carrier_name"  example:"twilio"`
}

@Description: Information required to make outbound calls with this carrier

type GetCarrierAddress

type GetCarrierAddress struct {
	// the id for this specific IP record
	ID int `json:"ID"`
	// IP address of the carrier
	IpAddr string `json:"ip_address" example:"192.168.0.1"`
	// number of bits to mask the ip address, used to match entire ip subnets
	Mask int8 `json:"mask" example:"32" format:"int8"`
	// port of the expected traffic comes from, 0 means any port
	Port int16 `json:"port" example:"5060" format:"int16"`
	// name of the carrier this ip is to be identified as
	Carrier string `json:"carrier_name"  example:"twilio"`
}

@Description used to identify a carrier by the IP address of incomming traffic

type GetNumberMapping

type GetNumberMapping struct {
	// the id for this specific IP record
	ID int `json:"ID"`
	// Telephone number associated with the sip_uri
	E164 string `json:"e164" example:"+4412345678"`
	// Number to alias to when this sipuri makes outbound calls
	Alias string `json:"alias" example:"+4412340000"`
	// the sip uri to associate with this number
	SipUri string `json:"sip_uri" example:"sip:AgentSmith@agent.openline.ai"`
	// name of the carrier this number is associated with
	Carrier string `json:"carrier_name"  example:"twilio"`
}

@Description defines the mapping between telephone numbers and a sip address of a user in the system

type HTTPError

type HTTPError struct {
	Code    int    `json:"code" example:"400"`
	Message string `json:"message" example:"status bad request"`
}

HTTPError example