Upwire APIs Node.js Client
A Node.js package to consume Upwire Restful services
Usage
Install the package using npm:
npm install upwire --save
Then, require the package with your Upwire usenrame and passcode:
const Upwire = require('upwire')({username: '[username]', passcode: '[passcode]'});
Services from the Upwire API https://upwire.docs.apiary.io/ can be executed by calling a method with options.
For example to send an SMS:
options ="callerid": "[callerid]""destinations": "[destination]""message": "Test message from Upwire"UpwireMessage
Note: 'callerid' must be an SMS enabled number purchased from Upwire and 'destination' must be in international number format.
Complete List of Services
Master Job
Docs: https://upwire.docs.apiary.io/#reference/master-job
Master Submit
Create
options ="action": "create""templateId": "[templateId]""csvData": "False""data":"id": "[id]""name": "[name]""mobile": "[mobile]""landline": "[landline]""email": "[email]"UpwireMaster
Wait for API Call
options ="templateId": "[templateId]"UpwireMaster
Append
options ="templateId": "[templateId]""autoStart": "True""csvData": "False""data":"id": "[id]""name": "[name]""mobile": "[mobile]""landline": "[landline]""email": "[email]"UpwireMaster
Note: If "autoStart" is set to "True" the append service will check for a running masterJob, if none found a new masterJob will be started
Job Control
Pause Job
options ="jobNumber": "[master_job_number]"UpwireControl
Restart Job
options ="jobNumber": "[master_job_number]"UpwireControl
Cancel Job
options ="jobNumber": "[master_job_number]"UpwireControl
Job Reporting
List Master Jobs
options ="limit": 1UpwireReporing
Get Master Job
options ="jobnumber": "[master_job_number]"UpwireReporing
Get Master Data
options ="jobnumber": "[master_job_number]"UpwireReporing
Get Master Stats
options ="jobnumber": "[master_job_number]"UpwireReporing
Get SMS Job Stats
options ="jobnumber": "[sms_job_number]"UpwireReporing
Get Voice Job Stats
options ="jobnumber": "[voice_job_number]"UpwireReporing
Get Voice Job Responses
options ="jobnumber": "[voice_job_number]"UpwireReporing
Get Email Job Stats
options ="jobnumber": "[email_job_number]"UpwireReporing
Admin
Docs: https://upwire.docs.apiary.io/#reference/sms-raw/admin/get-sub-jobs-stats-email
List Countries
UpwireReporing
Get Country Capabilities
options ="country": "country"UpwireReporing
Search Numbers
options ="numberType": "mobile""countryCode": "44""searchString": "447"UpwireReporing