wxc_sdk package

Simple SDK for Webex APIs with focus on Webex Calling specific endpoints

class wxc_sdk.WebexSimpleApi(*, tokens: str | Tokens = None, concurrent_requests: int = 10, retry_429: bool = True, session: RestSession = None, **kwargs: Any)[source]

Bases: object

The main API object

__init__(*, tokens: str | Tokens = None, concurrent_requests: int = 10, retry_429: bool = True, session: RestSession = None, **kwargs: Any) → None[source]
Parameters:

  • tokens – token to be used by the API. Can be a tokens.Tokens instance, a string or None. If None then an access token is expected in the WEBEX_ACCESS_TOKEN environment variable.

  • concurrent_requests (int) – number of concurrent requests when using multi-threading

  • retry_429 (bool) – automatically retry for 429 throttling response

  • session (RestSession) – if given, this rest.RestSession instance will be used for all requests instead of creating a new one

  • kwargs – additional arguments to be passed to the constructor of the session object to be used for all requests

session: RestSession

rest.RestSession used for all API requests

admin_audit: AdminAuditEventsApi

Admin Audit Events API admin_audit.AdminAuditEventsApi

attachment_actions: AttachmentActionsApi

Attachment actions API attachment_actions.AttachmentActionsApi

authorizations: AuthorizationsApi

Authorizations API authorizations.AuthorizationsApi

cdr: DetailedCDRApi

CDR API cdr.DetailedCDRApi

converged_recordings: ConvergedRecordingsApi

converged recordings API converged_recordings.ConvergedRecordingsApi

device_configurations: DeviceConfigurationsApi

device configurations API device_configurations.DeviceConfigurationsApi

devices: DevicesApi

devices API devices.DevicesApi

events: EventsApi

events API; events.EventsApi

groups: GroupsApi

groups API groups.GroupsApi

guests: GuestManagementApi

guests API guests.GuestManagementApi

jobs: JobsApi

telephony.jobs.JobsApi

Type:

jobs API

licenses: LicensesApi

Licenses API licenses.LicensesApi

locations: LocationsApi

Location API locations.LocationsApi

me: MeSettingsApi

call settings for me API me.MeSettingsApi

meetings: MeetingsApi

meetings API meetings.MeetingsApi

membership: MembershipApi

membership API memberships.MembershipApi

messages: MessagesApi

Messages API messages.MessagesApi

org_contacts: OrganizationContactsApi

org contacts API org_contacts.OrganizationContactsApi

organizations: OrganizationApi

organization settings API

person_settings: PersonSettingsApi

Person settings API person_settings.PersonSettingsApi

people: PeopleApi

People API people.PeopleApi

reports: ReportsApi

Reports API reports.ReportsApi

roles: RolesApi

Roles API roles.RolesApi

rooms: RoomsApi

Rooms API rooms.RoomsApi

room_tabs: RoomTabsApi

Room tabs API room_tabs.RoomTabsApi

scim: ScimV2Api

scimv2.ScimV2Api

Type:

ScimV2 API

status: StatusAPI

Webex Status API status.StatusAPI

teams: TeamsApi

Teams API teams.TeamsApi

team_memberships: TeamMembershipsApi

Team memberships API TeamMembershipsApi

telephony: TelephonyApi

Telephony (features) API telephony.TelephonyApi

webhook: WebhookApi

Webhooks API webhook.WebhookApi

workspaces: WorkspacesApi

Workspaces API workspaces.WorkspacesApi

workspace_locations: WorkspaceLocationApi

Workspace locations API; workspace_locations.WorkspaceLocationApi

workspace_personalization: WorkspacePersonalizationApi

workspace_personalization.WorkspacePersonalizationApi`

Type:

Workspace personalization API

Type:

class

workspace_settings: WorkspaceSettingsApi

Workspace setting API workspace_settings.WorkspaceSettingsApi

xapi: XApi

XAPI API xapi.XApi

property access_token: str | None

access token used for all requests

Returns:

access token

Return type:

str

close() → None[source]

Subpackages

Submodules