Additional Application Interface web service validations with Application Interface test client

Last Updated : Jun 05, 2026 |

About this task

Experience Portal supports Axis 2.0 web services that provides outcall functionality and the ability to launch CCXML and VXML applications.. It also provides functionality to send SMS and Email messages and the ability to launch SMS and Email applications.

Note:

Axis 2.0 uses Basic authentication. This applies to the Application Interface web service as well as the Application Logging web service.

The Application Interface test client supports the following parameters which you can use to validate or query the Application Interface web service:

Note:

Use the VPAppIntfClient <parameter> command. For example:

  • To query the resources: VPAppIntfClient -S sys-vpms-a1 -R 4

  • To launch a CCXML application: VPAppIntfClient -S 123.234.12.34 -R 2 -x tel: -C ccxmltest -t 15

  • To initiate an outcall and launch a VXML application: VPAppIntfClient -S sys-vpms-a1 -R 1 -T 1234 -F 1122 -A test -t 10

  • To send an event to a CCXML application: VPAppIntfClient -S sys-vpms-a1 -R 3 -s sys-mpp-a12-2006286000025-26 -e

  • To send an SMS message: VPAppIntfClient -S sys-vpms-a1 -n user1 -p password1 -R 8 -T 4085551212 -F 114171631 -A MySMSAppName -M this-is-a-test-message -t 30 -s 1234567890

    Note:

    To use an application in the specific zone while sending or launching an SMS or Email message/application, prefix the zoneID to the application name (zoneID:ApplicationName) in the command. If you do not specify the zone in the command, the default zone (0) is used automatically. For example:

    VPAppIntfClient -S sys-vpms-a1 -n user1 -p password1 -R 8 -T 4085551212 -F 114171631 -A 0:MySMSAppName -M this-is-a-test-message -t 30 -s 12345678900

  • To launch an SMS application: VPAppIntfClient -S sys-vpms-a1 -n user1 -p password1 -R 7 -T 114171631 -A MySMSAppName -M another-test-message -t 30 -s 1234567891

  • To send an Email message: VPAppIntfClient -S sys-vpms-a1 -n user1 -p password1 -R 10 -T destination@email.com -F senders-email@mycorp.com -A MySMSAppName -B this-is-a-test-email -t 30 -J Subject:-Test-Message -s 1234567897

  • To launch an Email application: VPAppIntfClient -S sys-vpms-a1 -n user1 -p password1 -R 9 -T connection-senders-email@mycorp.com -F myemail@email.com -A MySMSAppName -B this-is-a-test-email -t 30 -J Subject:-Test-Message -s 1234567899

Parameter

Description

Function

-S

server-name

Sets the server-name or IP address where the EPM Application Interface Web Service is running. The default is “localhost”.

-R

request

Sets the request type that will be issued. Using the following definitions:

1 = LaunchVXML

2 = LaunchCCXML

3 = SendCCXMLEvent

4 = QueryResources

5 = GetStatus

5 = GetStatusEx

7 = LaunchSMS,

8 = SendSMS,

9 = LaunchEmail,

10 = SendEmail

11 = CreateConversation

12 = DeleteConversation

13 = GetConversation

14 = UpdateConversation

15 = GetConversationByAlias

16 = AddConversationAlias

17 = LaunchHtml

The default is “4”.

-X

count

Issues the request in asynchronous mode. Count is the number of requests to send. The default value is synchronous with a count of 1. Valid only for LaunchVXML and LaunchCCXML.",

-Q

size

Specifies the queue size when sending asynchronous requests. The default value is 10. Valid only for LaunchVXML and LaunchCCXML.",

-T

toURI / to

Sets the toURI / to value that is used when sending requests. The default value is "tel:2100". For LaunchVXML the number can be prefixed with "tel:", "sip:", or "sips" as a suggestion of the type of resource to use.

-F

fromURI/ from

Sets the from URI/from value that is used when sending requests. The default value is "1234567".

-A

applicationName

Sets the application name value that is used when LaunchVXML,SMS and Email requests are sent. The default value is "test".

-C

applicationName

Sets the application name value that is used when", LaunchCCXML requests are sent. The default value is "ccxmltest".

-U

appURLParams

Sets the application URL parameters that will be used when LaunchVXML or LaunchCCXML requests are sent.

The default value is null.

-P

parameters / appParameters

Sets the parameters values that will be used when LaunchVXML, LaunchCCXML, and SendCCXMLEvent requests are sent. The default value is null. Sets appParameters field for LaunchSMS and LaunchEmail. For LaunchEmail use this field to pass Attachments, ReplyTo, and other parameters.

-u

uuiInfo / ucid

Sets the user to user information parameters that will be passed when LaunchVXML or LaunchCCXML requests are sent. The default value is null. Sets ucid for LaunchSMS, SendSMS, LaunchEmail and SendEmail requests.

-t

timeout

Sets the timeout value that is used when LaunchVXML or LaunchCCXML requests are sent. The default value is "30" seconds.Sets requestTimeout for LaunchSMS, SendSMS, LaunchEmail and SendEmail requests.

-z

zone

Sets the string that is used as the zone.

-x

hint

Sets the string that is used as a hint for what type of resources are going to be needed by the CCXML application. Values should be "tel:", "sip:", or "sips". The default value is "tel".

-s

sessionId/ parentID

Sets the session ID string that is used when sending events to a CCXML application using the request SendCCXMLEvent. Sets the session ID for SendSMS and SendEmail. Sets parentID field for LaunchSMS and LaunchEmail.

-e

eventName

Sets the event name string that is used when sending events to a CCXML application using the request SendCCXMLEvent.

-n.

name

Sets the user name for the authenticated request. The user name must be configured as an Experience Portal user with the Web Services role in the EPM -> Users page.

The default value is "outcall".

-p

password

Sets the password for the authenticated request. The default value is "ocpassword1".

-y

authenticateType

Sets the authentication type for the user. The authenticateType can be password, certificate, or password+certificate.

By default, the authenticateType is password.

If the authenticateType is certificate, there is no need to set user name and password.

-k

clientKeyStoreFile

Sets the client keystore file in JKS format for certificate authenticated request. The keystore should have the client certificate private key and public certificate. It should also have the signing CA if the client certificate is signed by third-party CA. The whole chain of public certificates needs to be imported to the EPM trusted certificates page under the User category.

-o

clientKeyStorePasswd

Sets the password for the client keystore file.

-K

truststoreFile

Sets the truststore file (full path) in JKS format with all the trusted certificates.

On the Primary EPM, the value EPM_TRUSTSTORE can be specified to use the Primary EPM's truststore.

-O

truststorePasswd

Sets the password for the truststore file.

On the Primary EPM, the value EPM_TRUSTSTORE_PASS can be specified to use the password for the Primary EPM's truststore.

-M

message

Sets the message to send in the LaunchSMS or SendSMS request. This tool does not work with spaces in this field. Use a character like '.' or '-' instead.

-m

smsParameters

Sets the SMS parameters sent in the LaunchSMS or SendSMS request.

-c

cc

Sets the email CC field for the LaunchEmail or SendEmail request.

-b

bcc

Sets the email BCC field for the LaunchEmail or SendEmail request.

-a

attachments

Sets the email attachments field for the LaunchEmail or SendEmail request.

-H

headers

Sets the email headers field for the LaunchEmail or SendEmail request.

-J

subject

Sets the email subject field for the LaunchEmail or SendEmail request. This tool doesn't work with spaces in this field. Use a character like '.' or '-' instead.

-B

body

Sets the email body field for the LaunchEmail or SendEmail request.

-E

emailParameters

Sets the email emailParameters field for the LaunchEmail or SendEmail request. For SendEmail use this field to pass Attachments, ReplyTo, and other parameters."

-Z

automated

Sets the test into automated mode. The value for this parameter is the number of iterations to perform. The default is 0.

-D

conversationData

Sets the conversationData field for CreateConversation and UpdateConversation.

-I

conversationId

Sets the conversationId field for CreateConversation and DeleteConversation.

-i

alias

Sets the alias field for GetConversationByAlias and AddConversationAlias.

-d

debugLevel

Sets the global debug level for logging output. Valid values are OFF, ERROR, WARN, INFO, and DEBUG.

-h

Displays help and then exits the application.

-v

Displays version information and then exits.