| actions |
Data Type: Array or Object |
Default: (none) |
Optional |
Actions contains either an Array or an Object with the result of the actions requested in the previous payload, such as an ask or record. The field will be an array if multiple inputs were requested, an object if only one input was requested. Contains the following keys:
- "name" [String] - The name provided for this action result in the request.
- "attempts" [Integer] - The number of attempts it took to obtain the result.
- "disposition" [String] - The final result of the request, values may be "success", "timeout" or "nomatch".
- "confidence" [Integer] - The result returned by the confidence engine that the result is correct.
- "interpretation" [String] - What the recognition engine believes what was said.
- "utterrance" [String] - The specific utterance returned by the speech recognition engine.
- "value" [String] - This is the result of the grammar. If you have a grammar that says "BBQ (BBQ, Bar Bee Que)" and someone says "Bar Bee Que", then interpretation would say "Bar Bee Que" and value would say "BBQ".
- "concept" [String] - The result of a Simple Grammar recognition.
- "xml" [String] - Contains the raw NLSML output.
"actions": { "name": "account_number", "attempts": 1, "disposition": "SUCCESS", "confidence": 100, "interpretation": "12345", "utterance": "1 2 3 4 5", "concept": "12345" }
"actions": [{ "name": "account_number", "attempts": 1, "disposition": "SUCCESS", "confidence": 100, "interpretation": "12345", "utterance": "1 2 3 4 5", "concept": "12345" }, { "name": "pin", "attempts": 1, "disposition": "SUCCESS", "confidence": 100, "interpretation": "9876", "utterance": "9 8 7 6", "concept": "9876" }]
|
| callId |
Data Type: String |
Default: "" (undefined) |
Optional |
| This contains the ID of the call itself; this is not the caller ID or called ID, this is a value that identifies the actual call. |
| complete |
Data Type: Boolean |
Default: (none) |
Optional |
| This indicates whether a request resulted in all required fields being completed. |
| error |
Data Type: String |
Default: "" (undefined) |
Optional |
| If the state of the result is an error, refer to this field for the error message. |
| sequence |
Data Type: Integer |
Default: 0 |
Optional |
| Represents the number of Tropo payloads returned from your application. For example, if your application receives a session payload and returns a Tropo payload such as an ask, the sequence is at 1. If you then receive a result from Tropo and return a say, the sequence is at 2. |
| sessionDuration |
Data Type: Integer |
Default: 0 |
Optional |
| The total length of time, in seconds, the current session has been running. |
| sessionId |
Data Type: String |
Default: "" (undefined) |
Optional |
| This is the unique identifier that is available with each session and result payload. |
| state |
Data Type: String |
Default: "" (undefined) |
Optional |
This is the state of the session at the time the result was generated. Values may be: NEW, RINGING, ANSWERING, ANSWERED, REJECTING, REJECTED, DISCONNECTED, FAILED, REDIRECTING, or REDIRECTED.
|