WickrAdminAPI / Client / get_bots_count

get_bots_count

WickrAdminAPI.Client.get_bots_count(**kwargs)

Retrieves the count of bots in a Wickr network, categorized by their status (pending, active, and total).

See also: AWS API Documentation

Request Syntax

response = client.get_bots_count(
    networkId='string'
)

Parameters:

networkId (string) –

[REQUIRED]

The ID of the Wickr network for which to retrieve bot counts.

Return type:

dict

Returns:

Response Syntax

{
    'pending': 123,
    'active': 123,
    'total': 123
}

Response Structure

• (dict) –

  • pending (integer) –

    The number of bots with pending status (invited but not yet activated).

  • active (integer) –

    The number of bots with active status.

  • total (integer) –

    The total number of bots in the network (active and pending).

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