API Add Comment

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

Resource URL

http://valt.example.com/api/v3/records/{recordid}/comments

Replace {recordid} with the actual id number of the record. Records given a unique UUID when started.

Resource Information

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.

Field Name		Description	Required	Example
event		Comment Text	yes	Confession
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

Code	Reason
200	Comment Added Successfully
400	Invalid Request (See Response for Specific Error)
401	Unauthorized
500	JSON Body Formatted Incorrectly

JSON Response

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.

https://ivstest1.ad.ipivs.com/api/v3/records/616/comments?access_token=e82632d19c523678fea3d1016c6df9e9

{
  "event":"API Comment",
  "time": 30
}

Successful Response

Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.

{
"data":{
"comment_add": true,
"message": "comment add",
"time": 30
}
}

Failure Response

Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.

{
"error":{
"code": 500,
"message": "Internal Server Error"
}
}