voip.ms

programs for using API of voip.ms service

Description

This set of programs uses a config file to supply authentication information to use the API of the VOIP service at voip.ms. There is an included example config file that needs to have the userid and password changed, and the file installed into your HOME directory. You can tweak the config file to set which fields you are interested in, the order and size of the fields, and the titles.

Included programs

  black-list        - manage black listed phone numbers
  get-cdrs          - get CDRs (Call Display Records)
  get-did-info      - get DID (Direct Inward Dialing) info about the phone(s)
  phone-recording   - turn recording of incoming calls for a phone line on or off
  send-sms-message  - send an SMS (short Message Service) message

Example usages

This will print CDR records from November 11 to November 22, in reverse order such that records will be numbered from oldest to newest:

  % get-cdrs --from 2017-11-15 --to 2017-11-22 --reverse

This will print last months CDR records and the cost for account 'home':

  % get-cdrs --last-month --cost --account home

This will print the filter rules along with filter IDs to make changes to an existing rule:

  % black-list

This will set a filter rule giving a Busy signal instead of the default NoService message:

  % black-list --note 'Bad Evil Dudes' --busy  416-555-1212 

This will change the previous filter rule from Busy to Hangup instead:

  % black-list --note 'Bad Evil Dudes' --hangup --filterid 12345 416-555-1212

This will print all data about each DID, with the phone-number preceded by the (sub)account-name:

  % get-did-info --account --all

This will send a SMS message to barney (an alias set up in the config file):

  % send-sms-message -r barney Time for a beer

This will turn recording on for incoming calls for the default phone number listed in your config file:

  % phone-recording on

There is a help option with each program. For eg:

  % get-cdrs --help
  usage: get-cdrs.plx [options]*
      [-a|--account str]         account name
      [-c|--config file]         config-file (default=/home/rj/.voip-ms.conf)
      [-d|--debug]               debug output.  Twice for more info
      [-f|--from YYYY-MM-DD]     FROM date
      [-h|--help]                help
      [-p|--padding num]         padding between output fields   (default=3)
      [-q|--quiet]               quiet.  No headings and titles
      [-r|--reverse]             reverse date order of CDR output
      [-s|--sheldon]
      [-t|--to YYYY-MM-DD]       TO date
      [-C|--cost]                total up costs and duration of CDRs
      [-E|--expected-account]    CDRs expected in each (sub)account
      [-I|--ignore]              show ignored CDRs as specified in config file
      [-L|--last-month]          want CDR records for LAST month
      [-T|--this-month]          want CDR records for THIS month
      [-V|--version]             version of this program (v0.6)

API setup.

You need to set up your voip.ms service to permit access to it. This includes providing which IP addresses can use it. Please see the following URL for instructions:

https://voip.ms/m/api.php