Skip to content

KAZOO Support Channels

This documentation is curated by 2600Hz as part of the KAZOO open source project. Join our community forums here for peer support. Only features in the docs.2600hz.com/supported space are included as part of our 2600Hz Support Services plan.

Hold

Hold#

About Hold#

Some phones do not support putting the other line on hold or making it easy to set custom music to play while on hold. The Konami hold module permits both.

Schema#

Put the leg on hold

Key Description Type Default Required
moh_aleg MOH ID for the a-leg string() false
moh_bleg MOH ID for the b-leg string() false
unhold_key DTMF to press to unhold the call string() 1 false

How It Works#

Alice is talking to Bob and would like to put him on hold while she performs a request Bob has made of her. She presses her hold metaflow number (say *5). Bob will be placed on hold, and Alice is free to talk without her audio being transmitted to Bob.

Once Alice is ready to talk with Bob again, she can press unhold key (1 by default) to be reconnected with Bob.

Configure the metaflow#

The hold module should be placed under the "numbers" key in the "metaflows" object. It can take a custom media file to play to the on-hold party; otherwise the system default music is played.

    "metaflows":{
        "numbers":{
            "5":{
                "module":"hold"
                ,"data":{
                    "moh_aleg":"silence_stream://0,1400"
                    ,"moh_bleg":"some_useful_media_id"
                    ,"unhold_key":"5"
                }
            }
        }
        ,"patterns":{...}
        ,"binding_key":"*"
    }