API Documentation

• Introduction

  Cyara’s REST APIs helps you automate the tasks commonly performed as part of your application testing process.  Cyara REST API The Cyara REST API is a collection of software function calls that allow a programmer to perform a variety of Cyara Portal fun...

• Getting Started with the Cyara API

  Planning Your Integration Before you start using the Cyara API, we recommend planning out which tasks you are looking to perform on your Cyara Portal. This ensures that you find the appropriate API route in our API documentation to perform the function ...

• Authentication

  The authorization credentials comprise two parts; API key and unique access token. Simply put, all API requests must be accompanied by a combination of API key and your unique access token as authorization credentials. Whether you access the REST APIs u...

• Using the Cyara 3.0 APIs in Swagger

  We recommend reading through the Getting Started article before you plan your integration. After you have created an integration plan, read the steps below to get started with the Cyara 3.0 API. The Cyara 3.0 API is built to allow integrations to the Cy...

• Capturing a Call Connection ID Variable from a Cyara Test Case

  Overview Cyara Test Cases can be used in a range of different ways to test IVR applications, in this example, we'll walk through how to use a Cyara Test Case to capture a spoken Call Connection ID from your IVR system. Note: This testing method is best ...

• How to request CSV instead of JSON via the Cyara 3.0 API

  For specific Cyara 3.0 API Endpoints, you can request a CSV formatted response rather than the default JSON response. This is particularly useful if you intend to use the data returned by the endpoint in other applications such as spreadsheets. The abil...

See all 7 articles

• ResolveAX Agent Management API

  Agent Management API With release v24.10 Cyara is introducing the first set of publicly accessible ResolveAX API endpoints focusing on ResolveAX agent (user) management The API endpoints will enable users with the programmatic means of incorporating Res...

• Cyara ResolveAX - Introduction

  Introduction This document is intended for: Administrators of a compatible CCaaS deployment who want to enable Cyara ResolveAX capability. Information Security Engineers who are seeking to understand the inner workings of ResolveAX on an agent desktop....

• Cyara ResolveAX - Event Feed

  Event Feed   Event Messages Agent.Connected Agent.Disconnected Event.Agent Event.WebRtc Interaction.Started Interaction.Ended Report.Alert Report.Feedback Report.Health Report.Info Report.Network Report.WebRtc   Agent.Connected An Agent has connec...

• Cyara ResolveAX - Agent Browser Extension Configuration

  Watch the video below for a walkthrough on how to install, configure and use the Cyara LiveVQ browser extension for @Home and remote Agents.

• CentraCX Survey API Delivery

  This API Delivery page describes all possible ways to interact with CentraCX API. It's functionality is limited to completing surveys and checking on their status. For a survey to be available to be completed over this medium you must make sure to enabl...