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

Uploaded Source

Built Distribution

vxfreeswitch-0.1.11-py2-none-any.whl (22.9 kB view details)

Uploaded Python 2

File details

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

File metadata

File hashes

Hashes for vxfreeswitch-0.1.11.tar.gz
Algorithm Hash digest
SHA256 7993e329381f2612102df1fe6651014a427ae00e40b3b7921f1fcbf498ad3855
MD5 62d69a8e7dfbf289f47b250951a3a2f2
BLAKE2b-256 d46a78ba066693d2bc0c9c63b38e5acdb531d527c2aa0740f46d847b49c1fde5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vxfreeswitch-0.1.11-py2-none-any.whl
Algorithm Hash digest
SHA256 2b8869f0015356473bc7d9dfdbf484c883c193fc809af3bd576d1247d96b7cd5
MD5 1f43152caf8111b9587f8e24830040da
BLAKE2b-256 e2d13f37e8bdd944bfa63758275a610df495cd09967d11b3e748e324876f8eef

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