Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the voipms Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:08:29 2022 GMT+0.
Next: Systems, Previous: The voipms Reference Manual, Up: The voipms Reference Manual [Contents][Index]
Common Lisp HTTP api client to the voip.ms api.
Sample usage:
(defparameter *voipms-auth*
(make-voipms-auth :username
(sb-posix:getenv "VOIPMS_USERNAME")
:password
(sb-posix:getenv "VOIPMS_PASSWORD")))
(loop for sms in
(voipms:get-sms *voipms-auth*
:contact "8004664411"
:from (voipms:date-n-days-ago 10))
do
(with-json-paths sms
(message type did contact id date)
(let ((received-p (= (parse-integer type) 1)))
(format t "Message received from ~A to ~A on ~A: ~A"
(if received-p contact did)
(if received-p did contact)
date
message))))
Next: Files, Previous: Introduction, Up: The voipms Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Common Lisp HTTP api client to the voip.ms api.
Ernesto Alfonso <erjoalgo@gmail.com>
BSD
voipms.lisp (file).
Next: Packages, Previous: Systems, Up: The voipms Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: voipms/voipms.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
voipms (system).
Previous: voipms/voipms.asd, Up: Lisp [Contents][Index]
voipms (system).
Next: Definitions, Previous: Files, Up: The voipms Reference Manual [Contents][Index]
Packages are listed by definition order.
common-lisp.
Next: Indexes, Previous: Packages, Up: The voipms Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
The LOCAL-TIME::FORMAT-TIMESTRING format that the voip.ms API expects in date parameters.
Previous: Special variables, Up: Public Interface [Contents][Index]
Returns a date string n DAYS in the past.
Useful as the FROM (date) parameter in various api, e.g. getSMS which defaults FROM to today.
voip.ms api call for getSMS. Supports the query parameters: (FROM TO CONTACT DID LIMIT TYPE SMS).
Makes an HTTP request to the voip.ms API.
AUTH is an VOIPMS-AUTH struct specifying credentials.
METHOD is the voip.ms api method.
QPARAMS is an alist of query parameters.
If NO-ERROR is non-nil, no error is raised on non-success statuses.
If ALLOWED-STATUSES is non-nil, no error is raised on any non-success
statuses contained in this list.
For API docs, see https://voip.ms/m/apidocs.php.
voip.ms api call for sendSMS. Supports the query parameters: (DID DST MESSAGE).
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]
Define a function NAME which makes a request to the voip.ms api
with the given METHOD and query parameters.
ALLOWED-STATUSES
specifies a list of non-success statuses returned by the API
to be considered non-errors.
Next: Structures, Previous: Macros, Up: Internals [Contents][Index]
voip.ms api call for cancelDID. Supports the query parameters: (DID CANCELCOMMENT PORTOUT TEST).
voip.ms api call for getAllowedCodecs. Supports the query parameters: NIL.
voip.ms api call for getAuthTypes. Supports the query parameters: NIL.
voip.ms api call for getDeviceTypes. Supports the query parameters: NIL.
voip.ms api call for getDIDsInfo. Supports the query parameters: (CLIENT DID).
voip.ms api call for getDIDsUSA. Supports the query parameters: (STATE RATECENTER).
voip.ms api call for getDTMFModes. Supports the query parameters: NIL.
voip.ms api call for getLockInternational. Supports the query parameters: NIL.
voip.ms api call for getMusicOnHold. Supports the query parameters: NIL.
voip.ms api call for getNAT. Supports the query parameters: NIL.
voip.ms api call for getRateCentersUSA. Supports the query parameters: (STATE).
voip.ms api call for getRingGroups. Supports the query parameters: (RING_GROUP).
voip.ms api call for getRoutes. Supports the query parameters: NIL.
voip.ms api call for getServersInfo. Supports the query parameters: (SERVER_POP).
voip.ms api call for getSubAccounts. Supports the query parameters: (ACCOUNT).
voip.ms api call for orderDID. Supports the query parameters: (DID ROUTING FAILOVER_BUSY FAILOVER_UNREACHABLE FAILOVER_NOANSWER VOICEMAIL POP DIALTIME CNAM CALLERID_PREFIX NOTE BILLING_TYPE ACCOUNT MONTHLY SETUP MINUTE TEST).
voip.ms api call for sendMMS. Supports the query parameters: (DID DST MESSAGE MEDIA1 MEDIA2 MEDIA3).
voip.ms api call for setSMS. Supports the query parameters: (DID ENABLE EMAIL_ENABLED EMAIL_ADDRESS SMS_FORWARD_ENABLE SMS_FORWARD URL_CALLBACK_ENABLE URL_CALLBACK_RETRY URL_CALLBACK SMPP_ENABLED SMPP_URL SMPP_USER SMPP_PASS).
voip.ms api call for setSubAccount. Supports the query parameters: (ID
DESCRIPTION
AUTH_TYPE
PASSWORD IP
DEVICE_TYPE
CALLERID_NUMBER
CANADA_ROUTING
LOCK_INTERNATIONAL
INTERNATIONAL_ROUTE
MUSIC_ON_HOLD
LANGUAGE
RECORD_CALLS
ALLOWED_CODECS
DTMF_MODE
NAT
SIP_TRAFFIC
MAX_EXPIRY
RTP_TIMEOUT
RTP_HOLD_TIMEOUT
IP_RESTRICTION
ENABLE_IP_RESTRICTION
POP_RESTRICTION
ENABLE_POP_RESTRICTION
SEND_BYE
INTERNAL_EXTENSION
INTERNAL_VOICEMAIL
INTERNAL_DIALTIME
RESELLER_CLIENT
RESELLER_PACKAGE
RESELLER_NEXTBILLING
RESELLER_CHARGESETUP).
Previous: Definitions, Up: The voipms Reference Manual [Contents][Index]
Jump to: | (
A C D F G M O R S V |
---|
Jump to: | (
A C D F G M O R S V |
---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
Jump to: | +
B P S U |
---|
Jump to: | +
B P S U |
---|
Jump to: | F P S V |
---|
Jump to: | F P S V |
---|