WickrAdminAPI / Client / create_bot

create_bot

WickrAdminAPI.Client.create_bot(**kwargs)

Creates a new bot in a specified Wickr network. Bots are automated accounts that can send and receive messages, enabling integration with external systems and automation of tasks.

See also: AWS API Documentation

Request Syntax

response = client.create_bot(
    networkId='string',
    username='string',
    displayName='string',
    groupId='string',
    challenge='string'
)
Parameters:

  • networkId (string) –

    [REQUIRED]

    The ID of the Wickr network where the bot will be created.

  • username (string) –

    [REQUIRED]

    The username for the bot. This must be unique within the network and follow the network’s naming conventions.

  • displayName (string) – The display name for the bot that will be visible to users in the network.

  • groupId (string) –

    [REQUIRED]

    The ID of the security group to which the bot will be assigned.

  • challenge (string) –

    [REQUIRED]

    The password for the bot account.

Return type:

dict

Returns:

Response Syntax

{
    'message': 'string',
    'botId': 'string',
    'networkId': 'string',
    'username': 'string',
    'displayName': 'string',
    'groupId': 'string'
}

Response Structure

  • (dict) –

    • message (string) –

      A message indicating the result of the bot creation operation.

    • botId (string) –

      The unique identifier assigned to the newly created bot.

    • networkId (string) –

      The ID of the network where the bot was created.

    • username (string) –

      The username of the newly created bot.

    • displayName (string) –

      The display name of the newly created bot.

    • groupId (string) –

      The ID of the security group to which the bot was assigned.

Exceptions

  • WickrAdminAPI.Client.exceptions.ValidationError

  • WickrAdminAPI.Client.exceptions.BadRequestError

  • WickrAdminAPI.Client.exceptions.ResourceNotFoundError

  • WickrAdminAPI.Client.exceptions.ForbiddenError

  • WickrAdminAPI.Client.exceptions.UnauthorizedError

  • WickrAdminAPI.Client.exceptions.InternalServerError

  • WickrAdminAPI.Client.exceptions.RateLimitError