❤
npm
Sign UpSign In

tel-carrier-gateways

2.0.0 • Public • Published

tel-carrier-gateway

(this project may be merged into the sms-address module)

Performs a lookup of the mobile phone carrier company name to get the sms and mms gateway email addresses for that carrier.

You can use the SMS gateway address to send text messages from email.

Usage

npm install tel-carrier-gateway
'use strict';
 
var smsAddress = require('tel-carrier-gateway')
  , email
  ;
 
email = smsAddress.sms('verizon', 5550002222);
 
console.log(email);
// 5550002222@vtext.com

API

  • sms - lookup sms domain or email
  • mms - lookup mms domain or email
  • carrier - reverse lookup carrier from sms, mms, or company name
  • lookup - return an object with sms, mms, wireless, and carrier short name

sms

Accepts any carrier name / company name string and an optional phone number and returns the gateway domain or email to sms address or null

lookups.sms(carrierString);                   // gateway
lookups.sms(carrierString[, phone]);          // phone@gateway
lookups.sms('Cellco DBA Verizon Wireless');   // "vtext.com"
lookups.sms('T-Mobile', '+15550002222');      // "5550002222@tmomail.net"
lookups.sms('att', '+15550002222');           // "5550002222@txt.att.net"

mms

Accepts any carrier name / company name string and an optional phone number and returns the gateway domain or email to mms address or null

lookups.mms(carrierString);                   // gateway
lookups.mms(carrierString[, phone]);          // phone@gateway
lookups.mms('AT&T Mobility');                 // "mms.att.net"
lookups.mms('Sprint', '+15550002222');        // "5550002222@pm.sprint.com"
lookups.mms('tmobile', '+15550002222');       // "5550002222@tmomail.net"

carrier

Accepts an sms or mms gateway domain or email address, or a carrier string and returns the simple carrier string or null

lookups.carrier(smsMmsOrCarrierString);       // programmer-friendly carrier name
lookups.sms('AT&T Mobility');                 // "att"
lookups.sms('messaging.sprintpcs.com');       // "sprint"
lookups.carrier('5550002222@vzwpix.com');     // "verizon"

lookup

lookups.lookup(carrierStr[, phone, object]);
lookups.lookup("Verizon");
 
{ carrier: 'verizon'
, smsGateway: 'vtext.com'
, mmsGateway: 'vzwpix.com'
}
 
 
lookups.lookup("Verizon Wireless", '5550002222', { foo: "bar" });
 
{ foo: 'bar'
, wireless: true
, carrier: 'verizon'
, smsAddress: '5550002222@vtext.com
, mmsAddress: '5550002222@vzwpix.com
}

Readme

Keywords

Package Sidebar

Install

npm i tel-carrier-gateways

Repository

github.com/coolaj86/tel-carrier-gateways

Homepage

github.com/coolaj86/node-tel-carrier

Weekly Downloads

9

Version

2.0.0

License

Apache2

Last publish

Collaborators

  • coolaj86
Try on RunKit
Report malware