Best practices

Last Updated : Jun 05, 2026 |

When using the Application Interface web service, keep in mind that:

  • The Axis 2.0 Application Interface web service uses Basic Authentication to authenticate web service client requests. When you submit a request to the web service, you need to include the user name and password that is configured as one of the Experience Portal users and that user must have the Web Services role checked.

  • If non-ASCII characters are sent in the URL request to the web service they should be encoded as UTF-8 prior to sending the request.

    For example, an application name of ‘aña’ is encoded and sent as ‘a%C3%B1a’. Note that the non-ASCII character ‘ñ’ is sent as the UTF-8 value of ‘%C3%B1’.

  • A non zero timeout value should be specified when using the LaunchVXML method. If no timeout value is passed, or if the value is 0, then a default value of 120 seconds will be used.

  • For the methods LaunchCCXML, LaunchVXML, LaunchSMS, LaunchEmail, SendSMS, and SendEmail, parameters must be passed as name value pairs. For example, parameter1=value.

    Each name value pair is separated by semicolon. If a value of the specific parameter has multiple values, those values should be separated by comma (,). If the value contains a semicolon (;), you must escape it by using \;

  • If you plan to use a single CCXML application to start multiple outgoing calls simultaneously, keep in mind that each application is handled by a single MPP, which means that each application is limited to the number of ports available on the MPP to which it is assigned. While the Application Interface web service tries to select the best MPP to handle the call, the application must have a way to verify the number of available ports so that it does not exceed the resources available on the MPP.

    If you want to make additional calls, you can either:

    • Start one additional instance of the CCXML call blast application for each additional MPP in the system.

    • Use the QueryResources method to check the available resources and start another instance of the CCXML call blast application as soon as enough resources are available.

  • If your Experience Portal EPM software runs on a dedicated server machine, you should configure a auxiliary EPM server to handle Application Interface web service requests if the primary EPM server is unavailable.