DigitQuery

FoneStorm digitquery object representing an account resource in the object store.

{
    "id": "452ced9c764024",
    "label": "452ced9c764024",
    "soundfile": "SF123456789",
    "maxdigits": 1,
    "mindigits": 1,
    "retries": 3,
    "timeout": 10,
    "invalid_prompt": true,
    "callback_settings": {
        "url": null,
        "url_method": null,
        "url_username": null,
        "url_password": null
    },
    "match_pattern": "",
    "match_destination": {
        "destination_type": "Forward",
        "destination": "3214991000"
    },
    "nomatch_destination": {
        "destination_type": "Hangup",
        "destination": ""
    },
    "default_destination": {
        "destination_type": "Voicemail",
        "destination": "V123456789"
    },
    "email_options": {
        "email": "",
        "subject": "",
        "body": ""
    },
    "active": true
}
PropertyTypeDescription
idstringUnique identifier of digitquery.
labelstringLabel for the digitquery.
soundfilestringSoundFile ID or Text to speech string.
maxdigitsintegerMaximum digits allowed.
mindigitsintegerMinimum digits allowed.
retriesintegerNumber of retries allowed.
timeoutintegerTimeout seconds.
invalid_promptbooleanPlay invalid prompt or not.
match_patternstringMatch pattern.
callback_settings.urlstringCallback URL.
callback_settings.methodstringCallback method GET, POST or JSON.
callback_settings.url_usernamestringCallback URL username.
callback_settings.url_passwordstringCallback URL password.
match_destination.destination_typestringDestination type for match destination.
match_destination.destinationstringDestination ID for match destination.
nomatch_destination.destination_typestringDestination type for no-match destination.
nomatch_destination.destinationstringDestination ID for no-match destination.
default_destination.destination_typestringDestination type for default destination.
default_destination.destinationstringDestination ID for default destination.
email_options.emailstringEmail address.
email_options.subjectstringEmail subject.
email_options.bodystringEmail body.
activebooleanDigitQuery active or not.