mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-08-11 16:43:38 +00:00
Joel Wetzell
26 lines
817 B
Plaintext
26 lines
817 B
Plaintext
---
|
|
title: SIP DTMF Server
|
|
sidebar:
|
|
label: Server
|
|
order: 1
|
|
---
|
|
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
|
|
|
|
This module starts a [SIP](https://en.wikipedia.org/wiki/Session_Initiation_Protocol) 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.
|
|
|
|
<SchemaInfo type="module" id="sip.dtmf.server"></SchemaInfo>
|
|
|
|
### 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
|
|
|
|
```yaml
|
|
- id: sipDTMFServer
|
|
type: sip.dtmf.server
|
|
params:
|
|
ip: 127.0.0.1
|
|
port: 5060
|
|
transport: udp
|
|
separator: "#"
|
|
```
|