API Add Comment - Revision history

IVSWikiBlue: /* Response */

2025-07-18T18:24:01Z

‎Response

IVSWikiBlue: /* Response */

2025-07-18T18:23:26Z

‎Response

IVSWikiBlue: /* Response */

2025-07-18T18:23:07Z

‎Response

IVSWikiBlue at 14:56, 16 April 2025

2025-04-16T14:56:48Z

IVSWikiBlue: Created page with "This API call will add a new commentto the specified recording. This call can be used on a recording in progress. ===Resource URL===

http://valt.example.com/api/v3/recor..."

2024-10-09T15:42:22Z

Created page with "This API call will add a new commentto the specified recording. This call can be used on a recording in progress. ===Resource URL=== <pre>http://valt.example.com/api/v3/recor..."

New page

This API call will add a new commentto the specified recording. This call can be used on a recording in progress.

===Resource URL===
<pre>http://valt.example.com/api/v3/records/{recordid}/comments</pre>
''Replace {recordid} with the actual id number of the record. Records given a unique UUID when started.''

===Resource Information===
{|class="wikitable"
|'''Method'''
|POST
|-
|'''Headers'''
|Content-Type:application/json
|-
|'''Response Type'''
|JSON
|-
|'''Authentication Required'''
|Yes
|}

===Parameters===
The JSON body must be properly formatted. All fields and values should be enclosed in double quotes and separated by a colon.
{|class="wikitable"
!colspan="2"|Field Name
!Description
!Required
!Example
|-
|colspan="2"|'''event'''
|Comment Text
|yes
|Confession
|-
|colspan="2"|'''time'''
|Time index in seconds in the recording where the comment will be inserted. An invalid time index can cause an error with the API call.
|yes
|127
|}

===Response===

{|class="wikitable"
!Code
!Reason
|-
|200
|Comment Added Successfully
|-
|400
|Invalid Request (See Response for Specific Error)
|-
|401
|Unauthorized
|-
|500
|JSON Body Formatted Incorrectly
|}

{|class="wikitable"
|+JSON Response
!colspan="2"|data
|-
|'''comment_add'''
|true = comment added successfully, false = comment could not be added
|-
|'''time'''
|Time index for new comment.
|-
|'''message'''
|Detailed Status Message
|}

==Examples==
===Request===
The sample JSON body below is formatted with line breaks and indentation to make it easier to read. This is '''not''' required.
<pre>https://ivstest1.ad.ipivs.com/api/v3/records/616/comments?access_token=e82632d19c523678fea3d1016c6df9e9</pre>
<nowiki>
{
"event":"API Comment",
"time": 30
}
</nowiki>

===Successful Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"data":{
"comment_add": true,
"message": "comment add",
"time": 30
}
}
</nowiki>

===Failure Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"error":{
"code": 500,
"message": "Internal Server Error"
}
}

</nowiki>

← Older revision		Revision as of 14:56, 16 April 2025
Line 1:		Line 1:
−	This API call will add a new ~~commentto~~ the specified recording. This call can be used on a recording in progress.	+	This API call will add a new comment to the specified recording. This call can be used on a recording in progress.

	===Resource URL===		===Resource URL===

@@ Line 63: / Line 63: @@
 |-
 |'''comment_add'''
-|"true" = comment added successfully, <br>"false" = comment could not be added
+|<b>true</b> = comment added successfully, <br><b>false</b> = comment could not be added
 |-
 |'''time'''