agents
agents.test
conversations
data_sources
events
custom_messages
prompts
session_labels
sessions.transcript
channels.targets
directory
dashboards
outbound.batches
- GETList Outbound Communication Batches
- PUTCreate Outbound Communication Batch
- GETGet Outbound Communication Batch
- DELDelete Outbound Communication Batch
- POSTUpload Outbound Communication Batch
- GETFetch Outbound Communication Batch Results
- POSTCreate Outbound Communication Request
- POSTDelete Requests By List Of Reference Ids
Edit Channel Target
Update channel target by ID
Authorizations
Body
The ID of the agent associated with the channel target
The ID of the channel associated with the channel target
The name of the channel target (must correspond to an organization-level target)
The mode of the channel target (must match one of the supported modes of the associated channel)
voice, chat, sms, email The ID of the channel target
The fallback for the channel target (currently only supported for "voice" mode)
Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as test.
Response
A channel target links a channel to an agent, allowing users to communicate with the agent through that channel.
The ID of the agent associated with the channel target
The ID of the channel associated with the channel target
The name of the channel target (must correspond to an organization-level target)
The mode of the channel target (must match one of the supported modes of the associated channel)
voice, chat, sms, email The ID of the channel target
The name of the channel associated with the channel target
Timestamp of the most recent update to the channel target
Email of the user who last updated the channel target
The fallback for the channel target (currently only supported for "voice" mode)
Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as test.
Definition of the agent for the channel target
The agent name
The agent type. Can be an arbitrary string
ID of the prompt associated with the agent
ID of the custom message that should be delivered at the beginning of a conversation with the agent
The time zone in which the agent operates
Custom context variables for the conversation session. Keys should be prefixed with "vars.".
Optional headers to include in tool calls for agent.
The agent ID
Timestamp of most recent update
Email of the user who last updated the agent
The agent description
The agent label
User-configured parameter values for the agent's tools
The name of the tool
BCP 47 codes of languages the agent supports
Whether the agent initiates conversation with a user after the custom_message is delivered
The prompt associated with the agent.
The prompt name
The type of the prompt
The configuration for the LLM that the prompt uses
Provider of the LLM model.
azure_openai, openai Name of the model. Must match the deployment name in Azure AI Studio.
Optional model version.
Version of the API. (Currently only used for Azure OpenAI.)
The prompt ID
The last updated date of the prompt
The description of the prompt
The prompt text
Names of the tools to which the prompt has access
The comments for the most recent edit to the prompt
Email address of the user who most recently updated the prompt
The number of agents using the prompt
The custom message associated with the agent. Will be delivered as a greeting at the beginning of a conversation.
The name of the custom message
The text of the custom message
The ID of the custom message
Timestamp of the most recent update to the custom message
The email address of the user who most recently updated the custom message
The label of the custom message
Rules for time-specific message variants
The description of the rule
Whether the rule logic should be inverted (i.e. "not")
Message text associated with the rule
The start of the time range for the rule in 24-hour format hh:mm (should be null for "all day" cases)
The end of the time range for the rule in 24-hour format hh:mm (should be null for "all day" cases)
The date for the rule in YYYY-MM-DD format
The days of the week for the rule
mo, tu, we, th, fr, sa, su The number of agents using the custom message
Channel targets associated with the agent
The ID of the agent associated with the channel target
The ID of the channel associated with the channel target
The name of the channel target (must correspond to an organization-level target)
The mode of the channel target (must match one of the supported modes of the associated channel)
voice, chat, sms, email The ID of the channel target
The name of the channel associated with the channel target
Timestamp of the most recent update to the channel target
Email of the user who last updated the channel target
The fallback for the channel target (currently only supported for "voice" mode)
Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as test.
Definition of the agent for the channel target
The agent name
The agent type. Can be an arbitrary string
ID of the prompt associated with the agent
ID of the custom message that should be delivered at the beginning of a conversation with the agent
The time zone in which the agent operates
Custom context variables for the conversation session. Keys should be prefixed with "vars.".
Optional headers to include in tool calls for agent.
The agent ID
Timestamp of most recent update
Email of the user who last updated the agent
The agent description
The agent label
BCP 47 codes of languages the agent supports
Whether the agent initiates conversation with a user after the custom_message is delivered
The prompt associated with the agent.
The prompt name
The type of the prompt
The configuration for the LLM that the prompt uses
The prompt ID
The last updated date of the prompt
The description of the prompt
The prompt text
Names of the tools to which the prompt has access
The comments for the most recent edit to the prompt
Email address of the user who most recently updated the prompt
The number of agents using the prompt
The custom message associated with the agent. Will be delivered as a greeting at the beginning of a conversation.
The name of the custom message
The text of the custom message
The ID of the custom message
Timestamp of the most recent update to the custom message
The email address of the user who most recently updated the custom message
The label of the custom message
Rules for time-specific message variants
The number of agents using the custom message
Channel targets associated with the agent
The ID of the agent associated with the channel target
The ID of the channel associated with the channel target
The name of the channel target (must correspond to an organization-level target)
The mode of the channel target (must match one of the supported modes of the associated channel)
voice, chat, sms, email The ID of the channel target
The name of the channel associated with the channel target
Timestamp of the most recent update to the channel target
Email of the user who last updated the channel target
The fallback for the channel target (currently only supported for "voice" mode)
Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as test.
Definition of the agent for the channel target
Tools associated with the agent
The name of the tool
The definition of the tool
The service to which this tool belongs
The ID of the tool
The timestamp of the most recent update to the service
The email of the user who last updated the tool
Update comments
The name of the service to which the tool belongs
Tools associated with the agent
The name of the tool
The definition of the tool
The action to take when the LLM calls the tool.
action, endpoint, context, log The configuration for an HTTP API call.
The endpoint URL of the external service to call.
The HTTP method to use for the service call.
get, post How to pass the arguments to the request.
body, form, path, query The default values for the parameters of the function/tool call.
Parameters for the tool whose values should be set at config time (i.e., not provided by the LLM).
The name of the parameter - must be unique within the tool.
Whether the parameter is required to have a value assigned.
The expected type for the parameter.
string, int, boolean, data_source_list The description of the parameter.
The default value for the parameter. If type is string, must be a string. If type is int, must be an int. If type is boolean, must be a boolean. If type is data_source_list, must be a list of strings (data source names).
The optional result of the tool call. Only used for context tools.
The service to which this tool belongs
The ID of the tool
The timestamp of the most recent update to the service
The email of the user who last updated the tool
Update comments
The name of the service to which the tool belongs