ytel v3.1.2

Getting started

Ytel API version 3

How to Build

The generated SDK relies on Node Package Manager (NPM) being available to resolve dependencies. If you don't already have NPM installed, please go ahead and follow instructions to install NPM from here. The SDK also requires Node to be installed. If Node isn't already installed, please install it from here

NPM is installed by default when Node is installed

To check if node and npm have been successfully installed, write the following commands in command prompt:

• node --version
• npm -version

Now use npm to resolve all dependencies by running the following command in the root directory (of the SDK folder):

npm install

This will install all dependencies in the node_modules folder.

Once dependencies are resolved, you will need to move the folder YtelAPIV3Lib in to your node_modules folder.

How to Use

The following section explains how to use the library in a new project.

1. Open Project Folder

Open an IDE/Text Editor for JavaScript like Sublime Text. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Click on File and select Open Folder.

Select the folder of your SDK and click on Select Folder to open it up in Sublime Text. The folder will become visible in the bar on the left.

2. Creating a Test File

Now right click on the folder name and select the New File option to create a new test file. Save it as index.js Now import the generated NodeJS library using the following lines of code:

var lib = require('lib');

Save changes.

3. Running The Test File

To run the index.js file, open up the command prompt and navigate to the Path where the SDK folder resides. Type the following command to run the file:

node index.js

How to Test

These tests use Mocha framework for testing, coupled with Chai for assertions. These dependencies need to be installed for tests to run. Tests can be run in a number of ways:

Method 1 (Run all tests)

1. Navigate to the root directory of the SDK folder from command prompt.
2. Type mocha --recursive to run all the tests.

Method 2 (Run all tests)

1. Navigate to the ../test/Controllers/ directory from command prompt.
2. Type mocha * to run all the tests.

Method 3 (Run specific controller's tests)

1. Navigate to the ../test/Controllers/ directory from command prompt.
2. Type mocha Ytel API V3Controller to run all the tests in that controller file.

To increase mocha's default timeout, you can change the TEST_TIMEOUT parameter's value in TestBootstrap.js.

Initialization

Authentication

In order to setup authentication in the API client, you need the following information.

API client can be initialized as following:

const lib = require('lib');

// Configuration parameters and credentials
lib.Configuration.basicAuthUserName = "basicAuthUserName"; // The username to use with basic authentication
lib.Configuration.basicAuthPassword = "basicAuthPassword"; // The password to use with basic authentication

Class Reference

List of Controllers

• ShortCodeController
• AreaMailController
• PostCardController
• LetterController
• CallController
• PhoneNumberController
• SMSController
• SharedShortCodeController
• ConferenceController
• CarrierController
• EmailController
• AccountController
• SubAccountController
• AddressController
• RecordingController
• TranscriptionController
• UsageController

ShortCodeController

Get singleton instance

The singleton instance of the ShortCodeController class can be accessed from the API Client.

var controller = lib.ShortCodeController;

createListShortcodes

Retrieve a list of Short Code assignment associated with your Ytel account.

function createListShortcodes(shortcode, page, pagesize, callback)

Parameters

Example Usage

    var shortcode = 'Shortcode';
    var page = 'page';
    var pagesize = 'pagesize';

    controller.createListShortcodes(shortcode, page, pagesize, function(error, response, context) {

    
    });

createViewSMS

Retrieve a single Short Code object by its shortcode assignment.

function createViewSMS(shortcode, callback)

Parameters

Example Usage

    var shortcode = 'Shortcode';

    controller.createViewSMS(shortcode, function(error, response, context) {

    
    });

createViewSMS1

View a single Sms Short Code message.

function createViewSMS1(messageSid, callback)

Parameters

Example Usage

    var messageSid = 'MessageSid';

    controller.createViewSMS1(messageSid, function(error, response, context) {

    
    });

createListSMS

Retrieve a list of Short Code messages.

function createListSMS(shortcode, to, dateSent, page, pageSize, callback)

Parameters

Example Usage

    var shortcode = 'Shortcode';
    var to = 'To';
    var dateSent = 'DateSent';
    var page = 16;
    var pageSize = 16;

    controller.createListSMS(shortcode, to, dateSent, page, pageSize, function(error, response, context) {

    
    });

createSendSMS

Send Dedicated Shortcode

function createSendSMS(shortcode, to, body, method, messagestatuscallback, callback)

Parameters

Example Usage

    var shortcode = 16;
    var to = 16.9939512629034;
    var body = 'body';
    var method = 'method';
    var messagestatuscallback = 'messagestatuscallback';

    controller.createSendSMS(shortcode, to, body, method, messagestatuscallback, function(error, response, context) {

    
    });

createListInboundSMS

Retrive a list of inbound Sms Short Code messages associated with your Ytel account.

function createListInboundSMS(page, pagesize, from, shortcode, datecreated, callback)

Parameters

Example Usage

    var page = 16;
    var pagesize = 16;
    var from = 'From';
    var shortcode = 'Shortcode';
    var datecreated = 'Datecreated';

    controller.createListInboundSMS(page, pagesize, from, shortcode, datecreated, function(error, response, context) {

    
    });

updateShortcode

Update a dedicated shortcode.

function updateShortcode(shortcode, friendlyName, callbackMethod, callbackUrl, fallbackMethod, fallbackUrl, callback)

Parameters

Example Usage

    var shortcode = 'Shortcode';
    var friendlyName = 'FriendlyName';
    var callbackMethod = 'CallbackMethod';
    var callbackUrl = 'CallbackUrl';
    var fallbackMethod = 'FallbackMethod';
    var fallbackUrl = 'FallbackUrl';

    controller.updateShortcode(shortcode, friendlyName, callbackMethod, callbackUrl, fallbackMethod, fallbackUrl, function(error, response, context) {

    
    });

Back to List of Controllers

AreaMailController

Get singleton instance

The singleton instance of the AreaMailController class can be accessed from the API Client.

var controller = lib.AreaMailController;

createDeleteAreaMail

Remove an AreaMail object by its AreaMailId.

function createDeleteAreaMail(areamailid, callback)

Parameters

Example Usage

    var areamailid = 'areamailid';

    controller.createDeleteAreaMail(areamailid, function(error, response, context) {

    
    });

createViewAreaMail

Retrieve an AreaMail object by its AreaMailId.

function createViewAreaMail(areamailid, callback)

Parameters

Example Usage

    var areamailid = 'areamailid';

    controller.createViewAreaMail(areamailid, function(error, response, context) {

    
    });

createListAreaMails

Retrieve a list of AreaMail objects.

function createListAreaMails(page, pagesize, areamailsid, dateCreated, callback)

Parameters

Example Usage

    var page = 16;
    var pagesize = 16;
    var areamailsid = 'areamailsid';
    var dateCreated = 'dateCreated';

    controller.createListAreaMails(page, pagesize, areamailsid, dateCreated, function(error, response, context) {

    
    });

createAreaMail

Create a new AreaMail object.

function createAreaMail(routes, attachbyid, front, back, description, targettype, htmldata, callback)

Parameters

Example Usage

    var routes = 'routes';
    var attachbyid = 'attachbyid';
    var front = 'front';
    var back = 'back';
    var description = 'description';
    var targettype = 'targettype';
    var htmldata = 'htmldata';

    controller.createAreaMail(routes, attachbyid, front, back, description, targettype, htmldata, function(error, response, context) {

    
    });

Back to List of Controllers

PostCardController

Get singleton instance

The singleton instance of the PostCardController class can be accessed from the API Client.

var controller = lib.PostCardController;

createDeletePostcard

Remove a postcard object.

function createDeletePostcard(postcardid, callback)

Parameters

Example Usage

    var postcardid = 'postcardid';

    controller.createDeletePostcard(postcardid, function(error, response, context) {

    
    });

createViewPostcard

Retrieve a postcard object by its PostcardId.

function createViewPostcard(postcardid, callback)

Parameters

Example Usage

    var postcardid = 'postcardid';

    controller.createViewPostcard(postcardid, function(error, response, context) {

    
    });

createPostcard

Create, print, and mail a postcard to an address. The postcard front must be supplied as a PDF, image, or an HTML string. The back can be a PDF, image, HTML string, or it can be automatically generated by supplying a custom message.

function createPostcard(to, from, attachbyid, front, back, message, setting, description, htmldata, callback)

Parameters

Example Usage

    var to = 'to';
    var from = 'from';
    var attachbyid = 'attachbyid';
    var front = 'front';
    var back = 'back';
    var message = 'message';
    var setting = 'setting';
    var description = 'description';
    var htmldata = 'htmldata';

    controller.createPostcard(to, from, attachbyid, front, back, message, setting, description, htmldata, function(error, response, context) {

    
    });

createListPostcards

Retrieve a list of postcard objects. The postcards objects are sorted by creation date, with the most recently created postcards appearing first.

function createListPostcards(page, pagesize, postcardid, dateCreated, callback)

Parameters

Example Usage

    var page = 16;
    var pagesize = 16;
    var postcardid = 'postcardid';
    var dateCreated = 'dateCreated';

    controller.createListPostcards(page, pagesize, postcardid, dateCreated, function(error, response, context) {

    
    });

Back to List of Controllers

LetterController

Get singleton instance

The singleton instance of the LetterController class can be accessed from the API Client.

var controller = lib.LetterController;

createDeleteLetter

Remove a letter object by its LetterId.

function createDeleteLetter(lettersid, callback)

Parameters

Example Usage

    var lettersid = 'lettersid';

    controller.createDeleteLetter(lettersid, function(error, response, context) {

    
    });

createViewLetter

Retrieve a letter object by its LetterSid.

function createViewLetter(lettersid, callback)

Parameters

Example Usage

    var lettersid = 'lettersid';

    controller.createViewLetter(lettersid, function(error, response, context) {

    
    });

createLetter

Create, print, and mail a letter to an address. The letter file must be supplied as a PDF or an HTML string.

function createLetter(to, from, attachbyid, file, color, description, extraservice, doublesided, template, htmldata, callback)

Parameters

Example Usage

    var to = 'to';
    var from = 'from';
    var attachbyid = 'attachbyid';
    var file = 'file';
    var color = 'color';
    var description = 'description';
    var extraservice = 'extraservice';
    var doublesided = 'doublesided';
    var template = 'template';
    var htmldata = 'htmldata';

    controller.createLetter(to, from, attachbyid, file, color, description, extraservice, doublesided, template, htmldata, function(error, response, context) {

    
    });

createListLetters

Retrieve a list of letter objects. The letter objects are sorted by creation date, with the most recently created letters appearing first.

function createListLetters(page, pagesize, lettersid, dateCreated, callback)

Parameters

Example Usage

    var page = 16;
    var pagesize = 16;
    var lettersid = 'lettersid';
    var dateCreated = 'dateCreated';

    controller.createListLetters(page, pagesize, lettersid, dateCreated, function(error, response, context) {

    
    });

Back to List of Controllers

CallController

Get singleton instance

The singleton instance of the CallController class can be accessed from the API Client.

var controller = lib.CallController;

createViewCall1

Retrieve a single voice call’s information by its CallSid.

function createViewCall1(callSid, callback)

Parameters

Example Usage

    var callSid = 'callSid';

    controller.createViewCall1(callSid, function(error, response, context) {

    
    });

createViewCall

Retrieve a single voice call’s information by its CallSid.

function createViewCall(callsid, callback)

Parameters

Example Usage

    var callsid = 'callsid';

    controller.createViewCall(callsid, function(error, response, context) {

    
    });

createPlayDTMF

Play Dtmf and send the Digit

function createPlayDTMF(callSid, playDtmf, playDtmfDirection, callback)

Parameters

Example Usage

    var callSid = 'CallSid';
    var playDtmf = 'PlayDtmf';
    var playDtmfDirection = Object.keys(PlayDtmfDirection)[0];

    controller.createPlayDTMF(callSid, playDtmf, playDtmfDirection, function(error, response, context) {

    
    });

createMakeCall

You can experiment with initiating a call through Ytel and view the request response generated when doing so and get the response in json

function createMakeCall(from, to, url, method, statusCallBackUrl, statusCallBackMethod, fallBackUrl, fallBackMethod, heartBeatUrl, heartBeatMethod, timeout, playDtmf, hideCallerId, record, recordCallBackUrl, recordCallBackMethod, transcribe, transcribeCallBackUrl, ifMachine, ifMachineUrl, ifMachineMethod, feedback, surveyId, callback)

Parameters

Example Usage

    var from = 'From';
    var to = 'To';
    var url = 'Url';
    var method = 'Method';
    var statusCallBackUrl = 'StatusCallBackUrl';
    var statusCallBackMethod = 'StatusCallBackMethod';
    var fallBackUrl = 'FallBackUrl';
    var fallBackMethod = 'FallBackMethod';
    var heartBeatUrl = 'HeartBeatUrl';
    var heartBeatMethod = 'HeartBeatMethod';
    var timeout = 16;
    var playDtmf = 'PlayDtmf';
    var hideCallerId = false;
    var record = false;
    var recordCallBackUrl = 'RecordCallBackUrl';
    var recordCallBackMethod = 'RecordCallBackMethod';
    var transcribe = false;
    var transcribeCallBackUrl = 'TranscribeCallBackUrl';
    var ifMachine = Object.keys(IfMachine)[0];
    var ifMachineUrl = 'IfMachineUrl';
    var ifMachineMethod = 'IfMachineMethod';
    var feedback = false;
    var surveyId = 'SurveyId';

    controller.createMakeCall(from, to, url, method, statusCallBackUrl, statusCallBackMethod, fallBackUrl, fallBackMethod, heartBeatUrl, heartBeatMethod, timeout, playDtmf, hideCallerId, record, recordCallBackUrl, recordCallBackMethod, transcribe, transcribeCallBackUrl, ifMachine, ifMachineUrl, ifMachineMethod, feedback, surveyId, function(error, response, context) {

    
    });

createPlayAudio

Play Audio from a url

function createPlayAudio(callSid, audioUrl, sayText, length, direction, mix, callback)

Parameters

Example Usage

    var callSid = 'CallSid';
    var audioUrl = 'AudioUrl';
    var sayText = 'SayText';
    var length = 16;
    var direction = Object.keys(Direction)[0];
    var mix = false;

    controller.createPlayAudio(callSid, audioUrl, sayText, length, direction, mix, function(error, response, context) {

    
    });

createRecordCall

Start or stop recording of an in-progress voice call.

function createRecordCall(callSid, record, direction, timeLimit, callBackUrl, fileformat, callback)

Parameters

Example Usage

    var callSid = 'CallSid';
    var record = false;
    var direction = Object.keys(Direction4)[0];
    var timeLimit = 16;
    var callBackUrl = 'CallBackUrl';
    var fileformat = Object.keys(Fileformat)[0];

    controller.createRecordCall(callSid, record, direction, timeLimit, callBackUrl, fileformat, function(error, response, context) {

    
    });

createVoiceEffect

Add audio voice effects to the an in-progress voice call.

function createVoiceEffect(callSid, audioDirection, pitchSemiTones, pitchOctaves, pitch, rate, tempo, callback)

Parameters

Example Usage

    var callSid = 'CallSid';
    var audioDirection = Object.keys(AudioDirection)[0];
    var pitchSemiTones = 16.9939512629034;
    var pitchOctaves = 16.9939512629034;
    var pitch = 16.9939512629034;
    var rate = 16.9939512629034;
    var tempo = 16.9939512629034;

    controller.createVoiceEffect(callSid, audioDirection, pitchSemiTones, pitchOctaves, pitch, rate, tempo, function(error, response, context) {

    
    });

createInterruptCall

Interrupt the Call by Call Sid

function createInterruptCall(callSid, url, method, status, callback)

Parameters

Example Usage

    var callSid = 'CallSid';
    var url = 'Url';
    var method = 'Method';
    var status = Object.keys(Status)[0];

    controller.createInterruptCall(callSid, url, method, status, function(error, response, context) {

    
    });

createListCalls

A list of calls associated with your Ytel account

function createListCalls(page, pageSize, to, from, dateCreated, callback)

Parameters

Example Usage

    var page = 16;
    var pageSize = 16;
    var to = 'To';
    var from = 'From';
    var dateCreated = 'DateCreated';

    controller.createListCalls(page, pageSize, to, from, dateCreated, function(error, response, context) {

    
    });

createSendRVM

Initiate an outbound Ringless Voicemail through Ytel.

function createSendRVM(from, rVMCallerId, to, voiceMailURL, method, statusCallBackUrl, statsCallBackMethod, callback)

Parameters

Example Usage

    var from = 'From';
    var rVMCallerId = 'RVMCallerId';
    var to = 'To';
    var voiceMailURL = 'VoiceMailURL';
    var method = 'Method';
    var statusCallBackUrl = 'StatusCallBackUrl';
    var statsCallBackMethod = 'StatsCallBackMethod';

    controller.createSendRVM(from, rVMCallerId, to, voiceMailURL, method, statusCallBackUrl, statsCallBackMethod, function(error, response, context) {

    
    });

createGroupCall

Group Call

function createGroupCall(from, to, url, groupConfirmKey, groupConfirmFile, method, statusCallBackUrl, statusCallBackMethod, fallBackUrl, fallBackMethod, heartBeatUrl, heartBeatMethod, timeout, playDtmf, hideCallerId, record, recordCallBackUrl, recordCallBackMethod, transcribe, transcribeCallBackUrl, callback)

Parameters

Example Usage

    var from = 'From';
    var to = 'To';
    var url = 'Url';
    var groupConfirmKey = 'GroupConfirmKey';
    var groupConfirmFile = Object.keys(GroupConfirmFile)[0];
    var method = 'Method';
    var statusCallBackUrl = 'StatusCallBackUrl';
    var statusCallBackMethod = 'StatusCallBackMethod';
    var fallBackUrl = 'FallBackUrl';
    var fallBackMethod = 'FallBackMethod';
    var heartBeatUrl = 'HeartBeatUrl';
    var heartBeatMethod = 'HeartBeatMethod';
    var timeout = 16;
    var playDtmf = 'PlayDtmf';
    var hideCallerId = 'HideCallerId';
    var record = false;
    var recordCallBackUrl = 'RecordCallBackUrl';
    var recordCallBackMethod = 'RecordCallBackMethod';
    var transcribe = false;
    var transcribeCallBackUrl = 'TranscribeCallBackUrl';

    controller.createGroupCall(from, to, url, groupConfirmKey, groupConfirmFile, method, statusCallBackUrl, statusCallBackMethod, fallBackUrl, fallBackMethod, heartBeatUrl, heartBeatMethod, timeout, playDtmf, hideCallerId, record, recordCallBackUrl, recordCallBackMethod, transcribe, transcribeCallBackUrl, function(error, response, context) {

    
    });

Back to List of Controllers

PhoneNumberController

Get singleton instance

The singleton instance of the PhoneNumberController class can be accessed from the API Client.

var controller = lib.PhoneNumberController;

createGetDIDScore

Get DID Score Number

function createGetDIDScore(phonenumber, callback)

Parameters

Example Usage

    var phonenumber = 'Phonenumber';

    controller.createGetDIDScore(phonenumber, function(error, response, context) {

    
    });

createMoveNumber

Transfer phone number that has been purchased for from one account to another account.

function createMoveNumber(phonenumber, fromaccountsid, toaccountsid, callback)

Parameters

Example Usage

    var phonenumber = 'phonenumber';
    var fromaccountsid = 'fromaccountsid';
    var toaccountsid = 'toaccountsid';

    controller.createMoveNumber(phonenumber, fromaccountsid, toaccountsid, function(error, response, context) {

    
    });

createPurchaseNumber

Purchase a phone number to be used with your Ytel account

function createPurchaseNumber(phoneNumber, callback)

Parameters

Example Usage

    var phoneNumber = 'PhoneNumber';

    controller.createPurchaseNumber(phoneNumber, function(error, response, context) {

    
    });

createReleaseNumber

Remove a purchased Ytel number from your account.

function createReleaseNumber(responseType, phoneNumber, callback)

Parameters

Example Usage

    var responseType = 'ResponseType';
    var phoneNumber = 'PhoneNumber';

    controller.createReleaseNumber(responseType, phoneNumber, function(error, response, context) {

    
    });

createViewDetails

Retrieve the details for a phone number by its number.

function createViewDetails(phoneNumber, callback)

Parameters

Example Usage

    var phoneNumber = 'PhoneNumber';

    controller.createViewDetails(phoneNumber, function(error, response, context) {

    
    });

createBulkRelease

Remove a purchased Ytel number from your account.

function createBulkRelease(phoneNumber, callback)

Parameters

Example Usage

    var phoneNumber = 'PhoneNumber';

    controller.createBulkRelease(phoneNumber, function(error, response, context) {

    
    });

createAvailableNumbers

Retrieve a list of available phone numbers that can be purchased and used for your Ytel account.

function createAvailableNumbers(numbertype, areacode, pagesize, callback)

Parameters

Example Usage

    var numbertype = Object.keys(numbertype)[0];
    var areacode = 'areacode';
    var pagesize = 58;

    controller.createAvailableNumbers(numbertype, areacode, pagesize, function(error, response, context) {

    
    });

updateNumber

Update properties for a Ytel number that has been purchased for your account. Refer to the parameters list for the list of properties that can be updated.

function updateNumber(phoneNumber, voiceUrl, friendlyName, voiceMethod, voiceFallbackUrl, voiceFallbackMethod, hangupCallback, hangupCallbackMethod, heartbeatUrl, heartbeatMethod, smsUrl, smsMethod, smsFallbackUrl, smsFallbackMethod, callback)

Parameters

Example Usage

    var phoneNumber = 'PhoneNumber';
    var voiceUrl = 'VoiceUrl';
    var friendlyName = 'FriendlyName';
    var voiceMethod = 'VoiceMethod';
    var voiceFallbackUrl = 'VoiceFallbackUrl';
    var voiceFallbackMethod = 'VoiceFallbackMethod';
    var hangupCallback = 'HangupCallback';
    var hangupCallbackMethod = 'HangupCallbackMethod';
    var heartbeatUrl = 'HeartbeatUrl';
    var heartbeatMethod = 'HeartbeatMethod';
    var smsUrl = 'SmsUrl';
    var smsMethod = 'SmsMethod';
    var smsFallbackUrl = 'SmsFallbackUrl';
    var smsFallbackMethod = 'SmsFallbackMethod';

    controller.updateNumber(phoneNumber, voiceUrl, friendlyName, voiceMethod, voiceFallbackUrl, voiceFallbackMethod, hangupCallback, hangupCallbackMethod, heartbeatUrl, heartbeatMethod, smsUrl, smsMethod, smsFallbackUrl, smsFallbackMethod, function(error, response, context) {

    
    });

createListNumbers

Retrieve a list of purchased phones numbers associated with your Ytel account.

function createListNumbers(page, pageSize, numberType, friendlyName, callback)

Parameters

Example Usage

    var page = 58;
    var pageSize = 58;
    var numberType = Object.keys(NumberType14)[0];
    var friendlyName = 'FriendlyName';

    controller.createListNumbers(page, pageSize, numberType, friendlyName, function(error, response, context) {

    
    });

createBulkUpdateNumbers

Update properties for a Ytel numbers that has been purchased for your account. Refer to the parameters list for the list of properties that can be updated.

function createBulkUpdateNumbers(phoneNumber, voiceUrl, friendlyName, voiceMethod, voiceFallbackUrl, voiceFallbackMethod, hangupCallback, hangupCallbackMethod, heartbeatUrl, heartbeatMethod, smsUrl, smsMethod, smsFallbackUrl, smsFallbackMethod, callback)

Parameters

Example Usage

    var phoneNumber = 'PhoneNumber';
    var voiceUrl = 'VoiceUrl';
    var friendlyName = 'FriendlyName';
    var voiceMethod = 'VoiceMethod';
    var voiceFallbackUrl = 'VoiceFallbackUrl';
    var voiceFallbackMethod = 'VoiceFallbackMethod';
    var hangupCallback = 'HangupCallback';
    var hangupCallbackMethod = 'HangupCallbackMethod';
    var heartbeatUrl = 'HeartbeatUrl';
    var heartbeatMethod = 'HeartbeatMethod';
    var smsUrl = 'SmsUrl';
    var smsMethod = 'SmsMethod';
    var smsFallbackUrl = 'SmsFallbackUrl';
    var smsFallbackMethod = 'SmsFallbackMethod';

    controller.createBulkUpdateNumbers(phoneNumber, voiceUrl, friendlyName, voiceMethod, voiceFallbackUrl, voiceFallbackMethod, hangupCallback, hangupCallbackMethod, heartbeatUrl, heartbeatMethod, smsUrl, smsMethod, smsFallbackUrl, smsFallbackMethod, function(error, response, context) {

    
    });

createBulkBuyNumbers

Purchase a selected number of DID's from specific area codes to be used with your Ytel account.

function createBulkBuyNumbers(numberType, areaCode, quantity, leftover, callback)

Parameters

Example Usage

    var numberType = Object.keys(NumberType15)[0];
    var areaCode = 'AreaCode';
    var quantity = 'Quantity';
    var leftover = 'Leftover';

    controller.createBulkBuyNumbers(numberType, areaCode, quantity, leftover, function(error, response, context) {

    
    });

Back to List of Controllers

SMSController

Get singleton instance

The singleton instance of the SMSController class can be accessed from the API Client.

var controller = lib.SMSController;

createViewSMS1

Retrieve a single SMS message object with details by its SmsSid.

function createViewSMS1(messageSid, callback)

Parameters

Example Usage

    var messageSid = 'MessageSid';

    controller.createViewSMS1(messageSid, function(error, response, context) {

    
    });

createViewSMS

Retrieve a single SMS message object by its SmsSid.

function createViewSMS(messageSid, callback)

Parameters

Example Usage

    var messageSid = 'MessageSid';

    controller.createViewSMS(messageSid, function(error, response, context) {

    
    });

createSendSMS

Send an SMS from a Ytel number

function createSendSMS(from, to, body, method, messageStatusCallback, smartsms, deliveryStatus, callback)

Parameters

Example Usage

    var from = 'From';
    var to = 'To';
    var body = 'Body';
    var method = 'Method';
    var messageStatusCallback = 'MessageStatusCallback';
    var smartsms = false;
    var deliveryStatus = false;

    controller.createSendSMS(from, to, body, method, messageStatusCallback, smartsms, deliveryStatus, function(error, response, context) {

    
    });

(https://apidocs.io/img/method.png ".SMSController.createListSMS"