{
  "opencollection": "1.0.0",
  "info": {
    "name": "Helpcenter CallComments API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "CallComments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a call comment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/calls/:callId/comments/:commentId",
            "params": [
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Secondary information related to the comments. Value allowed is @mentions@, which returns the details of users mentioned in the comments."
              },
              {
                "name": "callId",
                "value": "",
                "type": "path"
              },
              {
                "name": "commentId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API fetches a call comment from the portal."
        },
        {
          "info": {
            "name": "Update a call comment",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v1/calls/:callId/comments/:commentId",
            "params": [
              {
                "name": "callId",
                "value": "",
                "type": "path"
              },
              {
                "name": "commentId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API updates an existing call comment."
        },
        {
          "info": {
            "name": "List all call comments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/calls/:entityId/comments",
            "params": [
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Secondary information related to the comments. Value allowed is @mentions@, which returns the details of users mentioned in the comments."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "No. of comments to fetch"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number starting from which the comments must be fetched"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Sort comments by the @commentedTime@ attribute. The default sorting order is ascending. A @-@ prefix denotes descending order of sorting."
              },
              {
                "name": "entityId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API lists a particular number of comments recorded on a call, based on the limit specified."
        },
        {
          "info": {
            "name": "Create a call comment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/calls/:callId/comments",
            "params": [
              {
                "name": "callId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API adds a comment to a call."
        }
      ]
    }
  ],
  "bundled": true
}