Adapter - Voice Operator
This page describes version 2.0.10 of the adapter.
Overview
This adapter can control outgoing calls and incoming calls of an IVR (Voice Operator) using HTTP messages.
This adapter supports Japanese Market only.
Properties
| Name |
Display |
Is Required |
Comments |
Type |
Default Value |
Maximum Value |
Minimum Value |
Maximum Length |
Minimum Length |
| baseurl |
BaseURL |
True |
Base URL of Voice Operator. Example: https://:443,http://:80 |
string |
|
|
|
|
|
| healthCheckInterval |
Health check transmission interval |
False |
Health check transmission interval. (Unit: second, default: 0 seconds, 0: Disable Health check) |
string |
|
|
|
|
|
| username |
Voice Operator username |
True |
Username for accessing Voice Operator |
string |
|
|
|
|
|
| password |
Voice Operator Password |
True |
Password for accessing Voice Operator |
password |
|
|
|
|
|
| suggestionsentencecandidates |
Speech recognition keyword |
False |
Register speech recognition keywords separated by commas |
string |
|
|
|
|
|
Commands
Outgoing instruction (makeCall)
Instructs Voice Operator to make calls.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| number |
Destination phone number |
Telephone number from Voice Operator |
True |
string |
| message |
message |
An announcement to play when the destination phone number answers |
True |
string |
| timeout |
time out |
Call timeout value (unit: second, default: 300 seconds) |
False |
string |
Response Properties
| Name |
Description |
Type |
| codenum |
200: Input parameter error 201: Destination busy 202: Destination not responding, 203: Destination not available 204: Destination not available due to FAX 205: Line busy 206: System error |
string |
Speech synthesis (speechSynthesis)
Directs voice synthesis on an incoming call that responds to the Voice Operator.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| linenumber |
Line number |
Line number (parameter received from Voice Operator) |
True |
string |
| callerphonenumber |
Caller ID |
Caller ID (parameter received from Voice Operator) |
True |
string |
| uipinterfaceurl |
Destination URL |
Destination URL of command (parameter received from Voice Operator) |
True |
string |
| messagetext |
Message text |
Text to speech synthesis |
True |
string |
| timeout |
time out |
Call timeout value (unit: second, default: 300 seconds) |
False |
string |
Response Properties
| Name |
Description |
Type |
| codenum |
100:Parameter error, 301:Url not found, 302:Call was disconnected, 303:Speech synthesis failed, 304:Voice recognition failed, 305:Internal server error(UIP), 306:Internal server error(Voice Operator) |
string |
voice recognition (voiceRecognition)
Instructs voice recognition on an incoming call in response to a Voice Operator.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| linenumber |
Line number |
Line number (parameter received from Voice Operator) |
True |
string |
| callerphonenumber |
Caller ID |
Caller ID (parameter received from Voice Operator) |
True |
string |
| uipinterfaceurl |
Destination URL |
Destination URL of command (parameter received from Voice Operator) |
True |
string |
| messagetext |
Message text |
Text to speech synthesis |
True |
string |
| timeout |
time out |
Call timeout value (unit: second, default: 300 seconds) |
False |
string |
| latency |
Waiting time |
Waiting time for voice recognition (in seconds, 5, 10, 15, 20 seconds, default: 5 seconds) |
False |
string |
Response Properties
| Name |
Description |
Type |
| talkingwords |
User spoken words |
string |
| codenum |
100:Parameter error, 301:Url not found, 302:Call was disconnected, 303:Speech synthesis failed, 304:Voice recognition failed, 305:Internal server error(UIP), 306:Internal server error(Voice Operator) |
string |
disconnect (disconnection)
Instructs the Voice Operator to disconnect the incoming call.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| linenumber |
Line number |
Line number (parameter received from Voice Operator) |
True |
string |
| callerphonenumber |
Caller ID |
Caller ID (parameter received from Voice Operator) |
True |
string |
| uipinterfaceurl |
Destination URL |
Destination URL of command (parameter received from Voice Operator) |
True |
string |
| timeout |
time out |
Call timeout value (unit: second, default: 300 seconds) |
False |
string |
Response Properties
| Name |
Description |
Type |
| codenum |
100:Parameter error, 301:Url not found, 302:Call was disconnected, 303:Speech synthesis failed, 304:Voice recognition failed, 305:Internal server error(UIP), 306:Internal server error(Voice Operator) |
string |
dtmf detection (dtmfDetection)
Instructs DTMF detection on an incoming call in response to a Voice Operator.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| linenumber |
Line number |
Line number (parameter received from Voice Operator) |
True |
string |
| callerphonenumber |
Caller ID |
Caller ID (parameter received from Voice Operator) |
True |
string |
| uipinterfaceurl |
Destination URL |
Destination URL of command (parameter received from Voice Operator) |
True |
string |
| messagetext |
Message text |
Text to speech synthesis |
False |
string |
| timeout |
time out |
Call timeout value (unit: second, default: 300 seconds) |
False |
string |
| dtmfType |
DTMF type |
DTMF detection type (one digit: 1, fixed length: 2, variable length: 3. default: 1) |
False |
string |
Response Properties
| Name |
Description |
Type |
| dtmfNumber |
User inputted numbers |
string |
| codenum |
100:Parameter error, 301:Url not found, 302:Call was disconnected, 303:Speech synthesis failed, 304:Voice recognition failed, 305:Internal server error(UIP), 306:Internal server error(Voice Operator), 307:DTMF detection failed |
string |
Release History
| Version |
Type |
Description |
Tracking # |
Date |
| 2.0.1 |
Initial |
First release in the Adapter Type store. |
|
|
| 2.0.5 |
New feature |
Add dtmfDetection command |
NAP-16282 |
|
| 2.0.9 |
Maintenance |
Updated third-party components and improved maintainability. |
NAP-11518 |
|
| 2.0.10 |
Maintenance |
Updated third-party components and improved maintainability. |
NAP-23945 |
2022-12-01 |
Categories