To create a comment assessment for a conversation

GET /v1/Insights/QualityManagement/Assessments/Comments

To create a comment assessment for a conversation

Headers

  • Authorization string

    The Authorization HTTP request header

Query parameters

  • SegmentId string

    The id of the segment.

  • AgentId string

    The id of the agent.

  • PageSize integer(int64)

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

  • Page integer

    The page index. This value is simply for client state.

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • comments array[object]
      Hide comments attributes Show comments attributes object
      • account_sid string | null

        The SID of the Account that created the Flex Insights resource and owns this resource.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • assessment_sid string | null

        The SID of the assessment.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FM[0-9a-fA-F]{32}$.

      • comment

        The comment added for assessment.

      • offset number | null

        The offset

      • report boolean | null

        The flag indicating if this assessment is part of report

      • weight number | null

        The weightage given to this comment

      • agent_id string | null

        The id of the agent.

      • segment_id string | null

        The id of the segment.

      • user_name string | null

        The name of the user.

      • user_email string | null

        The email id of the user.

      • timestamp number | null

        The timestamp when the record is inserted

      • url string(uri) | null
    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v1/Insights/QualityManagement/Assessments/Comments
curl \
 --request GET 'https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments' \
 --user "username:password" \
 --header "Authorization: string"
Response examples (200)
{
  "meta": {
    "key": "comments",
    "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "comments": [
    {
      "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "offset": "0.0",
      "report": true,
      "weight": "1",
      "comment": {
        "comment": "log0zu0268",
        "category": {
          "name": "Good for Training",
          "category_id": "c9ba34ca-7174-4dcd-ab3e-91fbb1932f1e"
        }
      },
      "agent_id": "5d80ee80-7608-55df-b2b2-5ab5608b9831",
      "timestamp": "1657329694199",
      "user_name": "Linda Houghton",
      "segment_id": "0105be7a-9b87-51f1-8df8-aa74ddb9c4a7",
      "user_email": "linda.houghton@vacasa.com",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "assessment_sid": "FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ]
}
{
  "meta": {
    "key": "comments",
    "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?AgentId=5d80ee80-7608-55df-b2b2-5ab5608b9831&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?AgentId=5d80ee80-7608-55df-b2b2-5ab5608b9831&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "comments": [
    {
      "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "offset": "0.0",
      "report": true,
      "weight": "1",
      "comment": {
        "comment": "log0zu0268",
        "category": {
          "name": "Good for Training",
          "category_id": "c9ba34ca-7174-4dcd-ab3e-91fbb1932f1e"
        }
      },
      "agent_id": "5d80ee80-7608-55df-b2b2-5ab5608b9831",
      "timestamp": "1657329694199",
      "user_name": "Linda Houghton",
      "segment_id": "0105be7a-9b87-51f1-8df8-aa74ddb9c4a7",
      "user_email": "linda.houghton@vacasa.com",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "assessment_sid": "FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ]
}
{
  "meta": {
    "key": "comments",
    "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "comments": []
}