GET Comments
Find a conversation by custom ID
Uses the CustomID for the conversation supplied by the app to retrieve the conversation object.
Uses the CustomID for the conversation supplied by the app to retrieve the conversation object. It returns exactly one object or 404 if not found. This query is covered by an index and is performant.
URL Parameters
- customid : (Required) Locates a conversation using the custom ID.
Request
Parameters
Values in the path and query string.
appid path string TalkLabs ID required
The TalkLabs application ID assigned to your account.
Example:your-app-id CustomId query string customer-defined
A customer defined ID chosen by your application. TalkLabs stores it so you can retrieve the resource without keeping its TalkLabs ID.
Example:live-event-chat Response
Status codes
Every JSON response uses the API result envelope.
200 OK ApiResult 400 Bad Request ApiResult 403 Forbidden ApiResult 404 Not Found ApiResult 500 Internal Server Error ApiResult Example response · 200
{
"message": "Success",
"errors": {},
"data": {
"kind": "comment.conversation",
"appid": "5e9389ed38a2b10794e271ee",
"owneruserid": null,
"conversationid": "my_conversation_id",
"property": "sportstalk247.com/apidemo",
"moderation": "post",
"maxreports": 0,
"enableprofanityfilter": true,
"title": "Sample Conversation",
"maxcommentlen": 512,
"commentcount": 1,
"open": true,
"added": 1587437568,
"whenmodified": 1587438787,
"customtype": "",
"customid": "/articles/2020-03-01/article1/something-very-important-happened",
"customtags": [
"taga",
"tagb"
],
"custompayload": "{ num : 0 }",
"customfield1": "/sample/userdefined1/emojis/😂🤣❤😍😒",
"customfield2": "/sample/userdefined2/intl/characters/äöüÄÖÜß"
}
}