library simwoodapi

opensaucesystems/simwoodapi

A simple object orientated way to interact with the simwood.com API

Simwood API Client - Wiki - Home

, _(*1)

About:, _(*2)

This php composer package provides a simple object orientated way to interact with the simwood.com API., _(*3)

Author:, _(*4)

@lcherone, _(*5)

Setup:, _(*6)

Using composer add the package to your project:, _(*7)

composer require opensaucesystems/simwoodapi, _(*8)

Initializing the client, _(*9)

<?php
require 'vendor/autoload.php';

/**
 * Initialize the API client class
 */
$simwood = new opensaucesystems\simwood\APIClient(
    'APIUSER', //<-- get from simwood
    'APIKEY'   //<-- get from simwood
);
?>

Account Id:, _(*10)

I've chosen to not include this in the class construct, so it must be passed to each method call if required, this is because of the way the API has multiple accounts levels., _(*11)

You can set it in a variable or you can hard-code it to the method call, no biggie!, _(*12)

<?php
$account_id = '999999';
?>

Making calls:, _(*13)

To interact with the API its as simple as calling a class method or property, endpoints are dynamically loaded when traversed to., _(*14)

See the wikis below for further details on each endpoint., _(*15)

[ ] Todo
[-] Partially done
[X] Done
[!] Broken

• [X] Tools, _(*16)

  • [X] My IP
  • [X] Time

• [X] Accounts, _(*17)

  • [X] Credit
    • [X] Invoices
      • [X] All
      • [X] Unpaid
      • [X] Paid
      • [X] PDF
  • [X] Prepay
    • [X] Balance
    • [X] Low Balance Alerts
    • [X] Locking
    • [X] Summary
    • [X] Pre-payments
      • [X] All
      • [X] Latest
    • [X] Transfers
      • [X] All
      • [X] Latest
  • [X] Rates
    • [X] Breakouts
      • [X] Date
      • [X] Future
    • [X] Codes
      • [X] Date
      • [X] Future
    • [X] CSV
    • [X] Lookup
  • [X] Reports
    • [X] Voice
      • [X] Summary
      • [X] CDR
        • [X] Day
        • [X] Latest
    • [X] SMS
      • [X] CDR
        • [X] Day
        • [X] Latest
    • [X] Admin
      • [X] CDR
      • [X] Day
  • [X] Summary
    • [X] In
    • [X] Out
      • [X] by destid
      • [X] by iso
      • [X] by codec
      • [X] by tag
      • [X] by trunk
  • [X] Notifications
    • [X] Available
    • [X] Type
    • [X] Method (email, http, sms)
    • [X] Hash
    • [X] History

• [-] Voice, _(*18)

  • [X] Limits
  • [X] Channels
  • [X] Current
  • [X] History
  • [X] In-progress
  • [ ] Outbound - Trunk Management
  • [ ] Outbound - Balance
  • [ ] Outbound - In-progress
  • [ ] Outbound - ACL
  • [ ] Outbound - ACL/IP
  • [ ] Outbound - Password Reset
  • [ ] Destination ACL
  • [ ] IDA

• [X] Inline CDR, _(*19)

  • [X] CDR
    • [X] {YYYY-MM-DD}
    • [X] {YYYY-MM-DD}/{REFERENCE}

• [X] Real-time Calls in Progress, _(*20)

• [-] Numbers, _(*21)

  • [X] Ranges
  • [X] Available
  • [X] Consecutive
  • [X] Allocated
    • [X] All
    • [X] 10|100|100|1000
  • [-] Number
    • [X] Config
    • [ ] SMS
    • [ ] 999
    • [X] Default Config
    • [X] [Manage]
      • [X] Info
      • [X] Allocate
      • [X] Delete/Deconfigure

• [ ] Porting, _(*22)

  • [ ] Ports

• [ ] Fax, _(*23)

  • [ ] Inbound
  • [ ] Hash

• [ ] Messaging, _(*24)

  • [ ] SMS
  • [ ] Fax

• [X] Asynchronous Report File, _(*25)