Skip to content
showbridge

SIP DTMF Server

This module starts a SIP server that listens for incoming connections. When a call is received this module will emit events based on the touch tones (DTMF) received during the call. The event is sent out whenever the use presses the separator key defined in the params.

  • type: sip.dtmf.server
  • params:
    • ip: (optional, default "0.0.0.0") the IP address to bind the SIP server to
    • port: (optional, default 5060) the port for the SIP server to listen on
    • separator: the DTMF character to use as a separator between DTMF digit groups
    • transport: (optional, default "udp") the transport protocol to use for the SIP server
    • userAgent: (optional, default "showbridge") the user agent string to use

Example

Section titled “Example”

Start a UDP SIP server listening on port 5060 that will emit events whenever the user presses the # key on their phone during a call

- id: sipDTMFServer
  type: sip.dtmf.server
  params:
    ip: 127.0.0.1
    port: 5060
    transport: udp
    separator: "#"