SearchByOrgId - TCN API

SearchByOrgId searches transcripts for a specific org.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "org_id": "string",
    "page_size": 0,
    "sort": {
        "fields": [
            {
                "name": "string",
                "desc": true
            }
        ],
        "after": [
            "string"
        ]
    },
    "transcript_mask": "string",
    "flag_summary": {
        "need_review": {
            "flag_sids": {
                "any": [
                    0
                ]
            }
        },
        "review_status": {
            "any": [
                "TRANSCRIPT_REVIEW_STATUS_TODO"
            ]
        },
        "flags": {
            "flag_sid": {
                "any": [
                    0
                ],
                "all": [
                    0
                ]
            }
        },
        "count": {
            "gte": 0,
            "lte": 0,
            "gt": 0,
            "lt": 0,
            "eq": 0
        }
    },
    "filter": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

{
    "total": 0,
    "hits": [
        {
            "transcript": {
                "transcript_sid": 0,
                "call_sid": 0,
                "call_type": "INBOUND",
                "results": [
                    {
                        "channel": 0,
                        "segments": [
                            {
                                "begin_time": 0,
                                "confidence": 0,
                                "duration": 0,
                                "text": "string",
                                "words": [
                                    {
                                        "begin_time": 0,
                                        "confidence": 0,
                                        "duration": 0,
                                        "spoken": "string",
                                        "redacted": true
                                    }
                                ]
                            }
                        ],
                        "agent_first_name": "string",
                        "agent_last_name": "string",
                        "agent_user_name": "string",
                        "begin_time": 0,
                        "duration": 0,
                        "text": "string",
                        "hunt_group_sid": 0,
                        "sentiment": {
                            "overall": {
                                "positive": 0,
                                "neutral": 0,
                                "negative": 0
                            },
                            "worst": "TRANSCRIPT_SENTIMENT_TONE_UNKNOWN",
                            "dominant": "TRANSCRIPT_SENTIMENT_TONE_UNKNOWN",
                            "last": "TRANSCRIPT_SENTIMENT_TONE_UNKNOWN",
                            "samples": [
                                {
                                    "estimate": {
                                        "positive": 0,
                                        "neutral": 0,
                                        "negative": 0
                                    },
                                    "offset": "string",
                                    "duration": "string"
                                }
                            ]
                        }
                    }
                ],
                "silence": {
                    "duration": {
                        "total": 0,
                        "max": 0,
                        "percentage": 0
                    },
                    "segments": [
                        {
                            "begin_time": 0,
                            "duration": 0
                        }
                    ],
                    "occurrence": {
                        "total": 0
                    },
                    "threshold": 0
                },
                "talk_time": 0,
                "create_time": "1s",
                "call_start_time": "1s",
                "talk_over": {
                    "occurrence": {
                        "total": 0
                    },
                    "duration": {
                        "total": 0,
                        "max": 0,
                        "percentage": 0
                    },
                    "results": [
                        {
                            "channel": 0,
                            "occurrence": {
                                "total": 0
                            },
                            "duration": {
                                "total": 0,
                                "max": 0,
                                "percentage": 0
                            },
                            "segments": [
                                {
                                    "begin_time": 0,
                                    "duration": 0
                                }
                            ],
                            "agent_user_name": "string",
                            "agent_session_sid": 0
                        }
                    ],
                    "threshold": 0
                },
                "caller_id": "string",
                "phone_number": "string",
                "audio_time": 0,
                "audio_bytes": 0,
                "group_name": "string",
                "agent_call_log": {
                    "actions": [
                        {
                            "call_ended": "string"
                        }
                    ]
                },
                "flag_summary": {
                    "count": 0,
                    "priority_sum": 0,
                    "priority_max": 0,
                    "need_review": {
                        "priority_sum": 0,
                        "priority_max": 0,
                        "count": 0,
                        "flag_sids": [
                            0
                        ]
                    },
                    "flags": [
                        {
                            "flag_sid": 0,
                            "name": "string",
                            "priority": 0,
                            "version": 0,
                            "filters": [
                                {
                                    "join_key": "string",
                                    "flag_sid": 0,
                                    "filter_sid": 0,
                                    "version": 0,
                                    "name": "string"
                                }
                            ],
                            "must_review": true,
                            "must_notify": true,
                            "reviews": [
                                {
                                    "join_key": "string",
                                    "flag_sid": 0,
                                    "user_id": "string"
                                }
                            ]
                        }
                    ],
                    "review_status": "TRANSCRIPT_REVIEW_STATUS_TODO"
                },
                "delete_time": "1s",
                "number_format": "string",
                "agent_response": {
                    "property1": {
                        "values": [
                            "string"
                        ]
                    },
                    "property2": {
                        "values": [
                            "string"
                        ]
                    }
                },
                "summary": {
                    "bullet_points": [
                        "string"
                    ],
                    "status": "TRANSCRIPT_SUMMARY_STATUS_QUEUED"
                }
            }
        }
    ],
    "sort": {
        "fields": [
            {
                "name": "string",
                "desc": true
            }
        ],
        "after": [
            "string"
        ]
    }
}

🟢200Success