Send-SMSBroadcast

SYNOPSIS

Send-SMSBroadcast sends a SMS Message via the SMSBroadcast APIs

SYNTAX

Set 1

Send-SMSBroadcast [-SMSUsername] <Object> [-SMSPassword] <Object> [-To] <Object> [-Message] <Object> [[-From] <Object>] [[-ReferenceNum] <Object>] [[-Delay] <Int32>] [-WebResponse] [<CommonParameters>]

DESCRIPTION

Connects to the SMSBroadcast APIs to send Messages.

EXAMPLES

Send a Simple SMS

Hello World Message

PS C:\> Send-SMSBroadcast -SMSUsername "YourUserName' -SMSPassword 'Password123' -To 04xxxxxxxx -Message "Hello World"

PARAMETERS

SMSUsername

Your SMS Broadcast username. This is the same username that you would use to login to the SMS Broadcast website.

Type: Object
Parameter Sets: Set 1
Aliases: 

Required: true
Position: 0
Default Value: 
Pipeline Input: false

SMSPassword

Your SMS Broadcast password. This is the same password that you would use to login to the SMS Broadcast website.

Type: Object
Parameter Sets: Set 1
Aliases: 

Required: true
Position: 1
Default Value: 
Pipeline Input: false

To

The receiving mobile number(s). The numbers can be in the format: 04xxxxxxxx (Australian format) 614xxxxxxxx (International format without a preceding +) 4xxxxxxxx (missing leading 0) We recommend using the international format, but your messages will be accepted in any of the above formats. To send the same message to multiple recipients, the numbers should be separated by a comma. The numbers should contain only numbers, with no spaces or other characters

Type: Object
Parameter Sets: Set 1
Aliases: 

Required: true
Position: 2
Default Value: 
Pipeline Input: false

Message

The content of the SMS message. Must not be longer than 160 characters unless the maxsplit parameter is used. Must be URL encoded.

Type: Object
Parameter Sets: Set 1
Aliases: 

Required: true
Position: 3
Default Value: 
Pipeline Input: false

From

The sender ID for the messages. Can be a mobile number or letters, up to 11 characters and should not contain punctuation or spaces. Leave blank to use SMS Broadcast's 2-way number.

Type: Object
Parameter Sets: Set 1
Aliases: 

Required: false
Position: 4
Default Value: 
Pipeline Input: false

ReferenceNum

Your reference number for the message to help you track the message status. This parameter is optional and can be up to 20 characters.

Type: Object
Parameter Sets: Set 1
Aliases: 

Required: false
Position: 5
Default Value: 
Pipeline Input: false

Delay

Number of minutes to delay the message. Use this to schedule messages for later delivery.

Type: Int32
Parameter Sets: Set 1
Aliases: 

Required: false
Position: 6
Default Value: 0
Pipeline Input: false

WebResponse

Type: SwitchParameter
Parameter Sets: Set 1
Aliases: 

Required: false
Position: named
Default Value: False
Pipeline Input: false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

RELATED LINKS

Online Version:

Module Hompage

Generated by: PowerShell HelpWriter 2019 v2.3.42

Get-SMSBroadcastBalance

SYNOPSIS

Get-SMSBroadcastBalance gets the remaining SMS credit balance for the account used

SYNTAX

Set 1

Get-SMSBroadcastBalance [-SMSUsername] <Object> [-SMSPassword] <Object> [-WebResponse] [<CommonParameters>]

DESCRIPTION

Connects via the APIs and returns the number of remaining credits the Switch Paramater -WebResponse returns the RAW response

EXAMPLES

Get SMS Balance

PS C:\>

Get-SMSBroadcastBalance -SMSUsername 'YourUsername' -SMSPassword 'Password123'

PARAMETERS

SMSUsername

Your SMS Broadcast username. This is the same username that you would use to login to the SMS Broadcast website.

Type: Object
Parameter Sets: Set 1
Aliases: 

Required: true
Position: 0
Default Value: 
Pipeline Input: false

SMSPassword

Your SMS Broadcast password. This is the same password that you would use to login to the SMS Broadcast website.

Type: Object
Parameter Sets: Set 1
Aliases: 

Required: true
Position: 1
Default Value: 
Pipeline Input: false

WebResponse

Type: SwitchParameter
Parameter Sets: Set 1
Aliases: 

Required: false
Position: named
Default Value: False
Pipeline Input: false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

RELATED LINKS

Online Version:

Module Homepage

Generated by: PowerShell HelpWriter 2019 v2.3.42