LaunchSMS method

Last Updated : Mar 06, 2019 |
Prolog information
This method starts the specified SMS type application and if successful, returns the Experience Portal session ID for the new session.
Note:
The launched applications is responsible for sending the SMS message using the information passed to the application.
Important:
The return values are described Return values.

Parameters

Parameter
Type
Description
to
String
Short code 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: 12345,23456,54321. (Mandatory)
message
String
Message to send. (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 sent to the Orchestration Designer app. Contains name value using semicolon (;) as delimiter, in the following format: name=value;name=;. (Optional)
smsParameters
String
Parameters to be sent to o SMSC. Contains name value using semicolon (;) as delimiter, in the following format: name=value;name=;. (Optional)
ucid
String
Unique caller ID. (Optional)
parentID
String
Caller’s session ID. (Optional)
requestTimeout
Integer
Time to wait for the request to finish. (In seconds)

Data returned

Parameter
Type
Description
sessionID_returned
String
If the request completed successfully, this return value contains the session ID string.