Merge branch 'master' of github.com:typpo/textbelt
This commit is contained in:
Ian Webster
commit
e1219bf32b
24
README.md
24
README.md
@ -27,6 +27,7 @@ Sample failure:
|
||||
```
|
||||
{"success":false,"message":"Exceeded quota for this phone number."}
|
||||
```
|
||||
|
||||
### Usage as a module
|
||||
|
||||
Though this repository contains an express server so you may run your own
|
||||
@ -34,6 +35,7 @@ instance of the web app, you may also use it to send text messages in your
|
||||
project. The only requirement is unix/posix `sendmail`, used to forward the message.
|
||||
|
||||
For example, to send a text using the default settings:
|
||||
|
||||
```
|
||||
var text = require('textbelt');
|
||||
|
||||
@ -45,6 +47,7 @@ text.send('9491234567', 'A sample text message!', undefined, function(err) {
|
||||
```
|
||||
|
||||
You can also supply a region (valid choices are `us`, `intl`, or `canada`)
|
||||
|
||||
```
|
||||
var text = require('textbelt');
|
||||
|
||||
@ -57,7 +60,6 @@ text.send('9491234567', 'A sample text message!', 'canada', function(err) {
|
||||
text.send('1119491234567', 'Bonjour!', 'intl', function(err) {
|
||||
...
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Usage as a standalone server
|
||||
@ -66,6 +68,8 @@ Textbelt can be run as a standalone server with: `node server/app.js`. Be sure
|
||||
|
||||
By default, the server listens on port 9090 and is configured to accept traffic from a reverse proxy or load balancer such as nginx. To enable accurate IP rate limiting, the reverse proxy should be configured to set the `X-Real-IP` header.
|
||||
|
||||
Don't forget to set `fromAddress` in `lib/text.js` to the email address you want to send from.
|
||||
|
||||
### Canadian and International endpoints
|
||||
|
||||
The /text endpoint supports U.S. phone numbers (and parts of Canada).
|
||||
@ -76,6 +80,20 @@ For international texts, curl `http://textbelt.com/intl`.
|
||||
|
||||
Canadian and international support may not be complete. Refer to the list of supported carriers.
|
||||
|
||||
### Textbelt Clients
|
||||
|
||||
* go - [dietsche/textbelt](https://github.com/dietsche/textbelt)
|
||||
* node.js - [minond/textbelt](https://github.com/minond/textbelt), [ajay-gandhi/textbelt](https://github.com/ajay-gandhi/textbelt), [soondobu/mtextbelt](https://github.com/soondobu/mtextbelt)
|
||||
* php - [ctrlaltdylan/courier](https://github.com/ctrlaltdylan/courier), [securingsincity/phpsms](https://github.com/securingsincity/phpsms)
|
||||
* bash - [cfalk/MessageMe](https://github.com/cfalk/MessageMe)
|
||||
* html/js webpage - [mLuby/SMS](https://github.com/mLuby/SMS)
|
||||
* Browser extension - [Chrome](https://chrome.google.com/webstore/detail/textbelter/clciehobfheendclpnmbgbalelignpoa), [Firefox](https://addons.mozilla.org/en-US/firefox/addon/textbelter/), [Safari](https://github.com/daluu/textbelt-clients/raw/master/textbelter.safariextz), [Opera](https://addons.opera.com/en/extensions/details/textbelter/?display=en)
|
||||
* Windows Phone - [TextBelter](https://www.microsoft.com/en-us/store/apps/textbelter/9nblggh1z2dg)
|
||||
* [SendSMS Mac App](https://itunes.apple.com/app/sendsms/id584131262?mt=12)
|
||||
* [OSX dashboard widget](https://github.com/daluu/textbelt-clients/releases/download/1.0/TextBelter.wdgt.zip)
|
||||
* [Windows 7/Vista gadget](https://github.com/daluu/textbelt-clients/releases/download/1.0/textbelter.gadget.zip)
|
||||
|
||||
|
||||
### Notes and Limitations
|
||||
|
||||
* Some carriers are picky about which messages they deliver. A "success" response from Textbelt means that your message was given to the carrier.
|
||||
@ -84,9 +102,9 @@ Canadian and international support may not be complete. Refer to the list of su
|
||||
|
||||
* Some carriers may deliver text messages from "txt@textbelt.com"
|
||||
|
||||
* Supported U.S. carriers: Alltel, Ameritech, AT&T Wireless, Boost, CellularOne, Cingular, Edge Wireless, Sprint PCS, Telus Mobility, T-Mobile, Metro PCS, Nextel, O2, Orange, Qwest, Rogers Wireless, US Cellular, Verizon, Virgin Mobile.
|
||||
* Supported U.S. carriers: Alltel, Ameritech, AT&T Wireless, Boost, CellularOne, Cingular, Edge Wireless, Sprint PCS, Telus Mobility, T-Mobile, Metro PCS, Nextel, O2, Orange, Qwest, Rogers Wireless, Ting, US Cellular, Verizon, Virgin Mobile.
|
||||
|
||||
* Supported U.S. and Canadian carriers (/canada): 3 River Wireless, ACS Wireless, AT&T, Alltel, BPL Mobile, Bell Canada, Bell Mobility, Bell Mobility (Canada), Blue Sky Frog, Bluegrass Cellular, Boost Mobile, Carolina West Wireless, Cellular One, Cellular South, Centennial Wireless, CenturyTel, Cingular (Now AT&T), Clearnet, Comcast, Corr Wireless Communications, Dobson, Edge Wireless, Fido, Golden Telecom, Helio, Houston Cellular, Idea Cellular, Illinois Valley Cellular, Inland Cellular Telephone, MCI, MTS, Metro PCS, Metrocall, Metrocall 2-way, Microcell, Midwest Wireless, Mobilcomm, Nextel, OnlineBeep, PCS One, President's Choice, Public Service Cellular, Qwest, Rogers AT&T Wireless, Rogers Canada, Satellink, Solo Mobile, Southwestern Bell, Sprint, Sumcom, Surewest Communicaitons, T-Mobile, Telus, Tracfone, Triton, US Cellular, US West, Unicel, Verizon, Virgin Mobile, Virgin Mobile Canada, West Central Wireless, Western Wireless
|
||||
* Supported U.S. and Canadian carriers (/canada): 3 River Wireless, ACS Wireless, AT&T, Alltel, BPL Mobile, Bell Canada, Bell Mobility, Bell Mobility (Canada), Blue Sky Frog, Bluegrass Cellular, Boost Mobile, Carolina West Wireless, Cellular One, Cellular South, Centennial Wireless, CenturyTel, Cingular (Now AT&T), Clearnet, Comcast, Corr Wireless Communications, Dobson, Edge Wireless, Fido, Golden Telecom, Helio, Houston Cellular, Idea Cellular, Illinois Valley Cellular, Inland Cellular Telephone, MCI, MTS, Metro PCS, Metrocall, Metrocall 2-way, Microcell, Midwest Wireless, Mobilcomm, Nextel, OnlineBeep, PCS One, President's Choice, Public Service Cellular, Qwest, Republic Wireless, Rogers AT&T Wireless, Rogers Canada, Satellink, Solo Mobile, Southwestern Bell, Sprint, Sumcom, Surewest Communicaitons, T-Mobile, Telus, Tracfone, Triton, US Cellular, US West, Unicel, Verizon, Virgin Mobile, Virgin Mobile Canada, West Central Wireless, Western Wireless
|
||||
|
||||
* Supported international carriers (/intl): Chennai RPG Cellular, Chennai Skycell / Airtel, Comviq, DT T-Mobile, Delhi Aritel, Delhi Hutch, Dutchtone / Orange-NL, EMT, Escotel, German T-Mobile, Goa BPLMobil, Golden Telecom, Gujarat Celforce, JSM Tele-Page, Kerala Escotel, Kolkata Airtel, Kyivstar, LMT, Lauttamus Communication, Maharashtra BPL Mobile, Maharashtra Idea Cellular, Manitoba Telecom Systems, Meteor, MiWorld, Mobileone, Mobilfone, Mobility Bermuda, Mobistar Belgium, Mobitel Tanzania, Mobtel Srbija, Movistar, Mumbai BPL Mobile, Netcom, Ntelos, O2, O2 (M-mail), One Connect Austria, OnlineBeep, Optus Mobile, Orange, Orange Mumbai, Orange NL / Dutchtone, Oskar, P&T Luxembourg, Personal Communication, Pondicherry BPL Mobile, Primtel, SCS-900, SFR France, Safaricom, Satelindo GSM, Simple Freedom, Smart Telecom, Southern LINC, Sunrise Mobile, Surewest Communications, Swisscom, T-Mobile Austria, T-Mobile Germany, T-Mobile UK, TIM, TSR Wireless, Tamil Nadu BPL Mobile, Tele2 Latvia, Telefonica Movistar, Telenor, Teletouch, Telia Denmark, UMC, Uraltel, Uttar Pradesh Escotel, Vessotel, Vodafone Italy, Vodafone Japan, Vodafone UK, Wyndtell
|
||||
|
||||
|
||||
@ -3,6 +3,7 @@ module.exports = {
|
||||
us: [
|
||||
'%s@email.uscc.net',
|
||||
'%s@message.alltel.com',
|
||||
'%s@message.ting.com',
|
||||
'%s@messaging.sprintpcs.com',
|
||||
'%s@mobile.celloneusa.com',
|
||||
'%s@msg.telus.com',
|
||||
@ -14,6 +15,7 @@ module.exports = {
|
||||
'%s@txt.att.net',
|
||||
'%s@txt.windmobile.ca',
|
||||
'%s@vtext.com',
|
||||
'%s@text.republicwireless.com'
|
||||
|
||||
//'%s@sms.edgewireless.com', // slow
|
||||
],
|
||||
|
||||
Loading…
Reference in New Issue
Block a user