Network.Api.TextLocal

Haskell wrapper for sending SMS using textlocal SMS gateway.

Sending SMS

1. Get an api key from textlocal.in
2. Quick way to send:

>> import Network.Api.TextLocal
>> let cred = createUserHash "[e-mail]" "my-secret-hash"
>> res <- sendSMS "hello world" ["911234567890"] cred
>> res
Right (TLResponse {status = Success, warnings = Nothing, errors = Nothing})

Or in a more configurable way:

>> import Network.Api.TextLocal
>> let cred = createUserHash "[e-mail]" "my-secret-hash"
>> let destNums = ["911234567890"]
>> let mySettings = setDestinationNumber destNums $  setAuth cred $ setTest True defaultSMSSettings
>> res <- runSettings SendSMS (setMessage "hello world" mySettings)
>> res
Right (TLResponse {status = Success, warnings = Nothing, errors = Nothing})

Credential

data Credential

Credential for making request to textLocal server. There are multiple ways for creating it. You can either use createApiKey or createUserHash to create this type.

createApiKey

Arguments

:: ByteString

Api key

-> Credential

Create Credential for textLocal using api key.

createUserHash

Arguments

:: ByteString

Email address

-> ByteString

Secure hash that is found within the messenger.

-> Credential

Create Credential for textLocal using email and secure hash.

Settings

data SMSSettings

defaultSMSSettings :: SMSSettings

defaultSMSSettings has the default settings, duh! The settingsSender has a value of TXTLCL. Using the accessors setMessage, setAuth, setDestinationNumber you should properly initialize their respective values. By default, these fields contain a value of bottom.

Setters

setManager :: Manager -> SMSSettings -> SMSSettings

Use an existing manager instead of creating a new one

setDestinationNumber :: [ByteString] -> SMSSettings -> SMSSettings

setMessage :: ByteString -> SMSSettings -> SMSSettings

setAuth :: Credential -> SMSSettings -> SMSSettings

setTest :: Bool -> SMSSettings -> SMSSettings

Set this field to true to enable test mode, no messages will be sent and your credit balance will be unaffected. It defaults to false.

Send SMS

runSettings :: Command -> SMSSettings -> IO (Either JSONException TLResponse)

sendSMS

Arguments

:: ByteString

Text to send

-> [ByteString]

Destination numbers

-> Credential

-> IO (Either JSONException TLResponse)

data Command

Constructors

SendSMS

Instances

Eq Command

Methods

(==) :: Command -> Command -> Bool

(/=) :: Command -> Command -> Bool

Ord Command

Methods

compare :: Command -> Command -> Ordering

(<) :: Command -> Command -> Bool

(<=) :: Command -> Command -> Bool

(>) :: Command -> Command -> Bool

(>=) :: Command -> Command -> Bool

max :: Command -> Command -> Command

min :: Command -> Command -> Command

Show Command

Methods

showsPrec :: Int -> Command -> ShowS

show :: Command -> String

showList :: [Command] -> ShowS