ytelapi v3.1.3

Getting started

Ytel API version 3.1.2

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 YtelAPILib 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 APIController 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

• UsageController
• SubAccountController
• AccountController
• EmailController
• RecordingController
• TranscriptionController
• ConferenceController
• PhoneNumberController
• CarrierController
• DedicatedShortCodeController
• SharedShortCodeController
• SMSController
• VoiceController

UsageController

Get singleton instance

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

var controller = lib.UsageController;

createListUsage

Retrieve usage metrics regarding your Ytel account. The results includes inbound/outbound voice calls and inbound/outbound SMS messages as well as carrier lookup requests.

function createListUsage(productCode, startDate, endDate, includeSubAccounts, callback)

Parameters

Example Usage

    var productCode = Object.keys(ProductCode)[0];
    var startDate = 'startDate';
    var endDate = 'endDate';
    var includeSubAccounts = 'IncludeSubAccounts';

    controller.createListUsage(productCode, startDate, endDate, includeSubAccounts, function(error, response, context) {

    
    });

Back to List of Controllers

SubAccountController

Get singleton instance

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

var controller = lib.SubAccountController;

createSubaccount

Create a sub user account under the parent account

function createSubaccount(firstName, lastName, email, friendlyName, password, callback)

Parameters

Example Usage

    var firstName = 'FirstName';
    var lastName = 'LastName';
    var email = 'Email';
    var friendlyName = 'FriendlyName';
    var password = 'Password';

    controller.createSubaccount(firstName, lastName, email, friendlyName, password, function(error, response, context) {

    
    });

createDeleteSubaccount

Delete sub account or merge numbers into parent

function createDeleteSubaccount(subAccountSID, mergeNumber, callback)

Parameters

Example Usage

    var subAccountSID = 'SubAccountSID';
    var mergeNumber = Object.keys(MergeNumber)[0];

    controller.createDeleteSubaccount(subAccountSID, mergeNumber, function(error, response, context) {

    
    });

createToggleSubaccountStatus

Suspend or unsuspend

function createToggleSubaccountStatus(subAccountSID, activate, callback)

Parameters

Example Usage

    var subAccountSID = 'SubAccountSID';
    var activate = Object.keys(Activate)[0];

    controller.createToggleSubaccountStatus(subAccountSID, activate, function(error, response, context) {

    
    });

Back to List of Controllers

AccountController

Get singleton instance

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

var controller = lib.AccountController;

createViewAccount

Retrieve information regarding your Ytel account by a specific date. The response object will contain data such as account status, balance, and account usage totals.

function createViewAccount(date, callback)

Parameters

Example Usage

    var date = 'Date';

    controller.createViewAccount(date, function(error, response, context) {

    
    });

Back to List of Controllers

EmailController

Get singleton instance

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

var controller = lib.EmailController;

createBlockedEmails

Retrieve a list of emails that have been blocked.

function createBlockedEmails(offset, limit, callback)

Parameters

Example Usage

    var offset = 'Offset';
    var limit = 'Limit';

    controller.createBlockedEmails(offset, limit, function(error, response, context) {

    
    });

createRemoveInvalidEmail

Remove an email from the invalid email list.

function createRemoveInvalidEmail(email, callback)

Parameters

Example Usage

    var email = 'Email';

    controller.createRemoveInvalidEmail(email, function(error, response, context) {

    
    });

createInvalidEmails

Retrieve a list of invalid email addresses.

function createInvalidEmails(offset, limit, callback)

Parameters

Example Usage

    var offset = 'Offset';
    var limit = 'Limit';

    controller.createInvalidEmails(offset, limit, function(error, response, context) {

    
    });

createRemoveBouncedEmail

Remove an email address from the bounced list.

function createRemoveBouncedEmail(email, callback)

Parameters

Example Usage

    var email = 'Email';

    controller.createRemoveBouncedEmail(email, function(error, response, context) {

    
    });

createBouncedEmails

Retrieve a list of emails that have bounced.

function createBouncedEmails(offset, limit, callback)

Parameters

Example Usage

    var offset = 'Offset';
    var limit = 'Limit';

    controller.createBouncedEmails(offset, limit, function(error, response, context) {

    
    });

createSpamEmails

Retrieve a list of emails that are on the spam list.

function createSpamEmails(offset, limit, callback)

Parameters

Example Usage

    var offset = 'Offset';
    var limit = 'Limit';

    controller.createSpamEmails(offset, limit, function(error, response, context) {

    
    });

createSendEmail

Create and submit an email message to one or more email addresses.

function createSendEmail(to, type, subject, message, from, cc, bcc, attachment, callback)

Parameters

Example Usage

    var to = 'To';
    var type = Object.keys(Type)[0];
    var subject = 'Subject';
    var message = 'Message';
    var from = 'From';
    var cc = 'Cc';
    var bcc = 'Bcc';
    var attachment = 'Attachment';

    controller.createSendEmail(to, type, subject, message, from, cc, bcc, attachment, function(error, response, context) {

    
    });

createRemoveBlockedAddress

Remove an email from blocked emails list.

function createRemoveBlockedAddress(email, callback)

Parameters

Example Usage

    var email = 'Email';

    controller.createRemoveBlockedAddress(email, function(error, response, context) {

    
    });

addEmailUnsubscribe

Add an email to the unsubscribe list

function addEmailUnsubscribe(email, callback)

Parameters

Example Usage

    var email = 'email';

    controller.addEmailUnsubscribe(email, function(error, response, context) {

    
    });

createRemoveUnsubscribedEmail

Remove an email address from the list of unsubscribed emails.

function createRemoveUnsubscribedEmail(email, callback)

Parameters

Example Usage

    var email = 'email';

    controller.createRemoveUnsubscribedEmail(email, function(error, response, context) {

    
    });

createListUnsubscribedEmails

Retrieve a list of email addresses from the unsubscribe list.

function createListUnsubscribedEmails(offset, limit, callback)

Parameters

Example Usage

    var offset = 'Offset';
    var limit = 'Limit';

    controller.createListUnsubscribedEmails(offset, limit, function(error, response, context) {

    
    });

createRemoveSpamAddress

Remove an email from the spam email list.

function createRemoveSpamAddress(email, callback)

Parameters

Example Usage

    var email = 'Email';

    controller.createRemoveSpamAddress(email, function(error, response, context) {

    
    });

Back to List of Controllers

RecordingController

Get singleton instance

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

var controller = lib.RecordingController;

createDeleteRecording

Remove a recording from your Ytel account.

function createDeleteRecording(recordingsid, callback)

Parameters

Example Usage

    var recordingsid = 'recordingsid';

    controller.createDeleteRecording(recordingsid, function(error, response, context) {

    
    });

createListRecordings

Retrieve a list of recording objects.

function createListRecordings(page, pagesize, datecreated, callsid, callback)

Parameters

Example Usage

    var page = 39;
    var pagesize = 39;
    var datecreated = 'Datecreated';
    var callsid = 'callsid';

    controller.createListRecordings(page, pagesize, datecreated, callsid, function(error, response, context) {

    
    });

createViewRecording

Retrieve the recording of a call by its RecordingSid. This resource will return information regarding the call such as start time, end time, duration, and so forth.

function createViewRecording(recordingsid, callback)

Parameters

Example Usage

    var recordingsid = 'recordingsid';

    controller.createViewRecording(recordingsid, function(error, response, context) {

    
    });

Back to List of Controllers

TranscriptionController

Get singleton instance

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

var controller = lib.TranscriptionController;

createTranscribeAudioURL

Transcribe an audio recording from a file.

function createTranscribeAudioURL(audiourl, callback)

Parameters

Example Usage

    var audiourl = 'audiourl';

    controller.createTranscribeAudioURL(audiourl, function(error, response, context) {

    
    });

createListTranscriptions

Retrieve a list of transcription objects for your Ytel account.

function createListTranscriptions(page, pagesize, status, dateTranscribed, callback)

Parameters

Example Usage

    var page = 39;
    var pagesize = 39;
    var status = Object.keys(Status)[0];
    var dateTranscribed = 'dateTranscribed';

    controller.createListTranscriptions(page, pagesize, status, dateTranscribed, function(error, response, context) {

    
    });

createViewTranscription

Retrieve information about a transaction by its TranscriptionSid.

function createViewTranscription(transcriptionsid, callback)

Parameters

Example Usage

    var transcriptionsid = 'transcriptionsid';

    controller.createViewTranscription(transcriptionsid, function(error, response, context) {

    
    });

createTranscribeRecording

Transcribe a recording by its RecordingSid.

function createTranscribeRecording(recordingSid, callback)

Parameters

Example Usage

    var recordingSid = 'recordingSid';

    controller.createTranscribeRecording(recordingSid, function(error, response, context) {

    
    });

Back to List of Controllers

ConferenceController

Get singleton instance

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

var controller = lib.ConferenceController;

createListConferences

Retrieve a list of conference objects.

function createListConferences(page, pagesize, friendlyName, dateCreated, callback)

Parameters

Example Usage

    var page = 39;
    var pagesize = 39;
    var friendlyName = 'FriendlyName';
    var dateCreated = 'DateCreated';

    controller.createListConferences(page, pagesize, friendlyName, dateCreated, function(error, response, context) {

    
    });

createHangupParticipant

Remove a participant from a conference.

function createHangupParticipant(participantSid, conferenceSid, callback)

Parameters

Example Usage

    var participantSid = 'ParticipantSid';
    var conferenceSid = 'ConferenceSid';

    controller.createHangupParticipant(participantSid, conferenceSid, function(error, response, context) {

    
    });

createPlayAudio

Play an audio file during a conference.

function createPlayAudio(conferenceSid, participantSid, audioUrl, callback)

Parameters

Example Usage

    var conferenceSid = 'ConferenceSid';
    var participantSid = 'ParticipantSid';
    var audioUrl = Object.keys(AudioUrl)[0];

    controller.createPlayAudio(conferenceSid, participantSid, audioUrl, function(error, response, context) {

    
    });

createListParticipants

Retrieve a list of participants for an in-progress conference.

function createListParticipants(conferenceSid, page, pagesize, muted, deaf, callback)

Parameters

Example Usage

    var conferenceSid = 'ConferenceSid';
    var page = 39;
    var pagesize = 39;
    var muted = false;
    var deaf = false;

    controller.createListParticipants(conferenceSid, page, pagesize, muted, deaf, function(error, response, context) {

    
    });

createConference

Here you can experiment with initiating a conference call through Ytel and view the request response generated when doing so.

function createConference(url, from, to, method, statusCallBackUrl, statusCallBackMethod, fallbackUrl, fallbackMethod, record, recordCallBackUrl, recordCallBackMethod, scheduleTime, timeout, callback)

Parameters

Example Usage

    var url = 'Url';
    var from = 'From';
    var to = 'To';
    var method = 'Method';
    var statusCallBackUrl = 'StatusCallBackUrl';
    var statusCallBackMethod = 'StatusCallBackMethod';
    var fallbackUrl = 'FallbackUrl';
    var fallbackMethod = 'FallbackMethod';
    var record = false;
    var recordCallBackUrl = 'RecordCallBackUrl';
    var recordCallBackMethod = 'RecordCallBackMethod';
    var scheduleTime = 'ScheduleTime';
    var timeout = 39;

    controller.createConference(url, from, to, method, statusCallBackUrl, statusCallBackMethod, fallbackUrl, fallbackMethod, record, recordCallBackUrl, recordCallBackMethod, scheduleTime, timeout, function(error, response, context) {

    
    });

createViewParticipant

Retrieve information about a participant by its ParticipantSid.

function createViewParticipant(conferenceSid, participantSid, callback)

Parameters

Example Usage

    var conferenceSid = 'ConferenceSid';
    var participantSid = 'ParticipantSid';

    controller.createViewParticipant(conferenceSid, participantSid, function(error, response, context) {

    
    });

createViewConference

Retrieve information about a conference by its ConferenceSid.

function createViewConference(conferenceSid, callback)

Parameters

Example Usage

    var conferenceSid = 'ConferenceSid';

    controller.createViewConference(conferenceSid, function(error, response, context) {

    
    });

addParticipant

Add Participant in conference

function addParticipant(conferenceSid, participantNumber, muted, deaf, callback)

Parameters

Example Usage

    var conferenceSid = 'ConferenceSid';
    var participantNumber = 'ParticipantNumber';
    var muted = false;
    var deaf = false;

    controller.addParticipant(conferenceSid, participantNumber, muted, deaf, function(error, response, context) {

    
    });

createSilenceParticipant

Deaf Mute Participant

function createSilenceParticipant(conferenceSid, participantSid, muted, deaf, callback)

Parameters

Example Usage

    var conferenceSid = 'conferenceSid';
    var participantSid = 'ParticipantSid';
    var muted = false;
    var deaf = false;

    controller.createSilenceParticipant(conferenceSid, participantSid, muted, deaf, 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;

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(NumberType2)[0];
    var areaCode = 'AreaCode';
    var quantity = 'Quantity';
    var leftover = 'Leftover';

    controller.createBulkBuyNumbers(numberType, areaCode, quantity, leftover, 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) {

    
    });

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) {

    
    });

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 = 39;
    var pageSize = 39;
    var numberType = Object.keys(NumberType)[0];
    var friendlyName = 'FriendlyName';

    controller.createListNumbers(page, pageSize, numberType, friendlyName, 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) {

    
    });

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) {

    
    });

createReleaseNumber

Remove a purchased Ytel number from your account.

function createReleaseNumber(phoneNumber, callback)

Parameters

Example Usage

    var phoneNumber = 'PhoneNumber';

    controller.createReleaseNumber(phoneNumber, 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) {

    
    });

createGetDIDScore

Get DID Score Number

function createGetDIDScore(phonenumber, callback)

Parameters

Example Usage

    var phonenumber = 'Phonenumber';

    controller.createGetDIDScore(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(Numbertype1)[0];
    var areacode = 'areacode';
    var pagesize = 39;

    controller.createAvailableNumbers(numbertype, areacode, pagesize, 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) {

    
    });

Back to List of Controllers

CarrierController

Get singleton instance

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

var controller = lib.CarrierController;

createLookupCarrier

Get the Carrier Lookup

function createLookupCarrier(phoneNumber, callback)

Parameters

Example Usage

    var phoneNumber = 'PhoneNumber';

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

    
    });

createCarrierResults

Retrieve a list of carrier lookup objects.

function createCarrierResults(page, pageSize, callback)

Parameters

Example Usage

    var page = 39;
    var pageSize = 39;

    controller.createCarrierResults(page, pageSize, function(error, response, context) {

    
    });

Back to List of Controllers

DedicatedShortCodeController

Get singleton instance

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

var controller = lib.DedicatedShortCodeController;

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) {

    
    });

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) {

    
    });

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 = 39;
    var pagesize = 39;
    var from = 'From';
    var shortcode = 'Shortcode';
    var datecreated = 'Datecreated';

    controller.createListInboundSMS(page, pagesize, from, shortcode, datecreated, 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) {

    
    });

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 = 39;
    var pageSize = 39;

    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 = 39;
    var to = 39.350779552176;
    var body = 'body';
    var method = 'method';
    var messagestatuscallback = 'messagestatuscallback';

    controller.createSendSMS(shortcode, to, body, method, messagestatuscallback, 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) {

    
    });

Back to List of Controllers

SharedShortCodeController

Get singleton instance

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

var controller = lib.SharedShortCodeController;

createListShortcodes

Retrieve a list of shortcode assignment associated with your Ytel account.

function createListShortcodes(shortcode, page, pagesize, callback)

Parameters

Example Usage

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

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

    
    });

updateShortcode

Update Assignment

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

Parameters

Example Usage

    var shortcode = 'Shortcode';
    var friendlyName = 'FriendlyName';
    var callbackUrl = 'CallbackUrl';
    var callbackMethod = 'CallbackMethod';
    var fallbackUrl = 'FallbackUrl';
    var fallbackUrlMethod = 'F