WickrAdminAPI / Client / get_bot

get_bot

WickrAdminAPI.Client.get_bot(**kwargs)

Retrieves detailed information about a specific bot in a Wickr network, including its status, group membership, and authentication details.

See also: AWS API Documentation

Request Syntax

response = client.get_bot(
    networkId='string',
    botId='string'
)
Parameters:

  • networkId (string) –

    [REQUIRED]

    The ID of the Wickr network containing the bot.

  • botId (string) –

    [REQUIRED]

    The unique identifier of the bot to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'botId': 'string',
    'displayName': 'string',
    'username': 'string',
    'uname': 'string',
    'pubkey': 'string',
    'status': 123,
    'groupId': 'string',
    'hasChallenge': True|False,
    'suspended': True|False,
    'lastLogin': 'string'
}

Response Structure

  • (dict) –

    • botId (string) –

      The unique identifier of the bot.

    • displayName (string) –

      The display name of the bot that is visible to users.

    • username (string) –

      The username of the bot.

    • uname (string) –

      The unique username hash identifier for the bot.

    • pubkey (string) –

      The public key of the bot used for encryption.

    • status (integer) –

      The current status of the bot (1 for pending, 2 for active).

    • groupId (string) –

      The ID of the security group to which the bot belongs.

    • hasChallenge (boolean) –

      Indicates whether the bot has a password set.

    • suspended (boolean) –

      Indicates whether the bot is currently suspended.

    • lastLogin (string) –

      The timestamp of the bot’s last login.

Exceptions