Add assessments against conversation to dynamo db. Used in assessments screen by user. Users can select the questionnaire and pick up answers for each and every question.

POST /v1/Insights/QualityManagement/Assessments

Headers

Authorization string

The Authorization HTTP request header

application/x-www-form-urlencoded

Body

CategorySid string Required

The SID of the category

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

The name of the category
SegmentId string Required

Segment Id of the conversation
AgentId string Required

The id of the Agent
Offset number Required

The offset of the conversation.
MetricId string Required

The question SID selected for assessment

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

The question name of the assessment
AnswerText string Required

The answer text selected by user
AnswerId string Required

The id of the answer selected by user
QuestionnaireSid string Required

Questionnaire SID of the associated question

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

Responses

201 application/json

Created
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
- account_sid string | null
  
  The unique SID identifier of the Account.
  
  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}$.
- offset number | null
  
  Offset of the conversation
- 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
  
  Segment Id of conversation
- user_name string | null
  
  The name of the user.
- user_email string | null
  
  The email id of the user.
- answer_text string | null
  
  The answer text selected by user
- answer_id string | null
  
  The id of the answer selected by user
- assessment
  
  Assessment Details associated with an assessment
- timestamp number | null
- url string(uri) | null

POST /v1/Insights/QualityManagement/Assessments

curl \
 --request POST 'https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --header "Authorization: string" \
 --data 'Offset=6.985619&AgentId=583fcaa6-a4ef-5447-9077-900421e37a61&AnswerId=ed8697d3-558d-46c3-9b73-cd21cd93cbb3&MetricId=GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&AnswerText=Fair&MetricName=Active+listening&CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&CategoryName=Good+for+Training&QuestionnaireSid=GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'

Request example

{"Offset"=>"6.985619", "AgentId"=>"583fcaa6-a4ef-5447-9077-900421e37a61", "AnswerId"=>"ed8697d3-558d-46c3-9b73-cd21cd93cbb3", "MetricId"=>"GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "SegmentId"=>"dbdf1f7b-c776-5e78-9676-98a397fb3cdc", "AnswerText"=>"Fair", "MetricName"=>"Active listening", "CategorySid"=>"FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "CategoryName"=>"Good for Training", "QuestionnaireSid"=>"GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}

Response examples (201)

{
  "url": "https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "offset": "0.0",
  "report": true,
  "weight": "1",
  "agent_id": "5d80ee80-7608-55df-b2b2-5ab5608b9831",
  "answer_id": "ed8697d3-558d-46c3-9b73-cd21cd93cbb3",
  "timestamp": "1657329694199",
  "user_name": "Supervisor",
  "assessment": {
    "questionnaire": {
      "name": "Customer Experience",
      "question": {
        "name": "Active listening",
        "category": {
          "name": "Good for Training",
          "category_sid": "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        "question_sid": "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
      },
      "questionnaire_sid": "GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  },
  "segment_id": "dbdf1f7b-c776-5e78-9676-98a397fb3cdc",
  "user_email": "supervisor@example.com",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "answer_text": "Fair",
  "assessment_sid": "FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}