CreateFilter - TCN API

CreateFilter creates a new filter. The filter contains a search request
to filter transcripts.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

filter

object (Filter)

filter

optional

The filter resource to create.

search_request

object (SearchRequest)

search_request

optional

The search request to be used to filter transcripts.

create_time

string <date-time>

create_time

optional

Output only. The timestamp when this filter was created. Assigned by the
server.

Examples:

1s1.000340012s

name

string

name

optional

Required. The name of this filter. Must be non empty and unique across all
filters within an organization.

filter_sid

integer <int64> | string

filter_sid

optional

Output only. The unique id of this filter.

version

integer <int64> | string

version

optional

Output only. The version of this filter.

Example

{
    "filter": {
        "search_request": {
            "silence": {
                "duration_total": {
                    "eq": 0
                },
                "duration_max": {
                    "eq": 0
                },
                "occurrence_total": {
                    "eq": 0
                },
                "duration_percentage": {
                    "eq": 0
                }
            },
            "talk_time": {
                "eq": 0
            },
            "agent": {
                "user_name": {
                    "any": [
                        "string"
                    ],
                    "all": [
                        "string"
                    ]
                }
            },
            "sort": {
                "fields": [
                    {
                        "name": "string",
                        "desc": true
                    }
                ],
                "after": [
                    "string"
                ]
            },
            "create_time": {
                "moment": {
                    "interval": "TODAY",
                    "time_zone": "string"
                }
            },
            "talk_over": {
                "duration_total": {
                    "eq": 0
                },
                "duration_max": {
                    "eq": 0
                },
                "occurrence_total": {
                    "eq": 0
                },
                "duration_percentage": {
                    "eq": 0
                }
            },
            "terms": {
                "agent": {
                    "user_name": {
                        "any": [
                            "string"
                        ],
                        "all": [
                            "string"
                        ]
                    }
                },
                "position_offset": {
                    "start": "string",
                    "stop": "string"
                },
                "not": true,
                "channel": 0,
                "any": [
                    "string"
                ],
                "all": [
                    "string"
                ]
            },
            "phrase": {
                "highlight": {
                    "pre_tags": [
                        "string"
                    ],
                    "post_tags": [
                        "string"
                    ]
                },
                "agent": {
                    "user_name": {
                        "any": [
                            "string"
                        ],
                        "all": [
                            "string"
                        ]
                    }
                },
                "position_offset": {
                    "start": "string",
                    "stop": "string"
                },
                "words": [
                    {
                        "value": "string",
                        "fuzziness": "string"
                    }
                ],
                "slop": 0,
                "in_order": true,
                "not": true,
                "channel": 0
            },
            "transcript_mask": "string",
            "call_start_time": {
                "moment": {
                    "interval": "TODAY",
                    "time_zone": "string"
                }
            },
            "agent_call_log": {
                "call_skills_initial": {
                    "need": [
                        {
                            "lacks": true,
                            "all": true,
                            "terms": [
                                "string"
                            ]
                        }
                    ],
                    "want": [
                        {
                            "lacks": true,
                            "all": true,
                            "terms": [
                                "string"
                            ]
                        }
                    ]
                }
            },
            "where": {
                "transcript_sid": {
                    "gte": "string",
                    "any": [
                        0
                    ]
                },
                "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
                    }
                },
                "audio_time": {
                    "gte": 0,
                    "lte": 0,
                    "gt": 0,
                    "lt": 0
                },
                "delete_time": {
                    "exists": true
                },
                "not": {},
                "results": {
                    "channel": {
                        "eq": 0
                    },
                    "agent_user_name": {
                        "any": [
                            "string"
                        ],
                        "all": [
                            "string"
                        ]
                    },
                    "segments": {
                        "text": {
                            "phrase": {
                                "words": [
                                    {
                                        "value": "string",
                                        "fuzziness": "string"
                                    }
                                ],
                                "slop": 0,
                                "in_order": true
                            }
                        }
                    }
                },
                "agent_response": {
                    "key": {
                        "starts_with": "string",
                        "contains": "string",
                        "in": [
                            "string"
                        ]
                    },
                    "values": {
                        "starts_with": "string",
                        "contains": "string",
                        "in": [
                            "string"
                        ]
                    },
                    "numbers": {
                        "gte": "string",
                        "lte": "string",
                        "gt": "string",
                        "lt": "string",
                        "eq": "string",
                        "in": [
                            0
                        ]
                    }
                },
                "agent_call_log": {
                    "call_skills_initial": {
                        "need": [
                            "string"
                        ],
                        "want": [
                            "string"
                        ]
                    },
                    "call_ended": {
                        "reasons": [
                            "AGENT_CANCELLED"
                        ]
                    }
                },
                "phone": {
                    "cc": {
                        "in": [
                            "string"
                        ]
                    },
                    "ndc": {
                        "in": [
                            "string"
                        ]
                    },
                    "prefix": {
                        "in": [
                            "string"
                        ]
                    },
                    "city": {
                        "in": [
                            "string"
                        ]
                    },
                    "iso2": {
                        "in": [
                            "string"
                        ]
                    },
                    "region_code": {
                        "in": [
                            "string"
                        ]
                    },
                    "region_name": {
                        "in": [
                            "string"
                        ]
                    },
                    "time_zone": {
                        "in": [
                            "string"
                        ]
                    },
                    "type": {
                        "in": [
                            "string"
                        ]
                    },
                    "utc": {
                        "in": [
                            0
                        ]
                    },
                    "location": {
                        "zip_code_proximity": {
                            "country_code": "string",
                            "zip_code": "string",
                            "distance": "string"
                        }
                    }
                },
                "or": [
                    {}
                ],
                "and": [
                    {}
                ]
            },
            "time_frame": {
                "from": 0,
                "to": 0,
                "include_from": true,
                "include_to": true
            },
            "page_size": 0,
            "channel": 0,
            "phone_number": "string",
            "caller_id": "string",
            "call_types": [
                "INBOUND"
            ],
            "transcript_sid": 0,
            "group_names": [
                "string"
            ],
            "transcript_sids": [
                0
            ],
            "call_sids": [
                0
            ],
            "hunt_group_sids": [
                0
            ]
        },
        "create_time": "1s",
        "name": "string",
        "filter_sid": 0,
        "version": 0
    }
}

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/vanalytics/vanalytics/createfilter' \
--header 'Content-Type: application/json' \
--data-raw '{
    "filter": {
        "search_request": {
            "silence": {
                "duration_total": {
                    "eq": 0
                },
                "duration_max": {
                    "eq": 0
                },
                "occurrence_total": {
                    "eq": 0
                },
                "duration_percentage": {
                    "eq": 0
                }
            },
            "talk_time": {
                "eq": 0
            },
            "agent": {
                "user_name": {
                    "any": [
                        "string"
                    ],
                    "all": [
                        "string"
                    ]
                }
            },
            "sort": {
                "fields": [
                    {
                        "name": "string",
                        "desc": true
                    }
                ],
                "after": [
                    "string"
                ]
            },
            "create_time": {
                "moment": {
                    "interval": "TODAY",
                    "time_zone": "string"
                }
            },
            "talk_over": {
                "duration_total": {
                    "eq": 0
                },
                "duration_max": {
                    "eq": 0
                },
                "occurrence_total": {
                    "eq": 0
                },
                "duration_percentage": {
                    "eq": 0
                }
            },
            "terms": {
                "agent": {
                    "user_name": {
                        "any": [
                            "string"
                        ],
                        "all": [
                            "string"
                        ]
                    }
                },
                "position_offset": {
                    "start": "string",
                    "stop": "string"
                },
                "not": true,
                "channel": 0,
                "any": [
                    "string"
                ],
                "all": [
                    "string"
                ]
            },
            "phrase": {
                "highlight": {
                    "pre_tags": [
                        "string"
                    ],
                    "post_tags": [
                        "string"
                    ]
                },
                "agent": {
                    "user_name": {
                        "any": [
                            "string"
                        ],
                        "all": [
                            "string"
                        ]
                    }
                },
                "position_offset": {
                    "start": "string",
                    "stop": "string"
                },
                "words": [
                    {
                        "value": "string",
                        "fuzziness": "string"
                    }
                ],
                "slop": 0,
                "in_order": true,
                "not": true,
                "channel": 0
            },
            "transcript_mask": "string",
            "call_start_time": {
                "moment": {
                    "interval": "TODAY",
                    "time_zone": "string"
                }
            },
            "agent_call_log": {
                "call_skills_initial": {
                    "need": [
                        {
                            "lacks": true,
                            "all": true,
                            "terms": [
                                "string"
                            ]
                        }
                    ],
                    "want": [
                        {
                            "lacks": true,
                            "all": true,
                            "terms": [
                                "string"
                            ]
                        }
                    ]
                }
            },
            "where": {
                "transcript_sid": {
                    "gte": "string",
                    "any": [
                        0
                    ]
                },
                "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
                    }
                },
                "audio_time": {
                    "gte": 0,
                    "lte": 0,
                    "gt": 0,
                    "lt": 0
                },
                "delete_time": {
                    "exists": true
                },
                "not": {},
                "results": {
                    "channel": {
                        "eq": 0
                    },
                    "agent_user_name": {
                        "any": [
                            "string"
                        ],
                        "all": [
                            "string"
                        ]
                    },
                    "segments": {
                        "text": {
                            "phrase": {
                                "words": [
                                    {
                                        "value": "string",
                                        "fuzziness": "string"
                                    }
                                ],
                                "slop": 0,
                                "in_order": true
                            }
                        }
                    }
                },
                "agent_response": {
                    "key": {
                        "starts_with": "string",
                        "contains": "string",
                        "in": [
                            "string"
                        ]
                    },
                    "values": {
                        "starts_with": "string",
                        "contains": "string",
                        "in": [
                            "string"
                        ]
                    },
                    "numbers": {
                        "gte": "string",
                        "lte": "string",
                        "gt": "string",
                        "lt": "string",
                        "eq": "string",
                        "in": [
                            0
                        ]
                    }
                },
                "agent_call_log": {
                    "call_skills_initial": {
                        "need": [
                            "string"
                        ],
                        "want": [
                            "string"
                        ]
                    },
                    "call_ended": {
                        "reasons": [
                            "AGENT_CANCELLED"
                        ]
                    }
                },
                "phone": {
                    "cc": {
                        "in": [
                            "string"
                        ]
                    },
                    "ndc": {
                        "in": [
                            "string"
                        ]
                    },
                    "prefix": {
                        "in": [
                            "string"
                        ]
                    },
                    "city": {
                        "in": [
                            "string"
                        ]
                    },
                    "iso2": {
                        "in": [
                            "string"
                        ]
                    },
                    "region_code": {
                        "in": [
                            "string"
                        ]
                    },
                    "region_name": {
                        "in": [
                            "string"
                        ]
                    },
                    "time_zone": {
                        "in": [
                            "string"
                        ]
                    },
                    "type": {
                        "in": [
                            "string"
                        ]
                    },
                    "utc": {
                        "in": [
                            0
                        ]
                    },
                    "location": {
                        "zip_code_proximity": {
                            "country_code": "string",
                            "zip_code": "string",
                            "distance": "string"
                        }
                    }
                },
                "or": [
                    {}
                ],
                "and": [
                    {}
                ]
            },
            "time_frame": {
                "from": 0,
                "to": 0,
                "include_from": true,
                "include_to": true
            },
            "page_size": 0,
            "channel": 0,
            "phone_number": "string",
            "caller_id": "string",
            "call_types": [
                "INBOUND"
            ],
            "transcript_sid": 0,
            "group_names": [
                "string"
            ],
            "transcript_sids": [
                0
            ],
            "call_sids": [
                0
            ],
            "hunt_group_sids": [
                0
            ]
        },
        "create_time": "1s",
        "name": "string",
        "filter_sid": 0,
        "version": 0
    }
}'

Responses

🟢200OK

application/json

Success

Body

A filter resource in the Vanalytics API.

search_request

object (SearchRequest)

search_request

optional

The search request to be used to filter transcripts.

silence

object (Silence)

silence

optional

talk_time

optional

talk time in milliseconds

agent

object (Agent)

agent

optional

agent defines query constraints on agent specific fields

sort

object (Sort)

sort

optional

create_time

optional

talk_over

object (TalkOver)

talk_over

optional

terms

object (Terms)

terms

optional

phrase

object (Phrase)

phrase

optional

phrase is words to search for that are close together

transcript_mask

string

transcript_mask

optional

Optional. transcript_mask contains a list of transcript fields to be returned.
If no transcript_mask is provided it defaults to returning all fields.

call_start_time

optional

Optional. Call start time to filter on.

agent_call_log

object (AgentCallLogQuery)

agent_call_log

optional

Optional. Agent call log to filter on.

where

object (SearchQuery)

where

optional

Optional. Query on transcript fields.

time_frame

object (Uint32Range)

time_frame

optional

Optional. Time frame to filter on in milliseconds. For example, this can be used to
filter for a term or phrase that is within the first 500 milliseconds of a transcript.

page_size

integer

page_size

optional

number of hits included in response

channel

integer

channel

optional

channel when set requires search terms to be matched on a specific channel

phone_number

string

phone_number

optional

Optional. Phone number to search for.

caller_id

string

caller_id

optional

Optional. Caller id to search for.

call_types

array[string]

call_types

optional

Optional. Call types to filter on. Possible call types are INBOUND, OUTBOUND,
PREVIEW, and MANUAL.

Allowed values:

INBOUNDOUTBOUNDPREVIEWMANUALMAC

transcript_sid

integer <int64> | string

transcript_sid

optional

Optional. When not zero filter on transcript_sid.

group_names

array[string]

group_names

optional

Optional. Group names to filter on.

transcript_sids

array[integer <int64> | string]

transcript_sids

optional

Optional. When not empty filter on transcript_sids.

call_sids

array[integer <int64> | string]

call_sids

optional

Optional. Call sids to filter on.

hunt_group_sids

array[integer <int64> | string]

hunt_group_sids

optional

Optional. Hunt group sids to filter on.

create_time

string <date-time>

create_time

optional

Output only. The timestamp when this filter was created. Assigned by the
server.

Examples:

1s1.000340012s

name

string

name

optional

Required. The name of this filter. Must be non empty and unique across all
filters within an organization.

filter_sid

integer <int64> | string

filter_sid

optional

Output only. The unique id of this filter.

version

integer <int64> | string

version

optional

Output only. The version of this filter.

Example

{
    "search_request": {
        "silence": {
            "duration_total": {
                "eq": 0
            },
            "duration_max": {
                "eq": 0
            },
            "occurrence_total": {
                "eq": 0
            },
            "duration_percentage": {
                "eq": 0
            }
        },
        "talk_time": {
            "eq": 0
        },
        "agent": {
            "user_name": {
                "any": [
                    "string"
                ],
                "all": [
                    "string"
                ]
            }
        },
        "sort": {
            "fields": [
                {
                    "name": "string",
                    "desc": true
                }
            ],
            "after": [
                "string"
            ]
        },
        "create_time": {
            "moment": {
                "interval": "TODAY",
                "time_zone": "string"
            }
        },
        "talk_over": {
            "duration_total": {
                "eq": 0
            },
            "duration_max": {
                "eq": 0
            },
            "occurrence_total": {
                "eq": 0
            },
            "duration_percentage": {
                "eq": 0
            }
        },
        "terms": {
            "agent": {
                "user_name": {
                    "any": [
                        "string"
                    ],
                    "all": [
                        "string"
                    ]
                }
            },
            "position_offset": {
                "start": "string",
                "stop": "string"
            },
            "not": true,
            "channel": 0,
            "any": [
                "string"
            ],
            "all": [
                "string"
            ]
        },
        "phrase": {
            "highlight": {
                "pre_tags": [
                    "string"
                ],
                "post_tags": [
                    "string"
                ]
            },
            "agent": {
                "user_name": {
                    "any": [
                        "string"
                    ],
                    "all": [
                        "string"
                    ]
                }
            },
            "position_offset": {
                "start": "string",
                "stop": "string"
            },
            "words": [
                {
                    "value": "string",
                    "fuzziness": "string"
                }
            ],
            "slop": 0,
            "in_order": true,
            "not": true,
            "channel": 0
        },
        "transcript_mask": "string",
        "call_start_time": {
            "moment": {
                "interval": "TODAY",
                "time_zone": "string"
            }
        },
        "agent_call_log": {
            "call_skills_initial": {
                "need": [
                    {
                        "lacks": true,
                        "all": true,
                        "terms": [
                            "string"
                        ]
                    }
                ],
                "want": [
                    {
                        "lacks": true,
                        "all": true,
                        "terms": [
                            "string"
                        ]
                    }
                ]
            }
        },
        "where": {
            "transcript_sid": {
                "gte": "string",
                "any": [
                    0
                ]
            },
            "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
                }
            },
            "audio_time": {
                "gte": 0,
                "lte": 0,
                "gt": 0,
                "lt": 0
            },
            "delete_time": {
                "exists": true
            },
            "not": {},
            "results": {
                "channel": {
                    "eq": 0
                },
                "agent_user_name": {
                    "any": [
                        "string"
                    ],
                    "all": [
                        "string"
                    ]
                },
                "segments": {
                    "text": {
                        "phrase": {
                            "words": [
                                {
                                    "value": "string",
                                    "fuzziness": "string"
                                }
                            ],
                            "slop": 0,
                            "in_order": true
                        }
                    }
                }
            },
            "agent_response": {
                "key": {
                    "starts_with": "string",
                    "contains": "string",
                    "in": [
                        "string"
                    ]
                },
                "values": {
                    "starts_with": "string",
                    "contains": "string",
                    "in": [
                        "string"
                    ]
                },
                "numbers": {
                    "gte": "string",
                    "lte": "string",
                    "gt": "string",
                    "lt": "string",
                    "eq": "string",
                    "in": [
                        0
                    ]
                }
            },
            "agent_call_log": {
                "call_skills_initial": {
                    "need": [
                        "string"
                    ],
                    "want": [
                        "string"
                    ]
                },
                "call_ended": {
                    "reasons": [
                        "AGENT_CANCELLED"
                    ]
                }
            },
            "phone": {
                "cc": {
                    "in": [
                        "string"
                    ]
                },
                "ndc": {
                    "in": [
                        "string"
                    ]
                },
                "prefix": {
                    "in": [
                        "string"
                    ]
                },
                "city": {
                    "in": [
                        "string"
                    ]
                },
                "iso2": {
                    "in": [
                        "string"
                    ]
                },
                "region_code": {
                    "in": [
                        "string"
                    ]
                },
                "region_name": {
                    "in": [
                        "string"
                    ]
                },
                "time_zone": {
                    "in": [
                        "string"
                    ]
                },
                "type": {
                    "in": [
                        "string"
                    ]
                },
                "utc": {
                    "in": [
                        0
                    ]
                },
                "location": {
                    "zip_code_proximity": {
                        "country_code": "string",
                        "zip_code": "string",
                        "distance": "string"
                    }
                }
            },
            "or": [
                {}
            ],
            "and": [
                {}
            ]
        },
        "time_frame": {
            "from": 0,
            "to": 0,
            "include_from": true,
            "include_to": true
        },
        "page_size": 0,
        "channel": 0,
        "phone_number": "string",
        "caller_id": "string",
        "call_types": [
            "INBOUND"
        ],
        "transcript_sid": 0,
        "group_names": [
            "string"
        ],
        "transcript_sids": [
            0
        ],
        "call_sids": [
            0
        ],
        "hunt_group_sids": [
            0
        ]
    },
    "create_time": "1s",
    "name": "string",
    "filter_sid": 0,
    "version": 0
}

🔴500Server Error