The cl-textmagic Reference Manual

Table of Contents

The cl-textmagic Reference Manual

This is the cl-textmagic Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:25:32 2018 GMT+0.

1 Introduction

Cl-Textmagic

Common lisp implementation of TextMagic API to send SMS

Author

• Trumae da Ilha (trumae@gmail.com)

Copyright

Copyright (c) 2015 Trumae da Ilha (trumae@gmail.com)

License

Licensed under the MIT License

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-textmagic

Author

Trumae da Ilha

License

MIT

Description

Common lisp implementation of TextMagic API to send SMS

Long Description

# Cl-Textmagic

Common lisp implementation of TextMagic API to send SMS

## Author

* Trumae da Ilha (trumae@gmail.com)

## Copyright

Copyright (c) 2015 Trumae da Ilha (trumae@gmail.com)

## License

Licensed under the MIT License

Version

0.1

Dependencies

• dexador
• cl-json

Source

cl-textmagic.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 cl-textmagic/src

Parent

cl-textmagic (system)

Location

src/

Component

cl-textmagic.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 cl-textmagic.asd

Location

cl-textmagic.asd

Systems

cl-textmagic (system)

Packages

cl-textmagic-asd

4.1.2 cl-textmagic/src/cl-textmagic.lisp

Parent

src (module)

Location

src/cl-textmagic.lisp

Packages

cl-textmagic

Internal Definitions

• account (function)
• check_number (function)
• delete_reply (function)
• message_status (function)
• receive (function)
• send (function)

5 Packages

Packages are listed by definition order.

5.1 cl-textmagic-asd

Source

cl-textmagic.asd

Use List

• asdf/interface
• common-lisp

5.2 cl-textmagic

All these commands can be executed only if you provide a
valid username and API password (get it here) in your requests. All TextMagic API commands (on a per-need basis) use the following key parameters:

Parameter_name Example
username xxxx
password yyyy
phone_number 447123456789

For more details see http://api.textmagic.com/https-api/textmagic-api-commands

Source

cl-textmagic.lisp (file)

Use List

common-lisp

Internal Definitions

• account (function)
• check_number (function)
• delete_reply (function)
• message_status (function)
• receive (function)
• send (function)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Internal definitions

6.1.1 Functions

Function: account USERNAME PASSWORD

The send command is used to send an SMS message to a mobile phone.

Package

cl-textmagic

Source

cl-textmagic.lisp (file)

Function: check_number USERNAME PASSWORD PHONE

This command helps you to validate a phone number’s format and to check a message’s price to its destination. It also returns the phone number’s country code.

Package

cl-textmagic

Source

cl-textmagic.lisp (file)

Function: delete_reply USERNAME PASSWORD IDS

This command helps you to delete any incoming SMS messages from the server.

Package

cl-textmagic

Source

cl-textmagic.lisp (file)

Function: message_status USERNAME PASSWORD IDS

This command allows you to retrieve the delivery status of any SMS you have already sent.

Package

cl-textmagic

Source

cl-textmagic.lisp (file)

Function: receive USERNAME PASSWORD ID

This command retrieves the incoming SMS messages from the server. You can request any SMS sent to one of our SMS reply numbers by using this API.

Package

cl-textmagic

Source

cl-textmagic.lisp (file)

Function: send USERNAME PASSWORD TEXT PHONE

The send command is used to send an SMS message to a mobile phone.

Package

cl-textmagic

Source

cl-textmagic.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types