UpdateEvaluation

UpdateEvaluation updates an evaluation

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

evaluation

object (Evaluation)

evaluation

optional

Required - evaluation that is to be updated

evaluation_state

enum<string>

evaluation_state

optional

state of the current evaluation.

Allowed values:

EVALUATION_IN_PROGRESSEVALUATION_PASSEDEVALUATION_FAILED

completed_at

string <date-time>

completed_at

optional

time evaluation was completed

Examples:

1s1.000340012s

deleted_at

string <date-time>

deleted_at

optional

time evaluation was deleted

Examples:

1s1.000340012s

call_type

enum<string>

call_type

deprecated

call type of call being evaluated

Allowed values:

INBOUNDOUTBOUNDPREVIEWMANUALMAC

channel_type

enum<string>

channel_type

optional

Channel type of the evaluated transcript.

Allowed values:

CHANNEL_TYPE_EMAILCHANNEL_TYPE_SMSCHANNEL_TYPE_CHATCHANNEL_TYPE_VOICECHANNEL_TYPE_WHATSAPP

call_metadata

object (CallMetadata)

call_metadata

optional

conversation_metadata

object (ConversationMetadata)

conversation_metadata

optional

scorer_id

string

scorer_id

optional

user_id of person performing evaluation

score

number <double>

score

optional

calculated score as percentage to two decimal places

evaluation_sections

array[object (EvaluationSection) {11}]

evaluation_sections

optional

agent_user_id

string

agent_user_id

optional

user_id of the agent being evaluated

custom_fields

array[object (CustomField) {2}]

custom_fields

optional

Custom key-value fields.

deleted_by

string

deleted_by

optional

tcn user id of person who deleted evaluation

is_recoverable

boolean

is_recoverable

optional

whether the evaluation can be recovered or not.

evaluation_id

integer <int64> | string

evaluation_id

optional

unique id of the evaluation scorecard

scorecard_id

integer <int64> | string

scorecard_id

optional

id of evaluated scorecard

call_sid

integer <int64> | string

call_sid

deprecated

sid of the call being evaluated

transcript_sid

integer <int64> | string

transcript_sid

optional

optional - transcript sid associated with evaluation

update_mask

string

update_mask

optional

Required - specification of which fields should be updated

Example

{
    "evaluation": {
        "evaluation_state": "EVALUATION_IN_PROGRESS",
        "completed_at": "1s",
        "deleted_at": "1s",
        "call_type": "INBOUND",
        "channel_type": "CHANNEL_TYPE_EMAIL",
        "call_metadata": {
            "call_type": "INBOUND",
            "call_sid": 0
        },
        "conversation_metadata": {
            "conversation_sid": 0
        },
        "scorer_id": "string",
        "score": 0,
        "evaluation_sections": [
            {
                "deleted_at": "1s",
                "created_at": "1s",
                "points": 0,
                "possible_points": 0,
                "sort_order": 0,
                "evaluation_questions": [
                    {
                        "skipped": true,
                        "answers": [
                            {
                                "answer_points": 0
                            }
                        ],
                        "comment": "string",
                        "sort_order": 0,
                        "evaluation_question_id": 0,
                        "evaluation_id": 0,
                        "scorecard_question_id": 0,
                        "points": 0,
                        "evaluation_section_id": 0
                    }
                ],
                "auto_evaluation_questions": [
                    {
                        "risk_level": "RISK_LEVEL_NONE",
                        "passed": true,
                        "sort_order": 0,
                        "expression_matched": true,
                        "auto_evaluation_question_id": 0,
                        "auto_evaluation_id": 0,
                        "auto_evaluation_section_id": 0,
                        "auto_question_id": 0,
                        "flagged": [
                            0
                        ]
                    }
                ],
                "skipped": true,
                "evaluation_section_id": 0,
                "evaluation_id": 0,
                "section_id": 0
            }
        ],
        "agent_user_id": "string",
        "custom_fields": [
            {
                "key": "string",
                "field": "string"
            }
        ],
        "deleted_by": "string",
        "is_recoverable": true,
        "evaluation_id": 0,
        "scorecard_id": 0,
        "call_sid": 0,
        "transcript_sid": 0
    },
    "update_mask": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/scorecards/scorecards/updateevaluation' \
--header 'Content-Type: application/json' \
--data-raw '{
    "evaluation": {
        "evaluation_state": "EVALUATION_IN_PROGRESS",
        "completed_at": "1s",
        "deleted_at": "1s",
        "call_type": "INBOUND",
        "channel_type": "CHANNEL_TYPE_EMAIL",
        "call_metadata": {
            "call_type": "INBOUND",
            "call_sid": 0
        },
        "conversation_metadata": {
            "conversation_sid": 0
        },
        "scorer_id": "string",
        "score": 0,
        "evaluation_sections": [
            {
                "deleted_at": "1s",
                "created_at": "1s",
                "points": 0,
                "possible_points": 0,
                "sort_order": 0,
                "evaluation_questions": [
                    {
                        "skipped": true,
                        "answers": [
                            {
                                "answer_points": 0
                            }
                        ],
                        "comment": "string",
                        "sort_order": 0,
                        "evaluation_question_id": 0,
                        "evaluation_id": 0,
                        "scorecard_question_id": 0,
                        "points": 0,
                        "evaluation_section_id": 0
                    }
                ],
                "auto_evaluation_questions": [
                    {
                        "risk_level": "RISK_LEVEL_NONE",
                        "passed": true,
                        "sort_order": 0,
                        "expression_matched": true,
                        "auto_evaluation_question_id": 0,
                        "auto_evaluation_id": 0,
                        "auto_evaluation_section_id": 0,
                        "auto_question_id": 0,
                        "flagged": [
                            0
                        ]
                    }
                ],
                "skipped": true,
                "evaluation_section_id": 0,
                "evaluation_id": 0,
                "section_id": 0
            }
        ],
        "agent_user_id": "string",
        "custom_fields": [
            {
                "key": "string",
                "field": "string"
            }
        ],
        "deleted_by": "string",
        "is_recoverable": true,
        "evaluation_id": 0,
        "scorecard_id": 0,
        "call_sid": 0,
        "transcript_sid": 0
    },
    "update_mask": "string"
}'

Responses

🟢200OK

application/json

Success

Body

evaluation

object (Evaluation)

evaluation

optional

Evaluation represents a evaluated scorecard.
A Evaluation represents a single call and single agent that has been evaluated.

evaluation_state

enum<string>

evaluation_state

optional

state of the current evaluation.

Allowed values:

EVALUATION_IN_PROGRESSEVALUATION_PASSEDEVALUATION_FAILED

completed_at

string <date-time>

completed_at

optional

time evaluation was completed

Examples:

1s1.000340012s

deleted_at

string <date-time>

deleted_at

optional

time evaluation was deleted

Examples:

1s1.000340012s

call_type

enum<string>

call_type

deprecated

call type of call being evaluated

Allowed values:

INBOUNDOUTBOUNDPREVIEWMANUALMAC

channel_type

enum<string>

channel_type

optional

Channel type of the evaluated transcript.

Allowed values:

CHANNEL_TYPE_EMAILCHANNEL_TYPE_SMSCHANNEL_TYPE_CHATCHANNEL_TYPE_VOICECHANNEL_TYPE_WHATSAPP

call_metadata

object (CallMetadata)

call_metadata

optional

conversation_metadata

object (ConversationMetadata)

conversation_metadata

optional

scorer_id

string

scorer_id

optional

user_id of person performing evaluation

score

number <double>

score

optional

calculated score as percentage to two decimal places

evaluation_sections

array[object (EvaluationSection) {11}]

evaluation_sections

optional

agent_user_id

string

agent_user_id

optional

user_id of the agent being evaluated

custom_fields

array[object (CustomField) {2}]

custom_fields

optional

Custom key-value fields.

deleted_by

string

deleted_by

optional

tcn user id of person who deleted evaluation

is_recoverable

boolean

is_recoverable

optional

whether the evaluation can be recovered or not.

evaluation_id

integer <int64> | string

evaluation_id

optional

unique id of the evaluation scorecard

scorecard_id

integer <int64> | string

scorecard_id

optional

id of evaluated scorecard

call_sid

integer <int64> | string

call_sid

deprecated

sid of the call being evaluated

transcript_sid

integer <int64> | string

transcript_sid

optional

optional - transcript sid associated with evaluation

Example

{
    "evaluation": {
        "evaluation_state": "EVALUATION_IN_PROGRESS",
        "completed_at": "1s",
        "deleted_at": "1s",
        "call_type": "INBOUND",
        "channel_type": "CHANNEL_TYPE_EMAIL",
        "call_metadata": {
            "call_type": "INBOUND",
            "call_sid": 0
        },
        "conversation_metadata": {
            "conversation_sid": 0
        },
        "scorer_id": "string",
        "score": 0,
        "evaluation_sections": [
            {
                "deleted_at": "1s",
                "created_at": "1s",
                "points": 0,
                "possible_points": 0,
                "sort_order": 0,
                "evaluation_questions": [
                    {
                        "skipped": true,
                        "answers": [
                            {
                                "answer_points": 0
                            }
                        ],
                        "comment": "string",
                        "sort_order": 0,
                        "evaluation_question_id": 0,
                        "evaluation_id": 0,
                        "scorecard_question_id": 0,
                        "points": 0,
                        "evaluation_section_id": 0
                    }
                ],
                "auto_evaluation_questions": [
                    {
                        "risk_level": "RISK_LEVEL_NONE",
                        "passed": true,
                        "sort_order": 0,
                        "expression_matched": true,
                        "auto_evaluation_question_id": 0,
                        "auto_evaluation_id": 0,
                        "auto_evaluation_section_id": 0,
                        "auto_question_id": 0,
                        "flagged": [
                            0
                        ]
                    }
                ],
                "skipped": true,
                "evaluation_section_id": 0,
                "evaluation_id": 0,
                "section_id": 0
            }
        ],
        "agent_user_id": "string",
        "custom_fields": [
            {
                "key": "string",
                "field": "string"
            }
        ],
        "deleted_by": "string",
        "is_recoverable": true,
        "evaluation_id": 0,
        "scorecard_id": 0,
        "call_sid": 0,
        "transcript_sid": 0
    }
}

🔴500Server Error