SMSAero.Client

SMSAero HTTP servant client and individual client functions.

Client

smsAeroClient :: Client SMSAeroAPI

SMSAero client.

defaultBaseUrl :: BaseUrl

Default host https://gate.smsaero.ru.

type SmsAero a = ClientM (SmsAeroResponse a)

Common SMSAero client response type.

Sending a message

smsAeroSend

Arguments

:: SMSAeroAuth

Authentication data (login and MD5 hash of password).

-> Phone

Phone number to send a message to.

-> MessageBody

Message text.

-> Signature

Sender's signature used for the "from" field.

-> Maybe SMSAeroDate

Date stating when to send a postponed message.

-> Maybe SendType

Send channel description.

-> Maybe DigitalChannel

Use digital send channel.

-> SmsAero SendResponse

Send a message.

smsAeroSendToGroup

Arguments

:: SMSAeroAuth

Authentication data (login and MD5 hash of password).

-> Group

Group name for broadcasting a message.

-> MessageBody

Message text.

-> Signature

Sender's signature used for the "from" field.

-> Maybe SMSAeroDate

Date stating when to send a postponed message.

-> Maybe SendType

Send channel description.

-> Maybe DigitalChannel

Use digital send channel.

-> SmsAero SendResponse

Send a group message.

Checking status

smsAeroStatus

Arguments

:: SMSAeroAuth

Authentication data (login and MD5 hash of password).

-> MessageId

Message ID.

-> SmsAero MessageStatus

Check status of a previously sent message.

smsAeroCheckSending

Arguments

:: SMSAeroAuth

Authentication data (login and MD5 hash of password).

-> MessageId

Broadcast ID.

-> SmsAero CheckSendingResponse

Check status of a broadcast.

Checking balance and tariff

smsAeroBalance

Arguments

:: SMSAeroAuth

Authentication data (login and MD5 hash of password).

-> SmsAero BalanceResponse

Check balance.

smsAeroCheckTariff

Arguments

:: SMSAeroAuth

Authentication data (login and MD5 hash of password).

-> SmsAero CheckTariffResponse

Check tariff.

Signatures

smsAeroSenders

Arguments

:: SMSAeroAuth

Authentication data (login and MD5 hash of password).

-> SmsAero SendersResponse

Check the list of available sender signatures.

smsAeroSign

Arguments

:: SMSAeroAuth

Authentication data (login and MD5 hash of password).

-> SmsAero SignResponse

Acquire a new signature.

Groups

smsAeroListGroups

Arguments

:: SMSAeroAuth

Authentication data (login and MD5 hash of password).

-> SmsAero [Group]

Get groups list (corresponds to checkgroup endpoint).

smsAeroAddGroup

Arguments

:: SMSAeroAuth

Authentication data (login and MD5 hash of password).

-> Group

Name for the new group.

-> SmsAero GroupResponse

Add a group.

smsAeroDeleteGroup

Arguments

:: SMSAeroAuth

Authentication data (login and MD5 hash of password).

-> Group

Name of the group to be deleted.

-> SmsAero GroupResponse

Delete a group.

Contacts

smsAeroAddPhone

Arguments

:: SMSAeroAuth

Authentication data (login and MD5 hash of password).

-> Phone

Subscriber's phone number.

-> Maybe Group

Contact group. If absent, contact will be added to general contact list.

-> Maybe Name

Subscriber's last name.

-> Maybe Name

Subscriber's first name.

-> Maybe Name

Subscriber's middle name.

-> Maybe BirthDate

Subscriber's birth date.

-> Maybe Text

Any additional information.

-> SmsAero PhoneResponse

Add a phone to contact list or group.

smsAeroDeletePhone

Arguments

:: SMSAeroAuth

Authentication data (login and MD5 hash of password).

-> Phone

Subscriber's phone number.

-> Maybe Group

Group to remove contact from. If absent, contact will be deleted from general contact list.

-> SmsAero PhoneResponse

Delete a phone from contact list or group.

Blacklist

smsAeroAddToBlacklist

Arguments

:: SMSAeroAuth

Authentication data (login and MD5 hash of password)

-> Phone

Phone number to be added to blacklist.

-> SmsAero BlacklistResponse

Add a phone number to blacklist.