/api/v1/channels (GET)

GET

/api/v1/channels

const url = 'https://api.endless.zaia.app/api/v1/channels?pageNumber=1&pageSize=10';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.endless.zaia.app/api/v1/channels?pageNumber=1&pageSize=10'

Retrieves multiple channels.

Parameters

Query Parameters

pageNumber

The page number.

number

default: 1 >= 1

The page number.

pageSize

The page size.

number

default: 10 >= 1 <= 100

The page size.

responderIds

Any of:

Array<string>
string

Array<string>

search

Search term to filter channels by name, description, or prompt.

string

>= 1 characters

Search term to filter channels by name, description, or prompt.

Responses

200

Retrieves all channels for the workspace.

application/json

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

updatedAt

required

string format: date-time

delay

required

The delay between the last user message and the beginning of the response generation.

integer

>= 1 <= 60

description

required

The internal description of the channel.

string

nullable >= 3 characters <= 250 characters

detail

required

Any of:

object

initialMessage

required

The initial message to be displayed when the API is used.

string

nullable >= 1 characters <= 250 characters

responseWebhookUrl

required

The webhook URL that receives responses produced through the API channel.

string format: uri

>= 3 characters <= 500 characters

type

required

The channel subtype represented by this detail payload.

string

Allowed values: api

maxAssistantMessagesPerChatOwner

required

integer

nullable

name

required

The display name of the channel.

string

>= 3 characters <= 50 characters

prompt

required

A prompt to be passed down to the agent in the context of this channel.

string

nullable >= 3 characters <= 500 characters

responderId

required

The super identity of the responder (agents or squads) of the channel

string format: uuid

nullable

showSenderName

required

Whether to display sender names in chat messages.

boolean

status

required

The lifecycle status of the channel.

string

Allowed values: active inactive

useVoice

required

The voice behavior mode configured for the channel.

string

Allowed values: on-audio/without-transcription on-audio/with-transcription always/without-transcription always/with-transcription never

workspaceId

required

The workspace ID that owns the channel.

string format: uuid

Example

[
  {
    "detail": {
      "type": "api"
    },
    "status": "active",
    "useVoice": "on-audio/without-transcription"
  }
]

400

Bad Request.

application/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}

401

Unauthorized.

application/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}