Search

POST

https://api.cbf.tcn.com/api/v1alpha1/vanalytics/vanalytics/search

Vanalytics

Search searches transcripts by search criteria. The search response
contains one page of transcript hits. Traversing the paginated hits is
achieved through subsequent requests using the response sort field.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Example

{
  "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
  ]
}

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/search' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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
    ]
}'

Responses

🟢200OK

application/json

Success

Body

sort

object (Sort)

sort

optional

Sort is the original sort but also includes after values of last search
hit. This is intended to be used on a subsequent search request to get the
next page of search hits.

fields

array[object (Field) {2}]

fields

optional

Fields to sort by with names in json notation. i.e.
audio_time, silence.duration.total, result.text

after

array[string]

after

optional

After values define the starting offset of response hits. i.e.
given sort {"fields":[{"name":"silence.duration.total"}],"after":["3200"]}
then the search response is sorted by ascending silence duration where
silence duration total is greater than 3200. The after values are used
to scroll through the paginated search hits.

hits

array[object (Hit) {1}]

hits

optional

one page of hits

transcript

object (Transcript)

transcript

optional

total

integer <int64> | string

total

optional

total number of hits in query

Example

{
  "sort": {
    "fields": [
      {
        "name": "string",
        "desc": true
      }
    ],
    "after": [
      "string"
    ]
  },
  "hits": [
    {
      "transcript": {
        "call_type": "INBOUND",
        "silence": {
          "duration": {
            "total": 0,
            "max": 0,
            "percentage": 0
          },
          "occurrence": {
            "total": 0
          },
          "segments": [
            {
              "begin_time": 0,
              "duration": 0
            }
          ],
          "threshold": 0
        },
        "create_time": "1s",
        "call_start_time": "1s",
        "talk_over": {
          "occurrence": {
            "total": 0
          },
          "duration": {
            "total": 0,
            "max": 0,
            "percentage": 0
          },
          "results": [
            {
              "occurrence": {
                "total": 0
              },
              "duration": {
                "total": 0,
                "max": 0,
                "percentage": 0
              },
              "channel": 0,
              "segments": [
                {
                  "begin_time": 0,
                  "duration": 0
                }
              ],
              "agent_user_name": "string",
              "agent_session_sid": 0
            }
          ],
          "threshold": 0
        },
        "agent_call_log": {
          "actions": [
            {
              "call_ended": "string"
            }
          ]
        },
        "flag_summary": {
          "need_review": {
            "priority_sum": 0,
            "priority_max": 0,
            "count": 0,
            "flag_sids": [
              0
            ]
          },
          "review_status": "TRANSCRIPT_REVIEW_STATUS_TODO",
          "count": 0,
          "priority_sum": 0,
          "priority_max": 0,
          "flags": [
            {
              "name": "string",
              "priority": 0,
              "filters": [
                {
                  "join_key": "string",
                  "name": "string",
                  "flag_sid": 0,
                  "filter_sid": 0,
                  "version": 0
                }
              ],
              "must_review": true,
              "must_notify": true,
              "reviews": [
                {
                  "join_key": "string",
                  "user_id": "string",
                  "flag_sid": 0
                }
              ],
              "flag_sid": 0,
              "version": 0
            }
          ]
        },
        "delete_time": "1s",
        "summary": {
          "status": "TRANSCRIPT_SUMMARY_STATUS_QUEUED",
          "bullet_points": [
            "string"
          ]
        },
        "results": [
          {
            "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"
                }
              ]
            },
            "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
          }
        ],
        "talk_time": 0,
        "caller_id": "string",
        "phone_number": "string",
        "audio_time": 0,
        "group_name": "string",
        "number_format": "string",
        "agent_response": {
          "property1": {
            "values": [
              "string"
            ]
          },
          "property2": {
            "values": [
              "string"
            ]
          }
        },
        "transcript_sid": 0,
        "call_sid": 0,
        "audio_bytes": 0
      }
    }
  ],
  "total": 0
}

🔴500Server Error

ListBillingSpan

ListTranscriptGroupNames