Compose interactive requests

The interactive web service calls give you the ability to start a Communications Manager ComposerUI for HTML5 composition run and obtain the result that the run produces.

Interactive requests require the implementation of a Communications Manager ComposerUI for HTML5 web application contained in a default Communications Manager installation. For details, see the Tungsten Communications Manager ComposerUI for HTML5 JavaScript API Web Developer's Guide.

If you installed Communications Manager with the ExampleWebApp!Install deployment parameter, a web application is available. You can reach this application through the following URL, where <communications manager server> and <port> are the server and port where Communications Manager Interactive is deployed.

http(s)://<communications manager server>:<port>/start/home.html 

This example link provides access to the login page of Communication Manager Designer and also gives you the ability to run an example interactive template.

InteractiveStart calls

There are two calls that start a new interactive run: one that produces a DOCX document, and one that produces a PDF document.

See ComposeDocxInteractiveStartV1 and ComposePdfInteractiveStartV1, respectively.

InteractiveGet calls

There are two calls that obtain the result of an interactive run: one for DOCX documents, and one for PDF documents.

See ComposeDocxInteractiveGetV1 and ComposePdfInteractiveGetV1, respectively.

InteractiveFinish calls

To remove any remaining server side data related to the composition run, use the ComposeInteractiveFinish call. The call also signals that interactive composition run is ended. See ComposeInteractiveFinishV1.