The voipms Reference Manual

3.1.1 voipms/voipms.asd

Source

voipms.asd.

Parent Component

voipms (system).

ASDF Systems

voipms.

---

3.1.2 voipms/voipms.lisp

Source

voipms.asd.

Parent Component

voipms (system).

Packages

voipms.

Public Interface

• *auth* (special variable).
• *fordbidden-phone-numbers* (special variable).
• +local-time-timestring-format+ (special variable).
• current-did-for-account (function).
• date-n-days-ago (function).
• get-dids-info (function).
• get-sms (function).
• get-sms-messages (function).
• init-auth-from-env (function).
• make-voipms-auth (function).
• request (function).
• sanitize-phone-number (function).
• send-sms (function).

Internals

• +max-date-range-days+ (special variable).
• alist-get (function).
• base-url (special variable).
• cancel-did (function).
• copy-sms (function).
• copy-voipms-auth (function).
• create-sub-account (function).
• def-endpoint (macro).
• get-allowed-codecs (function).
• get-auth-types (function).
• get-device-types (function).
• get-dids-usa (function).
• get-dtmf-modes (function).
• get-lock-international (function).
• get-music-on-hold (function).
• get-nat (function).
• get-protocols (function).
• get-rate-centers-usa (function).
• get-ring-groups (function).
• get-routes (function).
• get-servers-info (function).
• get-sms-messages-helper (function).
• get-sub-accounts (function).
• init-auth-from-string (function).
• make-sms (function).
• order-did (function).
• send-mms (function).
• set-sms (function).
• set-sub-account (function).
• set-sub-account-sparse (function).
• sms (structure).
• sms-from (reader).
• (setf sms-from) (writer).
• sms-id (reader).
• (setf sms-id) (writer).
• sms-message (reader).
• (setf sms-message) (writer).
• sms-p (function).
• sms-timestamp (reader).
• (setf sms-timestamp) (writer).
• sms-to (reader).
• (setf sms-to) (writer).
• voipms-auth (structure).
• voipms-auth-p (function).
• voipms-auth-password (reader).
• (setf voipms-auth-password) (writer).
• voipms-auth-username (reader).
• (setf voipms-auth-username) (writer).

---

5.1.1 Special variables

Special Variable: *auth* ¶

Package

voipms.

Source

voipms.lisp.

Special Variable: *fordbidden-phone-numbers* ¶

Package

voipms.

Source

voipms.lisp.

Special Variable: +local-time-timestring-format+ ¶

The LOCAL-TIME::FORMAT-TIMESTRING format that the voip.ms API expects in date parameters.

Package

voipms.

Source

voipms.lisp.

---

5.1.2 Ordinary functions

Function: current-did-for-account (account-name) ¶

Package

voipms.

Source

voipms.lisp.

Function: date-n-days-ago (days) ¶

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.

Package

voipms.

Source

voipms.lisp.

Function: get-dids-info (auth &key client did) ¶

voip.ms api call for getDIDsInfo. Supports the query parameters: (CLIENT DID).

Package

voipms.

Source

voipms.lisp.

Function: get-sms (auth &key from to contact did limit type sms) ¶

voip.ms api call for getSMS. Supports the query parameters: (FROM TO CONTACT DID LIMIT TYPE SMS).

Package

voipms.

Source

voipms.lisp.

Function: get-sms-messages (phone &key max-days-ago) ¶

Package

voipms.

Source

voipms.lisp.

Function: init-auth-from-env () ¶

Package

voipms.

Source

voipms.lisp.

Function: make-voipms-auth (&key username password) ¶

Package

voipms.

Source

voipms.lisp.

Function: request (auth method &optional qparams no-error allowed-statuses) ¶

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.

Package

voipms.

Source

voipms.lisp.

Function: sanitize-phone-number (phone) ¶

Package

voipms.

Source

voipms.lisp.

Function: send-sms (auth &key did dst message) ¶

voip.ms api call for sendSMS. Supports the query parameters: (DID DST MESSAGE).

Package

voipms.

Source

voipms.lisp.

---

5.2.1 Special variables

Special Variable: +max-date-range-days+ ¶

Package

voipms.

Source

voipms.lisp.

Special Variable: base-url ¶

Package

voipms.

Source

voipms.lisp.

---

5.2.2 Macros

Macro: def-endpoint (name method params &key allowed-statuses) ¶

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.

Package

voipms.

Source

voipms.lisp.

---

5.2.3 Ordinary functions

Function: alist-get (key alist) ¶

Package

voipms.

Source

voipms.lisp.

Function: cancel-did (auth &key did cancelcomment portout test) ¶

voip.ms api call for cancelDID. Supports the query parameters: (DID CANCELCOMMENT PORTOUT TEST).

Package

voipms.

Source

voipms.lisp.

Function: copy-sms (instance) ¶

Package

voipms.

Source

voipms.lisp.

Function: copy-voipms-auth (instance) ¶

Package

voipms.

Source

voipms.lisp.

Function: create-sub-account (auth &key username protocol description auth_type password device_type lock_international international_route music_on_hold dtmf_mode nat ip callerid_number canada_routing allow225 language record_calls allowed_codecs sip_traffic max_expiry rtp_timeout rtp_hold_timeout ip_restriction enable_ip_restriction pop_restriction enable_pop_restriction send_bye transcribe transcription_locale transcription_email internal_extension internal_voicemail internal_dialtime reseller_client reseller_package reseller_nextbilling reseller_chargesetup parking_lot) ¶

voip.ms api call for createSubAccount. Supports the query parameters: (USERNAME PROTOCOL DESCRIPTION AUTH_TYPE PASSWORD DEVICE_TYPE LOCK_INTERNATIONAL INTERNATIONAL_ROUTE MUSIC_ON_HOLD DTMF_MODE
NAT IP CALLERID_NUMBER CANADA_ROUTING ALLOW225 LANGUAGE RECORD_CALLS ALLOWED_CODECS SIP_TRAFFIC MAX_EXPIRY RTP_TIMEOUT RTP_HOLD_TIMEOUT IP_RESTRICTION ENABLE_IP_RESTRICTION POP_RESTRICTION ENABLE_POP_RESTRICTION SEND_BYE TRANSCRIBE TRANSCRIPTION_LOCALE TRANSCRIPTION_EMAIL INTERNAL_EXTENSION INTERNAL_VOICEMAIL INTERNAL_DIALTIME RESELLER_CLIENT RESELLER_PACKAGE RESELLER_NEXTBILLING RESELLER_CHARGESETUP PARKING_LOT).

Package

voipms.

Source

voipms.lisp.

Function: get-allowed-codecs (auth &key) ¶

voip.ms api call for getAllowedCodecs. Supports the query parameters: NIL.

Package

voipms.

Source

voipms.lisp.

Function: get-auth-types (auth &key) ¶

voip.ms api call for getAuthTypes. Supports the query parameters: NIL.

Package

voipms.

Source

voipms.lisp.

Function: get-device-types (auth &key) ¶

voip.ms api call for getDeviceTypes. Supports the query parameters: NIL.

Package

voipms.

Source

voipms.lisp.

Function: get-dids-usa (auth &key state ratecenter) ¶

voip.ms api call for getDIDsUSA. Supports the query parameters: (STATE RATECENTER).

Package

voipms.

Source

voipms.lisp.

Function: get-dtmf-modes (auth &key) ¶

voip.ms api call for getDTMFModes. Supports the query parameters: NIL.

Package

voipms.

Source

voipms.lisp.

Function: get-lock-international (auth &key) ¶

voip.ms api call for getLockInternational. Supports the query parameters: NIL.

Package

voipms.

Source

voipms.lisp.

Function: get-music-on-hold (auth &key) ¶

voip.ms api call for getMusicOnHold. Supports the query parameters: NIL.

Package

voipms.

Source

voipms.lisp.

Function: get-nat (auth &key) ¶

voip.ms api call for getNAT. Supports the query parameters: NIL.

Package

voipms.

Source

voipms.lisp.

Function: get-protocols (auth &key) ¶

voip.ms api call for getProtocols. Supports the query parameters: NIL.

Package

voipms.

Source

voipms.lisp.

Function: get-rate-centers-usa (auth &key state) ¶

voip.ms api call for getRateCentersUSA. Supports the query parameters: (STATE).

Package

voipms.

Source

voipms.lisp.

Function: get-ring-groups (auth &key ring_group) ¶

voip.ms api call for getRingGroups. Supports the query parameters: (RING_GROUP).

Package

voipms.

Source

voipms.lisp.

Function: get-routes (auth &key) ¶

voip.ms api call for getRoutes. Supports the query parameters: NIL.

Package

voipms.

Source

voipms.lisp.

Function: get-servers-info (auth &key server_pop) ¶

voip.ms api call for getServersInfo. Supports the query parameters: (SERVER_POP).

Package

voipms.

Source

voipms.lisp.

Function: get-sms-messages-helper (phone &key max-days-ago) ¶

Package

voipms.

Source

voipms.lisp.

Function: get-sub-accounts (auth &key account) ¶

voip.ms api call for getSubAccounts. Supports the query parameters: (ACCOUNT).

Package

voipms.

Source

voipms.lisp.

Function: init-auth-from-string (string) ¶

string is a colon-delimited username:password

Package

voipms.

Source

voipms.lisp.

Function: make-sms (&key message from to timestamp id) ¶

Package

voipms.

Source

voipms.lisp.

Function: order-did (auth &key 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 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).

Package

voipms.

Source

voipms.lisp.

Function: send-mms (auth &key did dst message media1 media2 media3) ¶

voip.ms api call for sendMMS. Supports the query parameters: (DID DST MESSAGE MEDIA1 MEDIA2 MEDIA3).

Package

voipms.

Source

voipms.lisp.

Function: set-sms (auth &key 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 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).

Package

voipms.

Source

voipms.lisp.

Function: set-sub-account (auth &key 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) ¶

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

Package

voipms.

Source

voipms.lisp.

Function: set-sub-account-sparse (auth account-name &rest args &key 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) ¶

Package

voipms.

Source

voipms.lisp.

Reader: sms-from (instance) ¶

Writer: (setf sms-from) (instance) ¶

Package

voipms.

Source

voipms.lisp.

Target Slot

from.

Reader: sms-id (instance) ¶

Writer: (setf sms-id) (instance) ¶

Package

voipms.

Source

voipms.lisp.

Target Slot

id.

Reader: sms-message (instance) ¶

Writer: (setf sms-message) (instance) ¶

Package

voipms.

Source

voipms.lisp.

Target Slot

message.

Function: sms-p (object) ¶

Package

voipms.

Source

voipms.lisp.

Reader: sms-timestamp (instance) ¶

Writer: (setf sms-timestamp) (instance) ¶

Package

voipms.

Source

voipms.lisp.

Target Slot

timestamp.

Reader: sms-to (instance) ¶

Writer: (setf sms-to) (instance) ¶

Package

voipms.

Source

voipms.lisp.

Target Slot

to.

Function: voipms-auth-p (object) ¶

Package

voipms.

Source

voipms.lisp.

Reader: voipms-auth-password (instance) ¶

Writer: (setf voipms-auth-password) (instance) ¶

Package

voipms.

Source

voipms.lisp.

Target Slot

password.

Reader: voipms-auth-username (instance) ¶

Writer: (setf voipms-auth-username) (instance) ¶

Package

voipms.

Source

voipms.lisp.

Target Slot

username.

---

5.2.4 Structures

Structure: sms ¶

Package

voipms.

Source

voipms.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: message ¶

Readers

sms-message.

Writers

(setf sms-message).

Slot: from ¶

Readers

sms-from.

Writers

(setf sms-from).

Slot: to ¶

Readers

sms-to.

Writers

(setf sms-to).

Slot: timestamp ¶

Readers

sms-timestamp.

Writers

(setf sms-timestamp).

Slot: id ¶

Readers

sms-id.

Writers

(setf sms-id).

Structure: voipms-auth ¶

Package

voipms.

Source

voipms.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: username ¶

Readers

voipms-auth-username.

Writers

(setf voipms-auth-username).

Slot: password ¶

Readers

voipms-auth-password.

Writers

(setf voipms-auth-password).

---