Maintenance Notice - PDF Generation
Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.


Note: Access to static files, including PDF files that are not dynamically generated from our web-based content, is unaffected.

Jump to: navigation, search

Subscribe

This operation is part of the Digital User Events API section of the Web Services API.

Overview

This request subscribes to Interaction Server user events.

Request URL /api/v2/me/multimediaevents
HTTP Method POST
Required Features api-multimedia

Parameters

Parameter Value
operationName Subscribe
topics List of user defined topics to which to subscribe.


This request involves sending a JSON body as well as adhering to the URL path listed above.

POST api/v2/me/multimediaevents


The following is a possible valid JSON for the request:

{
   "operationName": "Subscribe",
   "topics": [
       "topic_0",
       "topic_1"
   ]
}

Response

The response consists of an HTTP response and a CometD response.

HTTP response

{
   "statusCode": 0,
   "referenceId": 7,
}

CometD response

{
   "stateResource": "Subscribed",
   "referenceId": 7,
   "topics": [
       "topic_0",
       "topic_1"
   ],
   "messageType": "MultimediaEventSubscriptionStateChangeMessage"
}
This page was last edited on January 27, 2017, at 19:01.

Feedback

Comment on this article:

blog comments powered by Disqus