Search code, repositories, users, issues, pull requests...

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

ai_bot_v1_bots_bot_commands_destroy

ai_bot_v1_bots_bot_commands_destroy(id, org)

Create slash commands for a specific bot eg. /iblai-baseline

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this bot command.
org = 'org_example' # str | 

try:
    api_instance.ai_bot_v1_bots_bot_commands_destroy(id, org)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_bot_commands_destroy: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this bot command.
org	str

Return type

void (empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

ai_bot_v1_bots_bot_commands_list

List[BotCommand] ai_bot_v1_bots_bot_commands_list(org)

Create slash commands for a specific bot eg. /iblai-baseline

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.bot_command import BotCommand
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
org = 'org_example' # str | 

try:
    api_response = api_instance.ai_bot_v1_bots_bot_commands_list(org)
    print("The response of AiBotApi->ai_bot_v1_bots_bot_commands_list:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_bot_commands_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
org	str

Return type

List[BotCommand]

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_bot_commands_partial_update

BotCommand ai_bot_v1_bots_bot_commands_partial_update(id, org, patched_bot_command=patched_bot_command)

Create slash commands for a specific bot eg. /iblai-baseline

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.bot_command import BotCommand
from iblai.models.patched_bot_command import PatchedBotCommand
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this bot command.
org = 'org_example' # str | 
patched_bot_command = iblai.PatchedBotCommand() # PatchedBotCommand |  (optional)

try:
    api_response = api_instance.ai_bot_v1_bots_bot_commands_partial_update(id, org, patched_bot_command=patched_bot_command)
    print("The response of AiBotApi->ai_bot_v1_bots_bot_commands_partial_update:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_bot_commands_partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this bot command.
org	str
patched_bot_command	PatchedBotCommand		[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_bot_commands_retrieve

BotCommand ai_bot_v1_bots_bot_commands_retrieve(id, org)

Create slash commands for a specific bot eg. /iblai-baseline

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.bot_command import BotCommand
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this bot command.
org = 'org_example' # str | 

try:
    api_response = api_instance.ai_bot_v1_bots_bot_commands_retrieve(id, org)
    print("The response of AiBotApi->ai_bot_v1_bots_bot_commands_retrieve:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_bot_commands_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this bot command.
org	str

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_bot_commands_update

BotCommand ai_bot_v1_bots_bot_commands_update(id, org, bot_command)

Create slash commands for a specific bot eg. /iblai-baseline

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.bot_command import BotCommand
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this bot command.
org = 'org_example' # str | 
bot_command = iblai.BotCommand() # BotCommand | 

try:
    api_response = api_instance.ai_bot_v1_bots_bot_commands_update(id, org, bot_command)
    print("The response of AiBotApi->ai_bot_v1_bots_bot_commands_update:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_bot_commands_update: %s\n" % e)

Parameters

Name	Type	Description
id	int	A unique integer value identifying this bot command.
org	str
bot_command	BotCommand

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_bot_create

BotCreate ai_bot_v1_bots_bot_create(org, bot_create)

Create modify and update bot information for a specific tenant.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.bot_create import BotCreate
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
org = 'org_example' # str | 
bot_create = iblai.BotCreate() # BotCreate | 

try:
    api_response = api_instance.ai_bot_v1_bots_bot_create(org, bot_create)
    print("The response of AiBotApi->ai_bot_v1_bots_bot_create:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_bot_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
org	str
bot_create	BotCreate

Return type

BotCreate

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

ai_bot_v1_bots_bot_destroy

ai_bot_v1_bots_bot_destroy(id, org)

Create modify and update bot information for a specific tenant.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this bot.
org = 'org_example' # str | 

try:
    api_instance.ai_bot_v1_bots_bot_destroy(id, org)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_bot_destroy: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this bot.
org	str

Return type

void (empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

ai_bot_v1_bots_bot_list

List[Bot] ai_bot_v1_bots_bot_list(org)

Create modify and update bot information for a specific tenant.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.bot import Bot
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
org = 'org_example' # str | 

try:
    api_response = api_instance.ai_bot_v1_bots_bot_list(org)
    print("The response of AiBotApi->ai_bot_v1_bots_bot_list:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_bot_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
org	str

Return type

List[Bot]

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_bot_partial_update

BotCreate ai_bot_v1_bots_bot_partial_update(id, org, patched_bot_create=patched_bot_create)

Create modify and update bot information for a specific tenant.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.bot_create import BotCreate
from iblai.models.patched_bot_create import PatchedBotCreate
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this bot.
org = 'org_example' # str | 
patched_bot_create = iblai.PatchedBotCreate() # PatchedBotCreate |  (optional)

try:
    api_response = api_instance.ai_bot_v1_bots_bot_partial_update(id, org, patched_bot_create=patched_bot_create)
    print("The response of AiBotApi->ai_bot_v1_bots_bot_partial_update:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_bot_partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this bot.
org	str
patched_bot_create	PatchedBotCreate		[optional]

Return type

BotCreate

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_bot_retrieve

Bot ai_bot_v1_bots_bot_retrieve(id, org)

Create modify and update bot information for a specific tenant.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.bot import Bot
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this bot.
org = 'org_example' # str | 

try:
    api_response = api_instance.ai_bot_v1_bots_bot_retrieve(id, org)
    print("The response of AiBotApi->ai_bot_v1_bots_bot_retrieve:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_bot_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this bot.
org	str

Return type

Bot

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_bot_update

BotCreate ai_bot_v1_bots_bot_update(id, org, bot_create)

Create modify and update bot information for a specific tenant.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.bot_create import BotCreate
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this bot.
org = 'org_example' # str | 
bot_create = iblai.BotCreate() # BotCreate | 

try:
    api_response = api_instance.ai_bot_v1_bots_bot_update(id, org, bot_create)
    print("The response of AiBotApi->ai_bot_v1_bots_bot_update:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_bot_update: %s\n" % e)

Parameters

Name	Type	Description
id	int	A unique integer value identifying this bot.
org	str
bot_create	BotCreate

Return type

BotCreate

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_discord_user_config_create

DiscordConfig ai_bot_v1_bots_discord_user_config_create(org, discord_config)

Setup discord user id linkage with discord bots this will be used to authenticate the user when interracting with discord bots. the user id can be copied from the discord app after tapping on the user profile.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.discord_config import DiscordConfig
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
org = 'org_example' # str | 
discord_config = iblai.DiscordConfig() # DiscordConfig | 

try:
    api_response = api_instance.ai_bot_v1_bots_discord_user_config_create(org, discord_config)
    print("The response of AiBotApi->ai_bot_v1_bots_discord_user_config_create:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_discord_user_config_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
org	str
discord_config	DiscordConfig

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

ai_bot_v1_bots_discord_user_config_destroy

ai_bot_v1_bots_discord_user_config_destroy(id, org)

Setup discord user id linkage with discord bots this will be used to authenticate the user when interracting with discord bots. the user id can be copied from the discord app after tapping on the user profile.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this discord user config.
org = 'org_example' # str | 

try:
    api_instance.ai_bot_v1_bots_discord_user_config_destroy(id, org)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_discord_user_config_destroy: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this discord user config.
org	str

Return type

void (empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

ai_bot_v1_bots_discord_user_config_list

List[DiscordConfig] ai_bot_v1_bots_discord_user_config_list(org)

Setup discord user id linkage with discord bots this will be used to authenticate the user when interracting with discord bots. the user id can be copied from the discord app after tapping on the user profile.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.discord_config import DiscordConfig
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
org = 'org_example' # str | 

try:
    api_response = api_instance.ai_bot_v1_bots_discord_user_config_list(org)
    print("The response of AiBotApi->ai_bot_v1_bots_discord_user_config_list:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_discord_user_config_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
org	str

Return type

List[DiscordConfig]

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_discord_user_config_partial_update

DiscordConfig ai_bot_v1_bots_discord_user_config_partial_update(id, org, patched_discord_config=patched_discord_config)

Setup discord user id linkage with discord bots this will be used to authenticate the user when interracting with discord bots. the user id can be copied from the discord app after tapping on the user profile.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.discord_config import DiscordConfig
from iblai.models.patched_discord_config import PatchedDiscordConfig
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this discord user config.
org = 'org_example' # str | 
patched_discord_config = iblai.PatchedDiscordConfig() # PatchedDiscordConfig |  (optional)

try:
    api_response = api_instance.ai_bot_v1_bots_discord_user_config_partial_update(id, org, patched_discord_config=patched_discord_config)
    print("The response of AiBotApi->ai_bot_v1_bots_discord_user_config_partial_update:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_discord_user_config_partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this discord user config.
org	str
patched_discord_config	PatchedDiscordConfig		[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_discord_user_config_retrieve

DiscordConfig ai_bot_v1_bots_discord_user_config_retrieve(id, org)

Setup discord user id linkage with discord bots this will be used to authenticate the user when interracting with discord bots. the user id can be copied from the discord app after tapping on the user profile.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.discord_config import DiscordConfig
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this discord user config.
org = 'org_example' # str | 

try:
    api_response = api_instance.ai_bot_v1_bots_discord_user_config_retrieve(id, org)
    print("The response of AiBotApi->ai_bot_v1_bots_discord_user_config_retrieve:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_discord_user_config_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this discord user config.
org	str

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_discord_user_config_update

DiscordConfig ai_bot_v1_bots_discord_user_config_update(id, org, discord_config)

Setup discord user id linkage with discord bots this will be used to authenticate the user when interracting with discord bots. the user id can be copied from the discord app after tapping on the user profile.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.discord_config import DiscordConfig
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this discord user config.
org = 'org_example' # str | 
discord_config = iblai.DiscordConfig() # DiscordConfig | 

try:
    api_response = api_instance.ai_bot_v1_bots_discord_user_config_update(id, org, discord_config)
    print("The response of AiBotApi->ai_bot_v1_bots_discord_user_config_update:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_discord_user_config_update: %s\n" % e)

Parameters

Name	Type	Description
id	int	A unique integer value identifying this discord user config.
org	str
discord_config	DiscordConfig

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_slack_user_config_create

SlackConfig ai_bot_v1_bots_slack_user_config_create(org, slack_config)

Setup slack username and domain linkage with slack bots this will be used to authenticate the user when interracting with slack bots.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.slack_config import SlackConfig
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
org = 'org_example' # str | 
slack_config = iblai.SlackConfig() # SlackConfig | 

try:
    api_response = api_instance.ai_bot_v1_bots_slack_user_config_create(org, slack_config)
    print("The response of AiBotApi->ai_bot_v1_bots_slack_user_config_create:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_slack_user_config_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
org	str
slack_config	SlackConfig

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

ai_bot_v1_bots_slack_user_config_destroy

ai_bot_v1_bots_slack_user_config_destroy(id, org)

Setup slack username and domain linkage with slack bots this will be used to authenticate the user when interracting with slack bots.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this slack user config.
org = 'org_example' # str | 

try:
    api_instance.ai_bot_v1_bots_slack_user_config_destroy(id, org)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_slack_user_config_destroy: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this slack user config.
org	str

Return type

void (empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

ai_bot_v1_bots_slack_user_config_list

List[SlackConfig] ai_bot_v1_bots_slack_user_config_list(org)

Setup slack username and domain linkage with slack bots this will be used to authenticate the user when interracting with slack bots.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.slack_config import SlackConfig
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
org = 'org_example' # str | 

try:
    api_response = api_instance.ai_bot_v1_bots_slack_user_config_list(org)
    print("The response of AiBotApi->ai_bot_v1_bots_slack_user_config_list:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_slack_user_config_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
org	str

Return type

List[SlackConfig]

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_slack_user_config_partial_update

SlackConfig ai_bot_v1_bots_slack_user_config_partial_update(id, org, patched_slack_config=patched_slack_config)

Setup slack username and domain linkage with slack bots this will be used to authenticate the user when interracting with slack bots.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.patched_slack_config import PatchedSlackConfig
from iblai.models.slack_config import SlackConfig
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this slack user config.
org = 'org_example' # str | 
patched_slack_config = iblai.PatchedSlackConfig() # PatchedSlackConfig |  (optional)

try:
    api_response = api_instance.ai_bot_v1_bots_slack_user_config_partial_update(id, org, patched_slack_config=patched_slack_config)
    print("The response of AiBotApi->ai_bot_v1_bots_slack_user_config_partial_update:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_slack_user_config_partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this slack user config.
org	str
patched_slack_config	PatchedSlackConfig		[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_slack_user_config_retrieve

SlackConfig ai_bot_v1_bots_slack_user_config_retrieve(id, org)

Setup slack username and domain linkage with slack bots this will be used to authenticate the user when interracting with slack bots.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.slack_config import SlackConfig
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this slack user config.
org = 'org_example' # str | 

try:
    api_response = api_instance.ai_bot_v1_bots_slack_user_config_retrieve(id, org)
    print("The response of AiBotApi->ai_bot_v1_bots_slack_user_config_retrieve:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_slack_user_config_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this slack user config.
org	str

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_slack_user_config_update

SlackConfig ai_bot_v1_bots_slack_user_config_update(id, org, slack_config)

Setup slack username and domain linkage with slack bots this will be used to authenticate the user when interracting with slack bots.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.slack_config import SlackConfig
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this slack user config.
org = 'org_example' # str | 
slack_config = iblai.SlackConfig() # SlackConfig | 

try:
    api_response = api_instance.ai_bot_v1_bots_slack_user_config_update(id, org, slack_config)
    print("The response of AiBotApi->ai_bot_v1_bots_slack_user_config_update:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_slack_user_config_update: %s\n" % e)

Parameters

Name	Type	Description
id	int	A unique integer value identifying this slack user config.
org	str
slack_config	SlackConfig

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_webhooks_discord_create

DiscordWebhook ai_bot_v1_bots_webhooks_discord_create(name, org, discord_webhook)

Webhook endpoint to receive and process discord messages.

Example

import iblai
from iblai.models.discord_webhook import DiscordWebhook
from iblai.rest import ApiException
from pprint import pprint


# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
name = 'name_example' # str | 
org = 'org_example' # str | 
discord_webhook = iblai.DiscordWebhook() # DiscordWebhook | 

try:
    api_response = api_instance.ai_bot_v1_bots_webhooks_discord_create(name, org, discord_webhook)
    print("The response of AiBotApi->ai_bot_v1_bots_webhooks_discord_create:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_webhooks_discord_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str
org	str
discord_webhook	DiscordWebhook

Return type

DiscordWebhook

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ai_bot_v1_bots_webhooks_slack_create

SlackWebhook ai_bot_v1_bots_webhooks_slack_create(name, org, slack_webhook)

Example

import iblai
from iblai.models.slack_webhook import SlackWebhook
from iblai.rest import ApiException
from pprint import pprint


# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
name = 'name_example' # str | 
org = 'org_example' # str | 
slack_webhook = iblai.SlackWebhook() # SlackWebhook | 

try:
    api_response = api_instance.ai_bot_v1_bots_webhooks_slack_create(name, org, slack_webhook)
    print("The response of AiBotApi->ai_bot_v1_bots_webhooks_slack_create:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_webhooks_slack_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str
org	str
slack_webhook	SlackWebhook

Return type

SlackWebhook

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ai_bot_v1_bots_webhooks_webex_create

WebexWebhook ai_bot_v1_bots_webhooks_webex_create(name, org, webex_webhook)

Webhook endpoint to receive and process discord messages.

Example

import iblai
from iblai.models.webex_webhook import WebexWebhook
from iblai.rest import ApiException
from pprint import pprint


# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
name = 'name_example' # str | 
org = 'org_example' # str | 
webex_webhook = iblai.WebexWebhook() # WebexWebhook | 

try:
    api_response = api_instance.ai_bot_v1_bots_webhooks_webex_create(name, org, webex_webhook)
    print("The response of AiBotApi->ai_bot_v1_bots_webhooks_webex_create:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_webhooks_webex_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str
org	str
webex_webhook	WebexWebhook

Return type

WebexWebhook

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ai_bot_v1_bots_webhooks_whatsapp_create

WhatAppWebHook ai_bot_v1_bots_webhooks_whatsapp_create(name, org, what_app_web_hook)

Accept and process webhook events from whatsapp.

Example

import iblai
from iblai.models.what_app_web_hook import WhatAppWebHook
from iblai.rest import ApiException
from pprint import pprint


# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
name = 'name_example' # str | 
org = 'org_example' # str | 
what_app_web_hook = iblai.WhatAppWebHook() # WhatAppWebHook | 

try:
    api_response = api_instance.ai_bot_v1_bots_webhooks_whatsapp_create(name, org, what_app_web_hook)
    print("The response of AiBotApi->ai_bot_v1_bots_webhooks_whatsapp_create:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_webhooks_whatsapp_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str
org	str
what_app_web_hook	WhatAppWebHook

Return type

WhatAppWebHook

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ai_bot_v1_bots_webhooks_whatsapp_retrieve

WhatAppWebHook ai_bot_v1_bots_webhooks_whatsapp_retrieve(name, org)

Respond to whatsapp's webhook challenge. Parameters Required include the tenant key (org) and the name of the bot: (name)

Example

import iblai
from iblai.models.what_app_web_hook import WhatAppWebHook
from iblai.rest import ApiException
from pprint import pprint


# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
name = 'name_example' # str | 
org = 'org_example' # str | 

try:
    api_response = api_instance.ai_bot_v1_bots_webhooks_whatsapp_retrieve(name, org)
    print("The response of AiBotApi->ai_bot_v1_bots_webhooks_whatsapp_retrieve:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_webhooks_whatsapp_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str
org	str

Return type

WhatAppWebHook

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ai_bot_v1_bots_whatsapp_user_config_create

WhatsappConfig ai_bot_v1_bots_whatsapp_user_config_create(org, whatsapp_config)

Setup phone number linkage with whatsapp bots This phone number will be used to authenticate and allow access to whatsapp bots.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.whatsapp_config import WhatsappConfig
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
org = 'org_example' # str | 
whatsapp_config = iblai.WhatsappConfig() # WhatsappConfig | 

try:
    api_response = api_instance.ai_bot_v1_bots_whatsapp_user_config_create(org, whatsapp_config)
    print("The response of AiBotApi->ai_bot_v1_bots_whatsapp_user_config_create:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_whatsapp_user_config_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
org	str
whatsapp_config	WhatsappConfig

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

ai_bot_v1_bots_whatsapp_user_config_destroy

ai_bot_v1_bots_whatsapp_user_config_destroy(id, org)

Setup phone number linkage with whatsapp bots This phone number will be used to authenticate and allow access to whatsapp bots.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this whatsapp user config.
org = 'org_example' # str | 

try:
    api_instance.ai_bot_v1_bots_whatsapp_user_config_destroy(id, org)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_whatsapp_user_config_destroy: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this whatsapp user config.
org	str

Return type

void (empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

ai_bot_v1_bots_whatsapp_user_config_list

List[WhatsappConfig] ai_bot_v1_bots_whatsapp_user_config_list(org)

Setup phone number linkage with whatsapp bots This phone number will be used to authenticate and allow access to whatsapp bots.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.whatsapp_config import WhatsappConfig
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
org = 'org_example' # str | 

try:
    api_response = api_instance.ai_bot_v1_bots_whatsapp_user_config_list(org)
    print("The response of AiBotApi->ai_bot_v1_bots_whatsapp_user_config_list:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_whatsapp_user_config_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
org	str

Return type

List[WhatsappConfig]

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_whatsapp_user_config_partial_update

WhatsappConfig ai_bot_v1_bots_whatsapp_user_config_partial_update(id, org, patched_whatsapp_config=patched_whatsapp_config)

Setup phone number linkage with whatsapp bots This phone number will be used to authenticate and allow access to whatsapp bots.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.patched_whatsapp_config import PatchedWhatsappConfig
from iblai.models.whatsapp_config import WhatsappConfig
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this whatsapp user config.
org = 'org_example' # str | 
patched_whatsapp_config = iblai.PatchedWhatsappConfig() # PatchedWhatsappConfig |  (optional)

try:
    api_response = api_instance.ai_bot_v1_bots_whatsapp_user_config_partial_update(id, org, patched_whatsapp_config=patched_whatsapp_config)
    print("The response of AiBotApi->ai_bot_v1_bots_whatsapp_user_config_partial_update:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_whatsapp_user_config_partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this whatsapp user config.
org	str
patched_whatsapp_config	PatchedWhatsappConfig		[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_whatsapp_user_config_retrieve

WhatsappConfig ai_bot_v1_bots_whatsapp_user_config_retrieve(id, org)

Setup phone number linkage with whatsapp bots This phone number will be used to authenticate and allow access to whatsapp bots.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.whatsapp_config import WhatsappConfig
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this whatsapp user config.
org = 'org_example' # str | 

try:
    api_response = api_instance.ai_bot_v1_bots_whatsapp_user_config_retrieve(id, org)
    print("The response of AiBotApi->ai_bot_v1_bots_whatsapp_user_config_retrieve:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_whatsapp_user_config_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this whatsapp user config.
org	str

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

ai_bot_v1_bots_whatsapp_user_config_update

WhatsappConfig ai_bot_v1_bots_whatsapp_user_config_update(id, org, whatsapp_config)

Setup phone number linkage with whatsapp bots This phone number will be used to authenticate and allow access to whatsapp bots.

Example

Api Key Authentication (PlatformApiKeyAuthentication):

import iblai
from iblai.models.whatsapp_config import WhatsappConfig
from iblai.rest import ApiException
from pprint import pprint

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
    host="https://base.manager.iblai.app", 
    key=os.environ["API_KEY"]
)

# Create an instance of the API class
api_instance = iblai.AiBotApi(api_client)
id = 56 # int | A unique integer value identifying this whatsapp user config.
org = 'org_example' # str | 
whatsapp_config = iblai.WhatsappConfig() # WhatsappConfig | 

try:
    api_response = api_instance.ai_bot_v1_bots_whatsapp_user_config_update(id, org, whatsapp_config)
    print("The response of AiBotApi->ai_bot_v1_bots_whatsapp_user_config_update:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling AiBotApi->ai_bot_v1_bots_whatsapp_user_config_update: %s\n" % e)

Parameters

Name	Type	Description
id	int	A unique integer value identifying this whatsapp user config.
org	str
whatsapp_config	WhatsappConfig

Return type

Authorization