Parameters
This method starts the specified email type application and if successful, returns the Experience Portal session ID for the new session.
Note:
The launched applications is responsible for sending the email message using the information passed to the application.
Important:
For more details on the return values, see Return values.
Parameter |
Type |
Description |
to |
String |
Email address that is configured on the system and can be used by the application being launched. |
from |
String |
Multiple values, using a comma (,) as a delimiter, that can be used by an application. For example: john@abc.com,sam@abc.com,bob@abc.com. |
cc |
String |
Email CC. You can specify multiple values using a comma (,) as a delimiter. For example: john@abc.com,sam@abc.com,bob@abc.com. (Optional) |
bcc |
String |
Email BCC. You can specify multiple values using a comma (,) as a delimiter. For example: john@abc.com,sam@abc.com,bob@abc.com. (Optional) |
subject |
String |
The subject of the message. (Optional) |
body |
String |
Body of the message. (Optional) |
attachments |
String |
A list of attachment URLs, separated by a comma (,). (Optional) |
headers |
String |
Contains name value in this format: name=value;name=value with a semicolon (;) as delimiter. Content-Type, Reply-To etc can be specified as headers. (optional) |
applicationName |
String |
Name of the application to be launched. Contains zone information in the format zoneId:appName.
Important:
The applicationName must match the name that was specified when the application was added to Avaya Experience Portal through the EPM.
For an application that is assigned to a non-default zone, include the zone information using the format: ZoneId:applicationName
You can view all application names on the Applications page.
You can retrieve the zone Id information using the getZoneInfo method of the Management Interface web service.
|
appParameters |
String |
Parameters to be send to Orchestration Designer App. Contains name value in this format: name=value;name=; with ; as delimiter. (optional) |
emailParameters |
String |
Parameters to be send to Orchestration Designer App. Contains name value in this format: name=value;name=; with ; as delimiter. See table below for parameters. (optional) |
ucid |
String |
Unique customer ID. (Optional) |
parentID |
String |
Caller’s session ID. (Optional) |
requestTimeout |
Integer |
Time to wait for the request to finish. (In seconds) |
