Create DigitQuery

Add a new DigitQuery to an account.

post/digitqueries

Request

Base URL: https://api.fonestorm.com/v2
URL: https://api.fonestorm.com/v2/digitqueries
Auth: API key in header token

Request body

labelstring required

Name/Label for DigitQuery.

soundfilestring

DigitQuery soundfile or text to speech string

maxdigitsinteger

Maximum digits allowed. Default is 1

mindigitsinteger

Minimum digits allowed. Default is 24

retriesinteger

Number of allowed retries. Default is 3

timeoutinteger

Number of seconds before timeout. Default is 5 seconds

invalid_promptboolean

Play invalid prompt or not

match_patternstring

Match pattern a regular expression

Response

Created

Example response

{
  "digitquery": {
    "id": "DQ12341234",
    "label": "My DigitQuery",
    "soundfile": "SF12341234",
    "maxdigits": 1,
    "mindigits": 1,
    "retries": 3,
    "timeout": 30,
    "invalid_prompt": true,
    "callback_settings": {
      "url": "https://example.com/callback",
      "url_method": "JSON",
      "url_username": "USERNAME",
      "url_password": "PASSWORD"
    },
    "match_pattern": "(0-9)",
    "match_destination": {
      "destination_type": "Forward"
    },
    "nomatch_destination": {
      "destination_type": "SoundFile",
      "destination": "SF12341234"
    },
    "default_destination": {
      "destination_type": "Voicemail",
      "destination": "VM12341234"
    },
    "email_options": {
      "email": "support@fractel.net",
      "subject": "Input from DQ12341234",
      "body": "Input 1 received"
    },
    "active": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.