Skip to content
This repository was archived by the owner on Aug 25, 2025. It is now read-only.

AgentBotsApi.md

Latest commit

 

History

History
365 lines (257 loc) · 9.34 KB

AgentBotsApi.md

File metadata and controls

365 lines (257 loc) · 9.34 KB

Cfchat::AgentBotsApi

All URIs are relative to https://chat.myclickfunnels.com

Method HTTP request Description
create_an_agent_bot POST /platform/api/v1/agent_bots Create an Agent Bot
delete_an_agent_bot DELETE /platform/api/v1/agent_bots/{id} Delete an AgentBot
get_details_of_a_single_agent_bot GET /platform/api/v1/agent_bots/{id} Get an agent bot details
list_all_agent_bots GET /platform/api/v1/agent_bots List all AgentBots
update_an_agent_bot PATCH /platform/api/v1/agent_bots/{id} Update an agent bot

create_an_agent_bot

create_an_agent_bot(data)

Create an Agent Bot

Create an agent bot

Examples

require 'time'
require 'cfchat'
# setup authorization
Cfchat.configure do |config|
  # Configure API key authorization: platformAppApiKey
  config.api_key['platformAppApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['platformAppApiKey'] = 'Bearer'
end

api_instance = Cfchat::AgentBotsApi.new
data = Cfchat::AgentBotCreateUpdatePayload.new # AgentBotCreateUpdatePayload | 

begin
  # Create an Agent Bot
  result = api_instance.create_an_agent_bot(data)
  p result
rescue Cfchat::ApiError => e
  puts "Error when calling AgentBotsApi->create_an_agent_bot: #{e}"
end

Using the create_an_agent_bot_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_an_agent_bot_with_http_info(data)

begin
  # Create an Agent Bot
  data, status_code, headers = api_instance.create_an_agent_bot_with_http_info(data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AgentBot>
rescue Cfchat::ApiError => e
  puts "Error when calling AgentBotsApi->create_an_agent_bot_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
data AgentBotCreateUpdatePayload

Return type

AgentBot

Authorization

platformAppApiKey

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

delete_an_agent_bot

delete_an_agent_bot(id)

Delete an AgentBot

Delete an AgentBot

Examples

require 'time'
require 'cfchat'
# setup authorization
Cfchat.configure do |config|
  # Configure API key authorization: platformAppApiKey
  config.api_key['platformAppApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['platformAppApiKey'] = 'Bearer'
end

api_instance = Cfchat::AgentBotsApi.new
id = 56 # Integer | The ID of the agentbot to be updated

begin
  # Delete an AgentBot
  api_instance.delete_an_agent_bot(id)
rescue Cfchat::ApiError => e
  puts "Error when calling AgentBotsApi->delete_an_agent_bot: #{e}"
end

Using the delete_an_agent_bot_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_an_agent_bot_with_http_info(id)

begin
  # Delete an AgentBot
  data, status_code, headers = api_instance.delete_an_agent_bot_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Cfchat::ApiError => e
  puts "Error when calling AgentBotsApi->delete_an_agent_bot_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer The ID of the agentbot to be updated

Return type

nil (empty response body)

Authorization

platformAppApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

get_details_of_a_single_agent_bot

get_details_of_a_single_agent_bot(id)

Get an agent bot details

Get the details of an agent bot

Examples

require 'time'
require 'cfchat'
# setup authorization
Cfchat.configure do |config|
  # Configure API key authorization: platformAppApiKey
  config.api_key['platformAppApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['platformAppApiKey'] = 'Bearer'
end

api_instance = Cfchat::AgentBotsApi.new
id = 56 # Integer | The ID of the agentbot to be updated

begin
  # Get an agent bot details
  result = api_instance.get_details_of_a_single_agent_bot(id)
  p result
rescue Cfchat::ApiError => e
  puts "Error when calling AgentBotsApi->get_details_of_a_single_agent_bot: #{e}"
end

Using the get_details_of_a_single_agent_bot_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_details_of_a_single_agent_bot_with_http_info(id)

begin
  # Get an agent bot details
  data, status_code, headers = api_instance.get_details_of_a_single_agent_bot_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AgentBot>
rescue Cfchat::ApiError => e
  puts "Error when calling AgentBotsApi->get_details_of_a_single_agent_bot_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer The ID of the agentbot to be updated

Return type

AgentBot

Authorization

platformAppApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

list_all_agent_bots

<Array> list_all_agent_bots

List all AgentBots

List all agent bots available

Examples

require 'time'
require 'cfchat'
# setup authorization
Cfchat.configure do |config|
  # Configure API key authorization: platformAppApiKey
  config.api_key['platformAppApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['platformAppApiKey'] = 'Bearer'
end

api_instance = Cfchat::AgentBotsApi.new

begin
  # List all AgentBots
  result = api_instance.list_all_agent_bots
  p result
rescue Cfchat::ApiError => e
  puts "Error when calling AgentBotsApi->list_all_agent_bots: #{e}"
end

Using the list_all_agent_bots_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> list_all_agent_bots_with_http_info

begin
  # List all AgentBots
  data, status_code, headers = api_instance.list_all_agent_bots_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<AgentBot>>
rescue Cfchat::ApiError => e
  puts "Error when calling AgentBotsApi->list_all_agent_bots_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Array<AgentBot>

Authorization

platformAppApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

update_an_agent_bot

update_an_agent_bot(id, data)

Update an agent bot

Update an agent bot's attributes

Examples

require 'time'
require 'cfchat'
# setup authorization
Cfchat.configure do |config|
  # Configure API key authorization: platformAppApiKey
  config.api_key['platformAppApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['platformAppApiKey'] = 'Bearer'
end

api_instance = Cfchat::AgentBotsApi.new
id = 56 # Integer | The ID of the agentbot to be updated
data = Cfchat::AgentBotCreateUpdatePayload.new # AgentBotCreateUpdatePayload | 

begin
  # Update an agent bot
  result = api_instance.update_an_agent_bot(id, data)
  p result
rescue Cfchat::ApiError => e
  puts "Error when calling AgentBotsApi->update_an_agent_bot: #{e}"
end

Using the update_an_agent_bot_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_an_agent_bot_with_http_info(id, data)

begin
  # Update an agent bot
  data, status_code, headers = api_instance.update_an_agent_bot_with_http_info(id, data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AgentBot>
rescue Cfchat::ApiError => e
  puts "Error when calling AgentBotsApi->update_an_agent_bot_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer The ID of the agentbot to be updated
data AgentBotCreateUpdatePayload

Return type

AgentBot

Authorization

platformAppApiKey

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8