Create DigitQuery

post https://api.fonestorm.com/v2/digitqueries

Add a new DigitQuery to an account.

Notes

`label`

Name/Label for the DigitQuery.

`soundfile`

Sound File ID or Text to Speech string (prefixed with tts:).

`maxdigits`

Maximum digits allowed to enter.

`mindigits`

Minimum digits required to enter.

`retries`

Maximum retries allowed.

`timeout`

Timeout in seconds, if no input pressed.

`invalid_prompt`

Invalid prompt to be played or not.

`callback_settings`

Callback settings:

url - Callback URL
method - URL method GET, POST or JSON
url_username - URL authentication username
url_password - URL authentication password

`match_pattern`

Pattern to be matched to decide the destination.

`match_destination`

destination_type - Destination type if pattern matches.
destination - Destination ID if pattern matches.

`nomatch_destination`

destination_type - Destination type if pattern doesn't match.
destination - Destination ID if pattern doesn't match.

`default_destination`

destination_type - Default destination type.
destination - Default Destination ID.

`email_options`

email - Email address
subject - Email subject
body - Email body

Response Properties

Property	Type	Description
DigitQuery	object	DigitQuery

Responses

Language

Credentials

Header


xxxxxxxxxx
10
1
import fonestorm from '@api/fonestorm';
2
3
fonestorm.createDigitQuery({
4
  callback_settings: {url_method: 'GET'},
5
  match_destination: {destination_type: 'Hangup'},
6
  nomatch_destination: {destination_type: 'Hangup'},
7
  default_destination: {destination_type: 'Hangup'}
8
})
9
  .then(({ data }) => console.log(data))
10
  .catch(err => console.error(err));

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Notes

label

soundfile

maxdigits

mindigits

retries

timeout

invalid_prompt

callback_settings

match_pattern

match_destination

nomatch_destination

default_destination

email_options