PsWebexTeams

PsWebexTeams is a PowerShell module for interacting with Webex Teams

Installation

Use Install-Module to install from PowerShell Gallery

Install-Module PsWebexTeams

Authentication

The primary goal of this module is interacting with Webex teams without state. This is not for building a chatbot. If that’s what you’re looking to do, please use the nodeJS bot framework to support web hooks.

API tokens will be saved in the following directories.

• Windows: "$env:LOCALAPPDATA\PSWebexTeams\PSWebexTeamsConfig.xml"
• MacOS / Linux "$env:HOME/.config/powershell/PSWebexTeamsConfig.xml"

When running any commands, they will check this file for the auth token to prevent authentication params having to be passed to each function.

Bot Auth

The easiest way to get started with this module is to use a bot. The authentication tokens are static, and won’t have to be refreshed. See Webex documentation for more info in creating bots.

Once we’ve created out bot API keys we need to save them to our PC.

Set-WebexTeamsCredential -token  <API Token>

OAuth (User Authentication)

To act on behalf of a user account, you first need to setup an integration

The OAuth flow can be completed without running a web server. Set the redirectUri to be a non-existent domain/one that you own.

You will be given two pieces of information, A client ID and Secret. Save both off to the side for now.

You will need to authorize the integration to act on behalf of your account, there will be a pre-generated link on the integration. Paste the link into your browser to grant an authentication code. You can exchange your authentication code into a refresh token by running the following.

$splat = @{
    clientID     = 'Replace Me'
    clientSecret = 'Replace Me'
    redirectURI  = "Replace Me"
    accessCode   = "Replace Me"
}

$refreshInfo = New-WebexTeamsRefreshToken @splat
Set-WebexTeamsCredential -token $refreshInfo.access_token -refreshinfo $refreshInfo

A hook is built into each command to re-issue a refresh/access token when necessary. If no commands are ran within 90 days, the authentication code process will have to be repeated to issue a new refresh token. To check the lifetime on your 90 day token run the following

Get-WebexTeamsCredentialTime

To manually issue a new access token, and reset the refresh token’s 90-day timer run the following

Get-WebexTeamsCredential -Renew

Usage

#Setting your API Key
Set-WebexTeamsCredential -token  <API Token>
#Lookup User
Get-WebexTeamsUser -email <Email>
Get-WebexTeamsUser -DisplayName "John Doe"
Get-ADUser username -pro mail | Get-WebexTeamsUser

#Lookup messages from user. Max 50.
Get-WebexTeamsUser -email <Email> | Get-WebexTeamsDirectMessage
Get-WebexTeamsDirectMessage -email <User>


#Lookup ALL messages from room
Get-WebexTeamsRoom | ? { $_.title -eq "Name" }| Get-WebexTeamsMessage

#Lookup last 100 messages from room
Get-WebexTeamsRoom | ? { $_.title -eq "Name" }| Get-WebexTeamsMessage -max 100

#Lookup messages before date, Must use a date time object
Get-WebexTeamsMessage -before 

#Send message to room
Get-WebexTeamsRoom | ? { $_.title -eq "Name" } | Send-WebexTeamsMessage -text <Text>

#Send message to a user
Send-WebexTeamsMessgae -email <Email> -text <Text>


#Edit a message. Messages can only be edited 10 times, further edits after that will trigger an error.
Set-WebexTeamsMessage -messageId <messageId> -roomId <roomId> -Text "Edited"
Get-WebexTeamsMessage -messageId <messageId> | Set-WebexTeamsMessage -text "Edited"


#Delete a message


#Get the 

To lookup a resource by it's ID, you will need to use the Get-WebexTeams*Details cmdlets.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT