REST API Release Notes

Note: the version of REST API you are using in your REST application must match the REST API Version set for the Outbound and Inbound Services that request it.

Current Release:

Version 2.0

In this release:

The REST API download packages are specifically for the REST API. Wrappers for the Web Services API are available separately here.

API changes:

HTTP response
- Property api version has been added and is required (e.g. "2.0").
instance info
- Property is notification has been added.
call info
- Property call divert has been added.
- Property call raw cause has been added.
Added clear input action - to clear input after barge in has occurred on a play action.
Added start transcription action - to start transcribing audio on the call.
Added stop transcription action - to stop transcribing audio on the call.
get input action - removed used of speech recognition grammar and improved control of timeouts.
- Property speech recognition grammar has been removed.
- Property seconds speech recognition timeout has been removed.
- Property wait for prompt end has been removed.
- Property speech input mode has been added.
- Property speech recognition options has been added.
- Property seconds timeout has been added.
- Property millseconds inter speech timeout has been added.
- Property millseconds inter digit timeout has been added.
- Property milliseconds initial timeout has been added.
- Property next page is now required.
- Property prompt is now optional.
- Removed from result: input.
- Added to result: speech input.
- Added to result: digits input.
get number action - improved control of timeouts.
- Property seconds digit timeout has been removed.
- Property seconds timeout has been added.
- Property milliseconds inter digit timeout has been added.
- Property milliseconds initial timeout has been added.
- Property next page is now required.
- Property prompt is now optional.
play action - now allows barge in on speech.
- Property barge in has been removed.
- Property barge in on digit has been added.
- Property barge in on speech has been added.
- Property barge in on speech options has been added.
receive fax action - now notifies when received fax is fully available.
- Property next page is now required.
- Property id has been added.
- Property fax available page has been added.
- Added to result: id.
- Added to result: file available.
- Added to progress result: id.
record action - now notifies when recording is fully available and reports more information.
- Property next page is now required.
- Property id has been added.
- Property milliseconds max initial silence has been added.
- Property recording available page has been added.
- Added to result: id.
- Added to result: file available.
- Added to result: reason.
- Added to result: barge in digit.
run menu action.
- Property prompt is now optional.
run speech menu action - added control of language used.
- Property seconds input timeout has been removed.
- Property seconds timeout has been added.
- Property language has been added.
- Property prompt is now optional.