LoudVoice API \ Discussions

Resource/URI - Discussions GET POST PUT DELETE
Discussions /loudvoice/discussions.json List all discussions Create a discussion
Discussion /loudvoice/discussions/<discussion_token>.json /loudvoice/discussions/discussion.json?
discussion_reference=<discussion_reference>
Read a discussion Update a discussion Delete a discussion
Discussion messages /loudvoice/comments/<discussion_token>/comments.json /loudvoice/discussions/discussion/comments.json?
discussion_reference=<discussion_reference>
Read discussion comments
Resource/URI - Authors GET POST PUT DELETE
Authors /loudvoice/authors.json List all authors Create an author
Author /loudvoice/authors/<author_token>.json /loudvoice/authors/author.json?
author_reference=<author_reference>
Read an author Update an author Delete an author
Resource/URI - Author Sessions GET POST PUT DELETE
Author Sessions /loudvoice/authors/sessions.json Create/Update a session
Author Session /loudvoice/authors/sessions/<session_token>.json Delete a session
Resource/URI - Comments GET POST PUT DELETE
Comments /loudvoice/comments.json List all comments Create comment
Comment /loudvoice/comments/<comment_token>.json Read a comment Update comment Delete a comment

Discussions are collections of comments, usually displayed below a post, article or video. Each discussion is uniquely identified by a discussion_token.

Structure

Discussion nodes have the format below. Absent values are returned as null.

       "discussion": {
            "discussion_token": "#discussion_token#",
            "discussion_reference": "#discussion_reference#",
            "title": "#title#",
            "url": "#url#",
            "is_closed": #is_closed#,
            "is_trashed": #is_trashed#,
            "num_comments": #num_comments#,
            "date_last_comment": "#date_last_comment#",            
            "date_creation": "#date_creation#",
            "date_last_update": "#date_last_update#"
        }
    
Node Description
Discussion Identifiers
discussion_token
string, uuid, automatically generated, readonly
Unique identifier of the discussion.
Example: e570f17a-f018-49f2-be95-35dd31105c93
discussion_reference
string
This value is used to indicate which discussion needs to be displayed when embedding LoudVoice using our JavaScript API. The value must be unique amongst your discussions. If empty, the discussion cannot be embedded using the JavaScript API.
Example: PAGE-124
Discussion Metadata
title
string
Title of the page where the discussion is embedded.
Example: Article 123 discussion
url
string, uri
URL of the page where the discussion is embedded.
Example: https://docs.oneall.com/api/resources/loudvoice/discussion/
is_closed
boolean
Indicates whether the discussion is closed or not. If a discussion is closed, it will still be visible, but no more comments can be left.
Example : false
is_trashed
boolean
Indicates whether the discussion has been trashed or not. Thrashed discussion are not displayed and no comments can be left.
Example : false
num_comments
integer
Number of comments included in the discussion.
Example: 53
date_last_comment
string, RFC 2822
Date of the last comment.
Example: Wed, 14 Mar 2018 14:19:49 +0100
date_creation
string, RFC 2822
Date when the discussion was created.
Example: Wed, 14 Mar 2018 14:19:49 +0100
date_last_update
string, RFC 2822
Date when the discussion was updated last.
Example: Wed, 14 Mar 2018 14:19:49 +0100

User Contributed Notes