How it Works

The CCXML API uses HTTP or HTTPS with a GET or POST request.

The GET/POST request has to be sent to:

http://<brm>:<port>/api/v1/bvr/ccxml/basichttp

https://<brm>:<port>/api/v1/bvr/ccxml/basichttp

Where <brm> is the address of the BRM machine and <port> is the HTTP or HTTPS port configured in BRM here: HTTP API Configuration Options.

When using a GET request the attributes are passed as part of the URI. This takes the form of:

http://<brm>:<port>/api/v1/bvr/ccxml/basichttp?sessionId=<sessionId>&name=<name>&eventSource=<eventSource>&<parameterName>=<parameterValue>

<sessionId> is the mandatory full CCXML session id.
<name> is the mandatory event name. The event name is composed of alphanumeric and "." (dot) characters only. The first character must not be a dot or digit.
<eventSource> is the optional URI to which events may be sent (i.e. it may be used as the value of the target attribute in a <send> element).
<parameterName> and <parameterValue> are name/value pairs that are passed to the CCXML application as event parameters.

The full CCXML session id can be accessed from the session variable session.fullid of the running CCXML application. The CCXML API requests are sent to the BRM which picks the correct BVR from the full CCXML session id and forwards the requests to that BVR's CCXML session.

When using a POST request the content must contain a specific set of JSON as described here JSON Request Format.