Developer

Insights

Entity: Endpoints

The Endpoints API can be used to retrieve information about Endpoints

Entities

Entity

Type

Description

id

string

The unique identifier of the Endpoint.

Role

string

The role represented by the Endpoint. Possible options are:

  1. IVR: the Endpoint represents an IVR that helps the Customer determining the right Queue;

  2. Queue: the Endpoint represents a Queue in which the Customer was waiting for an available Agent;

  3. Customer: the Endpoint represents a Customer initiating or receiving the Dialogue;

  4. Agent: the Endpoint represents an Agent handling the Dialogue.

Name

string

The display name of the Endpoint.

Address

string

The address of the Endpoint (e.g. phone number or email address).

Environment

minute to read