Skip to main content

A Freeswitch eventsocket transport for Vumi.

vfs-ci vfs-cover

You can contact the Vumi development team in the following ways:

Issues can be filed in the GitHub issue tracker. Please don’t use the issue tracker for general support queries.

Usage

Voice transports may receive additional hints for how to handle outbound messages in the voice section of helper_metadata. The voice section may contain the following keys:

speech_url:

The URL where the voice file to be played can be found. If this field is absent or None, a text-to-speech engine will be used to generate a suitable sound from the message content, otherwise this voice file will be played.

This can either be a string containing the URL, or a list of strings containing URLs to sound files that should be joined to form the message.

wait_for:

Gather response characters until the given DTMF character is encountered. Commonly either # or *. If absent or None, an inbound message is sent as soon as a single DTMF character arrives.

barge_in:

A boolean value that if True, stops the playback of the message when a DTMF character arrives. This allows the response to the input to be played immediately, rather than waiting for the first message to finish playing before hearing the response message. Defaults to False.

tries:

If barge_in is True, this will set the number of times a message is played if no input is received. Defaults to 1.

time_gap:

If barge_in is True and tries is greater than 1, this specifies the length of the pause (in ms) that is given before repeating the message, if no DTMF characters are received. Defaults to 3000.

Example:

"helper_metadata": {
    "voice": {
        "speech_url": [
            "http://www.example.com/voice/ab34f611cdee.ogg",
            "http://www.example.com/voice/cd43f622dcef.ogg"
        ],
        "wait_for": "#",
        "barge_in": True,
        "tries": 3,
        "time_gap": 5000,
    },
}

Metadata

Release files for vxfreeswitch 0.1.20

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vxfreeswitch 0.1.20
File Size Uploaded
vxfreeswitch-0.1.20.tar.gz 22.1 kB Details

Release files / vxfreeswitch-0.1.20.tar.gz

Download URL vxfreeswitch-0.1.20.tar.gz
Size 22.1 kB
Tags Source
SHA-256 checksum
How to use checksums
6a800cdc6366d20ee16360a335c5a14ad09969bc9cc083f38bd73f16ea95d0b2
BLAKE2b-256 checksum
How to use checksums
7d4278bc31bde15c2de6e0d04fe89df6c7a7d21f5da86cb65e44ffa29bd2da05
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.20 This release

1 release file

0.1.19

1 release file

0.1.18

2 release files

0.1.16

2 release files

0.1.15

2 release files

0.1.14

2 release files

0.1.13

1 release file

0.1.12

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

1 release file

0.1.1

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page