Reviews and Comments - API Reference

Reviews and Comments

A blog comment or product review uses the same engine. Each record may have a rating, as well as an optional comment, and is linked to an object and the person who posted it

End Point URL

https://api.cms-tool.net/webapps/api/comments

API Parameters and Filters

Name	Description	Example	Optional	Data type
data	The JSON you would like to POST. This can be POST content also	{ }	Yes	json object
id	Search a specific comment by it's id	id=123	Yes	int
mbr_id	The member who has commented	mbr_id=111	Yes	int
msg_show	Filter comments which are marked to show	msg_show = "yes"	Yes	string
postedAfter	Filter comments which were posted before the time provided.	postedAfter="2021-01-01"	Yes	string
postedBefore	Filter comments which were posted before the time provided.	postedBefore="2021-12-31"	Yes	string
re_info_id	Enquiry about a specific blog's comments	re_info_id=1231234	Yes	int
re_pid	Enquiry about a specifc product's reviews	re_pid=102212	Yes	int
re_eventid	Enquiry about a specific event's reviews	re_eventid=12312	Yes	int

Data Dictionary

Key	Definition	Type	Format
msg_id	ID Unique comment ID	Integer (Unique ID)	e.g. 123456
cid	Site ID Website ID	int	e.g. 123456
forum_info_id	Blog ID Related object ID if comment is attached to a blog	int
forum_listingid	Listing ID Related object ID if comment is attached to a directory listing	int
forum_pid	Product ID Related object ID if comment is attached to a product	int
forum_re_bid	Basket ID If this review occured after placing a specifc order, aka order validated referral	int
forum_re_order	Order Number Legacy - If this review occured after placing an order, using text order numbers	text
forum_reply_count	Reply Count How many replies to the specified comment	int
forum_reply_last	Last Reply Timestamp of the last reply to this comment	timestamp	e.g. 2025-12-31 23:59:59
mbr_uid	Member ID Author ID who made this comment	int
msg_author	Author Name Author Name - Alias / Psudeonym	text
msg_email	Author Email Author Email to whom replies should be sent	text
msg_group_id	Forum Group ID When forum is split into category groups	int
msg_notifyreplies	NotifyReplies If the author wants to be notified by email of any replies	char
msg_photo	Photo Optional photo included with the comment	text
msg_posted	Posted Timestamp The timestamp when this comment was made	timestamp	e.g. 2025-12-31 23:59:59
msg_rating	Rating If this comment is a review for which a rating is provided, the rating would be a number from 1-5 or 0 if no rating given	int
msg_re	Regarding Comment ID The original comment ID to which this reply is being made.	int
msg_response_merchant	Response Merchant The response by the merchant / webmaster to a users comment if applicable.	text
msg_show	Enabled Y - if this comment is publically visible, otherwise blank	char
msg_text	Comment Text The main text of the comment	text
msg_title	Comment Title The title of the comment	text
msg_url	Link URL Optional URL to a reference link	text
page	Page ID The ID of the page on which this comment is related, being the parent page of whatever object this relates to.	int	e.g. 123456

Usage Instructions and Examples

Create a new Comment

To create a new comment use POST method and do not provide any Comment Id.

For the comment to show up on your site include the page id (can be found from GET data). and set "msg_show": "Y"

Must include: mbr_id or msg_email.

For the review to show on your product page include the forum_pid as the product id of the product.

Example:

{

"msg_text": "Comment text",

"msg_email": "example@email.com",

"msg_title": "Comment title",

"page": 1234

}

Update an existing comment

You can also update an existing Comment. You must include id, mbr_id or msg_email. The rest of the parameters provided will be used to update the Comment.

Example:

{
  "id": 12345,
  "msg_text" : "The message has been updated" ...
}

Sample Object


{"msg_posted":"2021-12-17 16:50:19.340045",
"forum_info_id":0,
"msg_title":"New test review",
"msg_group_id":0,
"mbr_id":123123,
"forum_pid":1111111,
"forum_reply_count":0,
"msg_notifyreplies":"N",
"msg_email":"test@testemail.co.nz",
"msg_re":0,
"msg_rating":4,
"id":123111,
"page":1111111,
"mbr_uid":123123,
"msg_show":"Y",
"msg_id":123111,
"cid":11111111
}