The cl-textmagic Reference Manual

This is the cl-textmagic Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:33:47 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-textmagic

Common lisp implementation of TextMagic API to send SMS

Author

Trumae da Ilha

License

MIT

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 (system).
  • cl-json (system).
Source

cl-textmagic.asd.

Child Component

src (module).


3 Modules

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


3.1 cl-textmagic/src

Source

cl-textmagic.asd.

Parent Component

cl-textmagic (system).

Child 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/cl-textmagic.asd

Source

cl-textmagic.asd.

Parent Component

cl-textmagic (system).

ASDF Systems

cl-textmagic.

Packages

cl-textmagic-asd.


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

Source

cl-textmagic.asd.

Parent Component

src (module).

Packages

cl-textmagic.

Internals

5 Packages

Packages are listed by definition order.


5.1 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.

Use List

common-lisp.

Internals

5.2 cl-textmagic-asd

Source

cl-textmagic.asd.

Use List
  • asdf/interface.
  • common-lisp.

6 Definitions

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


6.1 Internals


6.1.1 Ordinary 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.

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.

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.

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.

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.

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.


Appendix A Indexes


A.1 Concepts


A.3 Variables