Saltar para o conteúdo principal
PATCH
/
public
/
api
/
v1
/
agents
/
{agentPublicId}
/
channels
/
{channelConnectionPublicId}
Configure (Step 2): set isActive / channelSpecificConfig / credentials
curl --request PATCH \
  --url https://api.gennia.ai/public/api/v1/agents/{agentPublicId}/channels/{channelConnectionPublicId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "channelSpecificConfig": {},
  "credentials": {},
  "isActive": true
}
'
{
  "channelName": "<string>",
  "channelSpecificConfig": {},
  "channelType": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "isActive": true,
  "isConfigured": true,
  "publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Autorizações

X-Api-Key
string
header
obrigatório

Parâmetros de caminho

agentPublicId
string<uuid>
obrigatório
channelConnectionPublicId
string<uuid>
obrigatório

Corpo

application/json

Body for configuring an agent's channel link (state, config, credentials).

channelSpecificConfig
object

Channel-specific configuration object. Shape depends on the channel type.

credentials
object

Channel credentials. Stored opaquely; never returned in responses.

isActive
boolean

Whether the channel is currently active.

Exemplo:

true

Resposta

OK

Agent channel connection. credentials NEVER returned.

channelName
string
channelSpecificConfig
object
channelType
string
createdAt
string<date-time>
instanceMode
enum<string>
Opções disponíveis:
STATIC,
DYNAMIC
isActive
boolean
isConfigured
boolean
publicId
string<uuid>
updatedAt
string<date-time>