Adapter - Utility

This page describes version 2.0.7 of the adapter.

Overview

This adapter provides various functions that can be used within a workflow.





Commands

Pause (pause)

Wait (sleep) for the specified delay period before continuing to the next workflow step.

Request Properties

Name	Display	Description	Is Required	Type
delay	Delay	The number of milliseconds to delay (1 - 60,000)	True	string

Subtract DateTime (subtractDateTime)

Subtract value2 from value1 and return the result.

Request Properties

Name	Display	Description	Is Required	Type
value1	Value1	DateTime value1.	True	string
value2	Value2	DateTime value2.	True	string
resultType	Result Type	Unit of result, either 'Hour', 'Minutes' or 'Seconds'. Default is 'Seconds'.	False	string

Access Code (prependAccess)

Prepend access code for extension or outside call.

Request Properties

Name	Display	Description	Is Required	Type
callerNumber	Caller telephone number	string of caller's telephone number.	True	string
pattern	Extension digits pattern	string of pattern of caller telephone number to prepend access code. ex: for 4-digit extension, enter '^[\d]{{4}$'	False	string
accessCode	Access Code	string of access code to prepend to caller telephone number.	True	string

Response Properties

Name	Description	Type
normalizedCallerID	string of normalized caller number.	string
codenum	The code of result.	string

Country Code (prependCountryCode)

Prepend country code for outside call.

Request Properties

Name	Display	Description	Is Required	Type
callerNumber	Caller telephone number	string of caller's telephone number.	True	string
countryCode	Country code	string of country code of this system	True	string
lstripCharacters	Number to delete from first	Specify the numbers to be deleted from first separated by comma	False	string

Response Properties

Name	Description	Type
normalizedCallerID	string of normalized caller number.	string
codenum	The code of result.	string

Normalize to hypen (normalizeHypen)

Normalize telephone number from outside to hypen separated domestic code.

Request Properties

Name	Display	Description	Is Required	Type
callerNumber	Caller telephone number	string of caller's telephone number	True	string
countryCode	Country code	string of country code of this system	True	string

Response Properties

Name	Description	Type
normalizedCallerID	String of normalized caller number.	string
codenum	The code of result.	string

Normalize to paren (normalizeParen)

Normalize telephone number from outside to paren separated area code.

Request Properties

Name	Display	Description	Is Required	Type
callerNumber	Caller telephone number	string of caller's telephone number	True	string
countryCode	Country code	string of country code of this system	True	string

Response Properties

Name	Description	Type
normalizedCallerID	String of normalized caller number.	string
codenum	The code of result.	string

Normalize with space (normalizeSpace)

Normalize telephone number from outside to space separated area code.

Request Properties

Name	Display	Description	Is Required	Type
callerNumber	Caller telephone number	string of caller's telephone number	True	string
countryCode	Country code	string of country code of this system	True	string

Response Properties

Name	Description	Type
normalizedCallerID	String of normalized caller number.	string
codenum	The code of result.	string

Convert to E.164 (normalizeE164)

Normalize telephone number from outside to E.164 hypen separated code.

Request Properties

Name	Display	Description	Is Required	Type
callerNumber	Caller telephone number	string of caller's telephone number	True	string
countryCode	Country code	string of country code of this system	True	string

Response Properties

Name	Description	Type
normalizedCallerID	String of normalized caller number.	string
codenum	The code of result.	string

Convert to E.123 (normalizeE123)

Normalize telephone number from outside to E.123 space separated code.

Request Properties

Name	Display	Description	Is Required	Type
callerNumber	Caller telephone number	string of caller's telephone number	True	string
countryCode	Country code	string of country code of this system	True	string

Response Properties

Name	Description	Type
normalizedCallerID	String of normalized caller number.	string
codenum	The code of result.	string

Custom Normalization (normalizeCustom)

Normalize telephone number from customized formats.

Request Properties

Name	Display	Description	Is Required	Type
callerNumber	Caller telephone number	string of caller's telephone number	True	string
csvRules	Custom rules csv	CSV formatted custom rules. ex: enter '"^(8)(20)([\d]{{4})$", "$1-$2-$3"' to separate the extension numbers with the access code '820' at the beginning with a hyphen.	True	string

Response Properties

Name	Description	Type
normalizedCallerID	String of normalized caller number.	string
codenum	The code of result.	string

Escape Number (escapeNumber)

Escape character is added when the special character "\,<,>,;,#,(,)" is included. (ex: (090)9876-5432 to (090)9876-5432)

Request Properties

Name	Display	Description	Is Required	Type
callerNumber	Caller telephone number	String of caller's telephone number	True	string

Response Properties

Name	Description	Type
normalizedCallerID	String of normalized caller number.	string
codenum	The code of result.	string

Convert Schedule Range (ConvertScheduleRange)

Convert relative date/time which is spoken by user to absolute date/time.

Request Properties

Name	Display	Description	Is Required	Type
colloquialTime	Colloquial time	Colloquial relative time to get schedules.	True	string
TimeZone	TimeZone Information	IANA timezone. For Example: Japan: Asia/Tokyo.	True	string
DictionaryNext	Additional Next Dictionary	Multiple specifications can be separated by comma.	False	string
DictionaryNow	Additional Now Dictionary	Multiple specifications can be separated by comma.	False	string
DictionaryToday	Additional Today Dictionary	Multiple specifications can be separated by comma.	False	string
DictionaryIncrementOneDay	Additional Increment One Day Dictionary	Multiple specifications can be separated by comma.	False	string
DictionaryIncrementTwoDay	Additional Increment Two Day Dictionary	Multiple specifications can be separated by comma.	False	string
DictionaryDateTime	Additional DateTime format Dictionary	Multiple specifications can be separated by comma.	False	string

Response Properties

Name	Description	Type
codenum	Enable if command request fails.	string
start	Start Date. Format: yyyy-MM-ddTHH:mm:ssK	string
end	End Date. Format: yyyy-MM-ddTHH:mm:ssK	string
recognitionResult	Converted Type.	string

Release History

Version	Type	Description	Tracking #	Date
2.0.2	Initial	First release in the Adapter Type store.
2.0.5	Maintenance	Updated third-party components and improved maintainability.	NAP-11518
2.0.6	Maintenance	Updated third-party components and improved maintainability.	NAP-23945	2022-12-01
2.0.7	New feature & Maintenance	Multiply command added Updated third-party components and improved maintainability.	NAP-24623 NAP-27635	2024-07-31

Categories

• Utility
• Workflow Help