Skip to main content

A Freeswitch eventsocket transport for Vumi.

Project description

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,
    },
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vxfreeswitch-0.1.16.tar.gz (21.4 kB view details)

Uploaded Source

Built Distribution

vxfreeswitch-0.1.16-py2-none-any.whl (23.9 kB view details)

Uploaded Python 2

File details

Details for the file vxfreeswitch-0.1.16.tar.gz.

File metadata

File hashes

Hashes for vxfreeswitch-0.1.16.tar.gz
Algorithm Hash digest
SHA256 b66fc2fe6b350dc85ba32e6b5c17e86c989e9c710df39587f00bd69fed5716f8
MD5 51d112a041036a319ee0bb13ed57576d
BLAKE2b-256 271cc1be3febf5a349e28589055e28f813bba630d3d7d3f57caaaa0dc091221e

See more details on using hashes here.

File details

Details for the file vxfreeswitch-0.1.16-py2-none-any.whl.

File metadata

File hashes

Hashes for vxfreeswitch-0.1.16-py2-none-any.whl
Algorithm Hash digest
SHA256 1b9e8cebc8b2a90aab408fcb615aa0199a9a976092b263c581e2c53002bbf986
MD5 52a4730b6eab21147f57774a62fd1b4f
BLAKE2b-256 e3d228cb225abaeb8839ec02c6bd4350fa97b2fe379ed676f4d8ef2d91c55bfe

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page