Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

sipgo

package module

Go to main page

Versions in this module

v1

v1.6.5

Sep 18, 2026

v1.6.4

Sep 13, 2026

v1.6.3

Sep 5, 2026

v1.6.2

Aug 21, 2026

v1.6.1

Jul 30, 2026

v1.6.0

Jul 29, 2026

v1.5.0

Jul 28, 2026

Changes in this version

+ var ErrDialogDoesNotExists = errors.New("Call/Transaction Does Not Exist")

+ var ErrDialogInvalidCseq = errors.New("invalid CSEQ number")

+ var ErrDialogInviteNoContact = errors.New("no Contact header")

+ var ErrDialogOutsideDialog = errors.New("Call/Transaction Outside Dialog")

+ var ListenReadyCtxKey = "ListenReadyCtxKey"

+ var WaitAnswerForceCancelErr = errors.New("Context cancel forced")

+ func ClientRequestAddRecordRoute(c *Client, r *sip.Request) error

+ func ClientRequestAddVia(c *Client, r *sip.Request) error

+ func ClientRequestBuild(c *Client, r *sip.Request) error

+ func ClientRequestDecreaseMaxForward(c *Client, r *sip.Request) error

+ func ClientRequestIncreaseCSEQ(c *Client, req *sip.Request) error

+ func ClientRequestRegisterBuild(c *Client, r *sip.Request) error

+ func Init()

+ type AnswerOptions struct

+ OnResponse func(res *sip.Response) error

+ Password string

+ Username string

+ type Client struct

+ TxRequester ClientTransactionRequester

+ func NewClient(ua *UserAgent, options ...ClientOption) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) Do(ctx context.Context, req *sip.Request, opts ...ClientRequestOption) (*sip.Response, error)

+ func (c *Client) DoDigestAuth(ctx context.Context, req *sip.Request, res *sip.Response, auth DigestAuth) (*sip.Response, error)

+ func (c *Client) Hostname() string

+ func (c *Client) TransactionDigestAuth(ctx context.Context, req *sip.Request, res *sip.Response, auth DigestAuth) (sip.ClientTransaction, error)

+ func (c *Client) TransactionRequest(ctx context.Context, req *sip.Request, options ...ClientRequestOption) (sip.ClientTransaction, error)

+ func (c *Client) WriteRequest(req *sip.Request, options ...ClientRequestOption) error

+ type ClientOption func(c *Client) error

+ func WithClientAddr(addr string) ClientOption

+ func WithClientConnectionAddr(hostPort string) ClientOption

+ func WithClientHostname(hostname string) ClientOption

+ func WithClientLogger(logger *slog.Logger) ClientOption

+ func WithClientNAT() ClientOption

+ func WithClientPort(port int) ClientOption

+ type ClientRequestOption func(c *Client, req *sip.Request) error

+ type ClientTransactionRequester interface

+ Request func(ctx context.Context, req *sip.Request) (sip.ClientTransaction, error)

+ type Dialog struct

+ ID string

+ InviteRequest *sip.Request

+ InviteResponse *sip.Response

+ func (d *Dialog) CSEQ() uint32

+ func (d *Dialog) Context() context.Context

+ func (d *Dialog) Init()

+ func (d *Dialog) InitWithState(s sip.DialogState)

+ func (d *Dialog) LoadState() sip.DialogState

+ func (d *Dialog) OnState(f DialogStateFn)

+ func (d *Dialog) ReadRequest(req *sip.Request, tx sip.ServerTransaction) error

+ func (d *Dialog) StateRead() <-chan sip.DialogState

+ type DialogClientCache struct

+ func NewDialogClientCache(client *Client, contactHDR sip.ContactHeader) *DialogClientCache

+ func (c *DialogClientCache) Invite(ctx context.Context, recipient sip.Uri, body []byte, headers ...sip.Header) (*DialogClientSession, error)

+ func (c *DialogClientCache) ReadBye(req *sip.Request, tx sip.ServerTransaction) error

+ func (c *DialogClientCache) WriteInvite(ctx context.Context, inviteRequest *sip.Request) (*DialogClientSession, error)

+ func (s *DialogClientCache) MatchRequestDialog(req *sip.Request) (*DialogClientSession, error)

+ type DialogClientSession struct

+ UA *DialogUA

+ func (d *DialogClientSession) Invite(ctx context.Context, options ...ClientRequestOption) error

+ func (s *DialogClientSession) Ack(ctx context.Context) error

+ func (s *DialogClientSession) Bye(ctx context.Context) error

+ func (s *DialogClientSession) Close() error

+ func (s *DialogClientSession) Do(ctx context.Context, req *sip.Request) (*sip.Response, error)

+ func (s *DialogClientSession) ReadBye(req *sip.Request, tx sip.ServerTransaction) error

+ func (s *DialogClientSession) TransactionRequest(ctx context.Context, req *sip.Request) (sip.ClientTransaction, error)

+ func (s *DialogClientSession) WaitAnswer(ctx context.Context, opts AnswerOptions) error

+ func (s *DialogClientSession) WriteAck(ctx context.Context, ack *sip.Request) error

+ func (s *DialogClientSession) WriteBye(ctx context.Context, bye *sip.Request) error

+ func (s *DialogClientSession) WriteRequest(req *sip.Request) error

+ type DialogServerCache struct

+ func NewDialogServerCache(client *Client, contactHDR sip.ContactHeader) *DialogServerCache

+ func (s *DialogServerCache) MatchDialogRequest(req *sip.Request) (*DialogServerSession, error)

+ func (s *DialogServerCache) ReadAck(req *sip.Request, tx sip.ServerTransaction) error

+ func (s *DialogServerCache) ReadBye(req *sip.Request, tx sip.ServerTransaction) error

+ func (s *DialogServerCache) ReadInvite(req *sip.Request, tx sip.ServerTransaction) (*DialogServerSession, error)

+ type DialogServerSession struct

+ func (s *DialogServerSession) Bye(ctx context.Context) error

+ func (s *DialogServerSession) Close() error

+ func (s *DialogServerSession) Do(ctx context.Context, req *sip.Request) (*sip.Response, error)

+ func (s *DialogServerSession) ReadAck(req *sip.Request, tx sip.ServerTransaction) error

+ func (s *DialogServerSession) ReadBye(req *sip.Request, tx sip.ServerTransaction) error

+ func (s *DialogServerSession) Respond(statusCode int, reason string, body []byte, headers ...sip.Header) error

+ func (s *DialogServerSession) RespondSDP(sdp []byte) error

+ func (s *DialogServerSession) TransactionRequest(ctx context.Context, req *sip.Request) (sip.ClientTransaction, error)

+ func (s *DialogServerSession) WriteBye(ctx context.Context, bye *sip.Request) error

+ func (s *DialogServerSession) WriteRequest(req *sip.Request) error

+ func (s *DialogServerSession) WriteResponse(res *sip.Response) error

+ type DialogStateFn func(s sip.DialogState)

+ type DialogUA struct

+ Client *Client

+ ContactHDR sip.ContactHeader

+ RewriteContact bool

+ func (c *DialogUA) ReadInvite(inviteRequest *sip.Request, tx sip.ServerTransaction) (*DialogServerSession, error)

+ func (c *DialogUA) WriteInvite(ctx context.Context, inviteReq *sip.Request, options ...ClientRequestOption) (*DialogClientSession, error)

+ func (ua *DialogUA) Invite(ctx context.Context, recipient sip.Uri, body []byte, headers ...sip.Header) (*DialogClientSession, error)

+ type DigestAuth struct

+ Password string

+ Username string

+ type ErrDialogResponse struct

+ Res *sip.Response

+ func (e ErrDialogResponse) Error() string

+ type ListenReadyCtxValue chan struct

+ type ListenReadyFuncCtxValue func(network string, addr string)

+ type RequestHandler func(req *sip.Request, tx sip.ServerTransaction)

+ type Server struct

+ func NewServer(ua *UserAgent, options ...ServerOption) (*Server, error)

+ func (srv *Server) Close() error

+ func (srv *Server) ListenAndServe(ctx context.Context, network string, addr string) error

+ func (srv *Server) ListenAndServeTLS(ctx context.Context, network string, addr string, conf *tls.Config) error

+ func (srv *Server) OnAck(handler RequestHandler)

+ func (srv *Server) OnBye(handler RequestHandler)

+ func (srv *Server) OnCancel(handler RequestHandler)

+ func (srv *Server) OnInfo(handler RequestHandler)

+ func (srv *Server) OnInvite(handler RequestHandler)

+ func (srv *Server) OnMessage(handler RequestHandler)

+ func (srv *Server) OnNoRoute(handler RequestHandler)

+ func (srv *Server) OnNotify(handler RequestHandler)

+ func (srv *Server) OnOptions(handler RequestHandler)

+ func (srv *Server) OnPrack(handler RequestHandler)

+ func (srv *Server) OnPublish(handler RequestHandler)

+ func (srv *Server) OnRefer(handler RequestHandler)

+ func (srv *Server) OnRegister(handler RequestHandler)

+ func (srv *Server) OnRequest(method sip.RequestMethod, handler RequestHandler)

+ func (srv *Server) OnSubscribe(handler RequestHandler)

+ func (srv *Server) OnUpdate(handler RequestHandler)

+ func (srv *Server) RegisteredMethods() []string

+ func (srv *Server) ServeTCP(l net.Listener) error

+ func (srv *Server) ServeTLS(l net.Listener) error

+ func (srv *Server) ServeUDP(l net.PacketConn) error

+ func (srv *Server) ServeWS(l net.Listener) error

+ func (srv *Server) ServeWSS(l net.Listener) error

+ func (srv *Server) TransportLayer() *sip.TransportLayer

+ func (srv *Server) WriteResponse(r *sip.Response) error

+ type ServerOption func(s *Server) error

+ func WithServerLogger(logger *slog.Logger) ServerOption

+ type UserAgent struct

+ func NewUA(options ...UserAgentOption) (*UserAgent, error)

+ func (ua *UserAgent) Close() error

+ func (ua *UserAgent) Hostname() string

+ func (ua *UserAgent) Name() string

+ func (ua *UserAgent) TransactionLayer() *sip.TransactionLayer

+ func (ua *UserAgent) TransportLayer() *sip.TransportLayer

+ type UserAgentOption func(s *UserAgent) error

+ func WithUserAgenTLSConfig(c *tls.Config) UserAgentOption

+ func WithUserAgent(ua string) UserAgentOption

+ func WithUserAgentDNSResolver(r *net.Resolver) UserAgentOption

+ func WithUserAgentHostname(hostname string) UserAgentOption

+ func WithUserAgentParser(p *sip.Parser) UserAgentOption

+ func WithUserAgentTransactionLayerOptions(o ...sip.TransactionLayerOption) UserAgentOption

+ func WithUserAgentTransportLayerOptions(o ...sip.TransportLayerOption) UserAgentOption