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.18.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

vxfreeswitch-0.1.18-py2-none-any.whl (24.3 kB view details)

Uploaded Python 2

File details

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

File metadata

File hashes

Hashes for vxfreeswitch-0.1.18.tar.gz
Algorithm Hash digest
SHA256 240e5960ec8bee0da004582deab35e1a680e5094097025c9627402133028928b
MD5 896674a238b6147f807b34908308c663
BLAKE2b-256 4d62c56147231340decaa21b26c9d155a4ac15d345a7b2d529f95ab0b697ee1d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vxfreeswitch-0.1.18-py2-none-any.whl
Algorithm Hash digest
SHA256 bdf8565ed8f738455c87eca8c0e7e0ef69cd4a84fe8ade2b42f1983be7791c5f
MD5 5e748e3655cadff60c702adb6ba99525
BLAKE2b-256 311cde0cabf9300c067fb45cdeb1819a165dec39139d6f1a059aa56061e566ef

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