You are here: Communications Cloud API v1 > Resources > Subscriber Questions

Subscriber Questions

Your organization can include questions during the subscription process for the purpose of gathering information about your subscribers. In the administrator interface, these questions can be configured to appear for a subscriber based on their topic subscriptions. By default, these appear on a questions page. The Subscriber Questions resource accepts GET operations only. Thus, you will not need to include any Input in your call.

You might use the Subscriber Questions resource to display these questions somewhere else, like your website. You can also use this resource to return subscriber responses to questions or return a list of questions that are displayed for a particular subscriber.

Methods

ClosedClick to view
Method Description Required Permissions
List Questions for an Account

Use this method to return all questions that have been configured for any subscription topics under your account and are not tied to a specific topic. Only questions that are enabled are included. In the output, the question IDs are Base64-encoded. This output does not include the actual question text or other question details (such as whether the question is free text or multiple choice). To see these details, use the question ID returned in this output and send that ID through the Read a Single Question method.
  • List Questions
List Questions for a Subscriber

Use this method to return all questions that would appear for a subscriber based on their current subscriptions. Only questions that are enabled are included. In the output, the question IDs are Base64-encoded. This output does not include the actual question text or other question details (such as whether the question is free text or multiple choice). To see these details, use the question ID returned in this output and send that ID through the Read a Single Question method.
  • List Questions
List Questions for a Topic

Use this method to return all questions that would appear for any subscriber who has subscribed to a particular topic. Only questions that are enabled are included. In the output, the question IDs are Base64-encoded. This output does not include the actual question text or other question details (such as whether the question is free text or multiple choice). To see these details, use the question ID returned in this output and send that ID through the Read a Single Question method.
  • List Questions
Read a Single Question

Use this method to read the text of a particular question or see details about the question, such as whether the question requires a free-text or multiple choice answer.  This method returns all answers. 
  • Read Question

Elements

ClosedClick to view
<questions> This element is the container for all subscriber questions. It contains the type="array" attribute, and each individual question will be nested in a <question> element.
<question> This element contains an individual question returned in the output. Additional information about the question can be found in nested elements.
<link> This element contains the link to the question returned in the output. This information is contained in the rel="self" and href="[LINK]" attributes.
<columnar> This element contains a value of either true or false, and thus also contains the type="boolean" attribute. If this element's value is set to true, it means that a subscriber can select multiple answers for this question.
<enabled> This element indicates whether the question is question is enabled to appear to subscribers. It contains the type="boolean" attribute, and a value of True indicates that it is enabled.
<name> This element contains the name or title of a question. This name appears in the administrative interface for organizing questions.
<position> This element indicates the position of either a question or an answer. If a question or answer is assigned a position, it will determine where in the list of questions or answers it will appear. Questions and answers with an assigned position appear above those without an assigned position. The lower the number, the higher in the list. This element contains the type="integer" attribute and may contain that nil="true" attribute if the question or answer has not been assigned a position.
<question-text> This element contains the text of the question.
<response-count> This element contains the number of responses that have been collected for the question. Because the value is a number, this element contains the type="integer" attribute.
<response-field-size> This element is pertinent for free-text questions. It indicates the size of the field where subscribers enter their answers: either short single-line text field, long single-line text field, or multi-line text area.
<response-type>
<select-box> This element contains the type="boolean" attribute.
<to-param> This element appears for both questions and answers, containing the ID for that object. This ID has been base-64 encoded.
<answers> This element is the container for all answers provided for a question. It contains the type="array" attribute, and each individual answer will be nested in an <answer> element.
<answer> This element contains an individual answer returned for a question in the output. Additional information about the answer can be found in nested elements.
<answer-text> This element contains the text of the answer provided by the subscriber.
Related Topics IconRelated Topics

 

Was this page helpful? Can't find what you need? Let us know

Open topic with navigation