New Research: Supply Chain Attack on Axios Pulls Malicious Dependency from npm.Details → →
Socket
Book a DemoSign in
Socket
Book a DemoSign in

entrancesms

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

entrancesms

Comprehensive Node.js SDK for Entrance API v2 Cloud - Complete access to all 224+ API endpoints including SMS marketing, campaigns, contacts, workspaces, and more

latest
npmnpm
Version
1.0.3
Version published
Maintainers
1
Created
Source

Entrance API v2 Cloud - Node.js SDK

Complete Node.js SDK for the Entrance API v2 Cloud platform. This module provides comprehensive access to all API endpoints including authentication, accounts, workspaces, campaigns, SMS marketing, contacts, channels, users, and more.

Features

  • ✅ Complete API Coverage: All 224+ endpoints documented and accessible
  • ✅ Type-safe Method Calls: Intuitive method names matching API functionality
  • ✅ Comprehensive Documentation: JSDoc comments for every endpoint
  • ✅ Built-in HTTP Client: Uses Node.js built-in modules (no external dependencies)
  • ✅ Error Handling: Proper error handling with status codes and response data
  • ✅ SMS Marketing: Full support for SMS campaigns and marketing features
  • ✅ Workspace Management: Complete workspace, user, and permission management

Installation

npm install entrancesms

Quick Start

const EntranceAPI = require('entrancesms');

// Initialize the client
const client = new EntranceAPI({
  baseUrl: 'https://apiv2.entrancegrp.com',
  // You can set accessToken here or use setAccessToken() after login
});

// Example: Login and get access token
async function authenticate() {
  try {
    const result = await client.login({
      email: 'user@example.com',
      password: 'your-password'
    });
    
    // Set the access token for subsequent requests
    client.setAccessToken(result.record.access_token);
    
    console.log('Logged in successfully!');
    console.log('Workspace ID:', result.record.workspace_id);
    console.log('User ID:', result.record.user_id);
    
    return result;
  } catch (error) {
    console.error('Login failed:', error.message);
    throw error;
  }
}

// Example: Create a campaign
async function createCampaign() {
  try {
    const campaign = await client.createCampaign({
      workspaceId: 'your-workspace-id',
      body: {
        name: 'My SMS Campaign',
        message: 'Hello from Entrance API!',
        // ... other campaign fields
      }
    });
    
    console.log('Campaign created:', campaign);
    return campaign;
  } catch (error) {
    console.error('Failed to create campaign:', error.message);
    throw error;
  }
}

API Categories

The SDK is organized into the following categories:

  • ** **: 1 endpoints
  • 10DLC: 2 endpoints
  • 10DLC Registrations: 2 endpoints
  • Accounts: 3 endpoints
  • Analytics: 1 endpoints
  • Authentication: 4 endpoints
  • Billing: 2 endpoints
  • Campaign Templates: 3 endpoints
  • Campaign Text Filters: 3 endpoints
  • Campaigns (SMS Marketing): 13 endpoints
  • Contacts: 1 endpoints
  • Docs: 1 endpoints
  • Flags: 4 endpoints
  • Http:: 5 endpoints
  • Https:: 1 endpoints
  • Incoming Message Keywords: 2 endpoints
  • Influencers: 6 endpoints
  • Live Chat: 2 endpoints
  • Message Filters: 4 endpoints
  • Message Templates: 3 endpoints
  • Message-status: 2 endpoints
  • Mms.entrancegrp.com: 1 endpoints
  • Number Order Requests: 2 endpoints
  • Number Pools: 2 endpoints
  • Receive SMS: 1 endpoints
  • Root: 18 endpoints
  • Send-messages: 1 endpoints
  • Shortlists: 3 endpoints
  • Subscriber Lists: 4 endpoints
  • Syft: 24 endpoints
  • User API Keys: 3 endpoints
  • User Groups: 7 endpoints
  • Users: 7 endpoints
  • Webhooks: 5 endpoints
  • Workspace Numbers: 7 endpoints
  • Workspace-analytics: 1 endpoints
  • Workspace-billing: 2 endpoints
  • Workspace-blocked-numbers: 3 endpoints
  • Workspaces: 67 endpoints
  • }: 1 endpoints

Complete API Documentation

Total Endpoints: 224

MethodEndpointFunctionDescription
PUT/workspaces/:workspaceId/contacts/:contactId/metaeditMeta()Edit Meta

10DLC

MethodEndpointFunctionDescription
GET/ten-dlclist10DLCRegistrations()Get All 10DLC Registrations
GET/ten-dlc/:idget10DLCRegistration()Get 10DLC Registration

10DLC Registrations

MethodEndpointFunctionDescription
POST/10dlccreate10DLCRegistration()Create 10DLC Registration
PUT/10dlc/:idupdate10DLCRegistration()Update 10DLC Registration

Accounts

MethodEndpointFunctionDescription
POST/accountscreateAccount()Create Account
GET/accountsgetAccount()Get Account
PATCH/accounts/updateAccount()Update Account

Analytics

MethodEndpointFunctionDescription
GET/analytics/daily-statsgetDailyStatsForDashboard()Get Daily Stats For Dashboard

Authentication

MethodEndpointFunctionDescription
POST/authentication/loginlogin()Login
GET/authentication/logoutlogout()Logout
POST/authentication/refresh-tokenrefreshToken()Refresh Token
POST/authentication/syft/retrieve-userretrieveUser()Retrieve User

Billing

MethodEndpointFunctionDescription
GET/billing/usagegetUsage()Get Usage
GET/billing/segment-profilegetSegmentProfile()Get Segment Profile

Campaign Templates

MethodEndpointFunctionDescription
POST/campaign-templatescreateCampaignTemplate()Create Campaign Template
PUT/campaign-templates/:idupdateCampaignTemplate()Update Campaign Template
DELETE/campaign-templates/:iddeleteCampaignTemplate()Delete Campaign Template

Campaign Text Filters

MethodEndpointFunctionDescription
GET/campaign-text-filtersgetCampaignTextFilters()Get Campaign Text Filters
POST/campaign-text-filterscreateCampaignTextFilter()Create Campaign Text Filter
DELETE/campaign-text-filters/:iddeleteCampaignTextFilter()Delete Campaign Text Filter

Campaigns (SMS Marketing)

MethodEndpointFunctionDescription
GET/campaigns/:id/permissionsgetCampaignPermissions()Get Campaign Permissions
POST/campaigns/:id/permissions/usersaddUser()Add User
DELETE/campaigns/:id/permissions/users?user_id=564removeUser()Remove User
POST/campaigns/:id/permissions/groupsaddUserGroup()Add User Group
DELETE/campaigns/:id/permissions/groups?user_group_id=2removeUserGroup()Remove User Group
DELETE/campaigns/:id/permissionsclearPermissions()Clear Permissions
PATCH/campaigns/:idupdateCampaign()Update Campaign
POST/campaigns/:id/attach-mediaattachMedia()Attach Media
DELETE/campaigns/:id/attach-mediaremoveMedia()Remove Media
POST/campaigns/:id/attach-mediaattachMediaCopy()Attach Media Copy
POST/campaigns/:campaignId/contacts/deletedeleteUploadedContacts()Delete Uploaded Contacts
GET/campaigns/:id/responses?lastid=0&order=ASC&limit=20&stop=falsegetResponses()Get Responses
GET/campaigns/:campaignId/clicksgetCampaignClicks()Get Campaign Clicks

Contacts

MethodEndpointFunctionDescription
POST/contactscreateContact()Create Contact

Docs

MethodEndpointFunctionDescription
GET/docs/eventsgetEventDocs()Get Event Docs

Flags

MethodEndpointFunctionDescription
POST/flagscreateFlag()Create Flag
PUT/flags/1updateFlag()(DEPRECATED) Update Flag
PATCH/flags/:flagIdupdateFlag()Update Flag
DELETE/flags/2removeFlag()Remove Flag

Http:

MethodEndpointFunctionDescription
POSThttp://127.0.0.1:6003?wid=1testReceiveSMSLocal()Test Receive SMS Local
POSThttp://127.0.0.1:6001/message-status/campaign?workspace_id=3&campaign_id=481&manual_user_id=3testMessageStatusLocal()Test Message Status Local
POSThttp://127.0.0.1:6005/channels/:id/create-shortlinktestCreateShortLink()Test CreateShortLink
GEThttp://127.0.0.1:6000/api/documentationgetDocument()Get Document
GEThttp://127.0.0.1:6022/syft-voice?last_id=1&limit=100&testRetrieveUser()Test Retrieve User

Https:

MethodEndpointFunctionDescription
POSThttps://apiv2.entrancegrp.com/user-api-keyscreateUserApiKey()Create User Api Key

Incoming Message Keywords

MethodEndpointFunctionDescription
GET/incoming-message-keywordsgetKeywords()Get Keywords
POST/incoming-message-keywordsaddKeyword()Add Keyword

Influencers

MethodEndpointFunctionDescription
POST/influencerscreateInfluencerList()Create Influencer List
GET/influencers/:idgetInfluencerListById()Get Influencer List by Id
PUT/influencers/:idupdateInfluencerList()Update Influencer List
PUT/influencers/:id/phone-numberaddUpdateInfluencerListNumber()Add/Update Influencer List Number
PUT/influencers/:id/add-keywordsupdateKeywords()Update Keywords
DELETE/influencers/:idarchiveInfluencerList()Archive Influencer List

Live Chat

MethodEndpointFunctionDescription
POST/live-chatcreateLiveChat()Create Live Chat
POST/live-chat/:id/messagecreateLiveChatMessage()Create Live Chat Message

Message Filters

MethodEndpointFunctionDescription
POST/message-filtersaddFilter()Add Filter
POST/message-filterscreateFilter()Create Filter
PATCH/message-filters/:messageFilterIdupdateFilter()Update Filter
DELETE/message-filters/:messageFilterIddeleteFilter()Delete Filter

Message Templates

MethodEndpointFunctionDescription
POST/message-templatescreateMessageTemplate()Create Message Template
PATCH/message-templates/:idupdateMessageTemplate()Update Message Template
DELETE/message-templates/:iddeleteMessageTemplate()Delete Message Template

Message-status

MethodEndpointFunctionDescription
POST/message-status/campaign?workspace_id=3&campaign_id=481&manual_user_id=3testMessageStatusBeta()Test Message Status Beta
POST/message-status/campaign?workspace_id=3&campaign_id=481&manual_user_id=3testMessageStatusLive()Test Message Status Live

Mms.entrancegrp.com

MethodEndpointFunctionDescription
GET/media?source=https://mms.entrancegrp.com/beta_1-270786-2059-iyU-1729091738210.pnggetProtectedMedia()Get Protected Media

Number Order Requests

MethodEndpointFunctionDescription
GET/number-order-requests/:idgetNumberOrderRequest()Get Number Order Request
POST/number-order-requestscreateNumberOrderRequest()Create Number Order Request

Number Pools

MethodEndpointFunctionDescription
GET/number-pools/:idgetById()Get By Id
POST/number-poolscreate()Create

Receive SMS

MethodEndpointFunctionDescription
POST/receive-sms/receivetestReceiveSMSBeta()Test Receive SMS Beta

Root

MethodEndpointFunctionDescription
GET/flags?lastid=9999999999&order=DESClistWorkspaceFlags()Get All Workspace Flags
GET/workspace-blocked-numbers?lastid=0&limit=20&order=ASCgetNumbers()Get Numbers
GET/message-filters?unsubscribe=truegetFilter()Get Filter
GET/channels?claimed=falsetrackClick()Track Click
GET/message-templates?limit=1getMessageTemplates()Get Message Templates
DELETE/incoming-message-keywords?keyword=testdeleteKeyword()Delete Keyword
GET/campaign-templates?last_id=9999999999999&limit=20&order=DESCgetCampaignTemplates()Get Campaign Templates
GET/users?last_id=9999999999999&limit=20&order=DESClistWorkspaceUsers()Get All Workspace Users
GET/user-groups?lastid=9999999999&limit=20&order=DESCgetUserGroups()Get User Groups
GET/subscriber-lists?last_id=9999999999999&limit=20&order=DESC&is_influencer_list=truegetSubscriberLists()Get Subscriber Lists
GET/user-api-keys?last_id=9999999999999&limit=20&order=DESCgetUserApiKeysInWorkspace()Get User Api Keys in Workspace
GET/workspace-numbers?last_id=99999999999&order=DESC&limit=10listWorkspaceNumbers()Get All Workspace Numbers
GET/workspace-numbers?count=truegetCountOfWorkspaceNumbers()Get Count of Workspace Numbers
GET/number-order-requests?last_id=99999999&order=DESC&limit=10listNumberOrderRequests()Get All Number Order Requests
GET/influencers?last_id=9999999999999&limit=20&order=DESCgetInfluencerLists()Get Influencer Lists
GET/message-filters?unsubscribe=truelist()Get All
GET/workspace-logs?lastid=0&limit=999&order=ASCgetLogs()Get Logs
POST``testPost()Test Post

Send-messages

MethodEndpointFunctionDescription
POST/send-messages/:channelId/sendtestsendMessage()Test Send Message

Shortlists

MethodEndpointFunctionDescription
GET/shortlistsgetShortlistContacts()Get Shortlist Contacts
POST/shortlistsaddShortlistContact()Add Shortlist Contact
DELETE/shortlists/:shortlistIdremoveShortlistContact()Remove Shortlist Contact

Subscriber Lists

MethodEndpointFunctionDescription
GET/subscriber-lists/:subscriberListIdgetSubscriberListById()Get Subscriber List by Id
POST/subscriber-listscreateSubscriberList()Create Subscriber List
PUT/subscriber-lists/:subscriberListIdupdateSubscriberList()Update Subscriber List
DELETE/subscriber-lists/:subscriberListIddeleteSubscriberList()Delete Subscriber List

Syft

MethodEndpointFunctionDescription
POST/syft/registrationregistration()Registration
GET/syft/campaigns/:id/whitelistgetWhitelist()Get Whitelist
POST/syft/campaigns/:id/whitelistaddAssignedToUser()Add Assigned To User
DELETE/syft/campaigns/:id/whitelist/:assignedToremoveAssignedToUser()Remove Assigned To user
GET/syft/campaigns?last_id=9999999999999&limit=20&order=DESCgetCampaigns()Get Campaigns
GET/syft/campaigns/:idgetCampaignById()Get Campaign by Id
POST/syft/campaignsaddCampaign()Add Campaign
PUT/syft/campaigns/:idupdateCampaign()Update Campaign
DELETE/syft/campaigns/:iddeleteCampaign()Delete Campaign
GET/syft/custom-prompts?last_id=9999999999999&limit=20&order=DESCgetCustomPrompts()Get Custom Prompts
GET/syft/custom-prompts/:idgetCustomPromptById()Get Custom Prompt By Id
POST/syft/custom-promptscreateCustomPrompt()Create Custom Prompt
PUT/syft/custom-prompts/:idupdateCustomPrompt()Update Custom Prompt
GET/syft/custom-prompts/:iddeleteCustomPrompt()Delete Custom Prompt
GET/syft/gpt-settingsgetWorkspaceGPTSettings()Get Workspace GPT Settings
POST/syft/gpt-settingsupdateWorkspaceGPTSettings()Update Workspace GPT Settings
GET/syft/gpt-settings/resetresetWorkspaceGPTSettings()Reset Workspace GPT Settings
GET/syft/representatives?last_id=9999999999999&limit=20&order=DESCgetRepresentatives()Get Representatives
GET/syft/representatives/:idgetRepById()Get Rep By Id
POST/syft/representativesaddRepresentative()Add Representative
PUT/syft/representatives/:idupdateRepresentative()Update Representative
DELETE/syft/representatives/:iddeleteRepresentative()Delete Representative
PUT/syft/users/:idupdate()Update
GET/syft/usersgetWorkspaceUsers()Get Workspace Users

User API Keys

MethodEndpointFunctionDescription
GET/user-api-keys/4065getUserApiKey()Get User Api Key
POST/user-api-keys/:id/refreshupdateUserApiKey()Update User Api Key
DELETE/user-api-keys/:iddeleteUserApiKey()Delete User Api Key

User Groups

MethodEndpointFunctionDescription
GET/user-groups/:userGroupId/usersgetUsersInGroup()Get Users in Group
POST/user-groups/:userGroupId/usersaddUserToUserGroup()Add User To User Group
DELETE/user-groups/:userGroupId/users/:userIdremoveUserFromUserGroup()Remove User From User Group
POST/user-groupscreateUserGroup()Create User Group
GET/user-groups/:userGroupIdgetUserGroup()Get User Group
PATCH/user-groups/:idupdateUserGroup()Update User Group
DELETE/user-groups/:iddeleteUserGroup()Delete User Group

Users

MethodEndpointFunctionDescription
GET/users/:idgetUser()Get User
POST/usersaddWorkspaceUser()Add Workspace User
PATCH/users/1updateUser()Update User
PATCH/users/:idupdateUserPassword()Update User Password
DELETE/users/:id?reassign=5deleteWorkspaceUser()Delete Workspace User
POST/users/push-tokenaddPushToken()Add Push Token
GET/users/:id/workspace-assignsgetWorkspaceAssigns()Get Workspace Assigns

Webhooks

MethodEndpointFunctionDescription
GET/webhooks/eventsgetEvents()Get Events
GET/webhooks/eventsgetCategories()Get Categories
GET/webhookslistWebhooks()Get All Webhooks
POST/webhookscreateWebhook()Create Webhook
GET/webhooks/testtestGet()Test Get

Workspace Numbers

MethodEndpointFunctionDescription
GET/workspace-numbers/available?state=MI&page=0&pageSize=1availableToRent()Available To Rent
POST/workspace-numbers/orderorderNumbers()Order Numbers
GET/workspace-numbers/stats?last_id=99999999999&order=DESC&limit=10&stats=monthgetNumberStats()Get Number Stats
GET/workspace-numbers/:idgetWorkspaceNumber()Get Workspace Number
POST/workspace-numbers/activateactivateWorkspaceNumbers()Activate Workspace Numbers
POST/workspace-numbers/deactivatedeactivateWorkspaceNumbers()Deactivate Workspace Numbers
DELETE/workspace-numbers/deletedeleteNumbers()Delete Numbers

Workspace-analytics

MethodEndpointFunctionDescription
GET/workspace-analytics/:id/manual-blast-data?period=month&start_date=2021-10-10&end_date=2024-10-10getManualBlastData()Get Manual Blast Data

Workspace-billing

MethodEndpointFunctionDescription
GET/workspace-billing//reportsgetBillingReports()Get Billing Reports
GET/workspace-billing//reports/:reportId/downloaddownloadBillingReport()Download Billing Report

Workspace-blocked-numbers

MethodEndpointFunctionDescription
POST/workspace-blocked-numbersaddNumber()Add Number
GET/workspace-blocked-numbers/:idgetNumberById()Get Number by Id
DELETE/workspace-blocked-numbers/3deleteNumber()Delete Number

Workspaces

MethodEndpointFunctionDescription
GET/workspaces/:id/flags/4getFlagById()Get Flag By Id
PATCH/workspaces/:id/message-filters/:idupdateFilter()Update Filter
DELETE/workspaces/:id/message-filters/:iddeleteFilter()Delete Filter
GET/workspaces/:workspaceId/campaigns/:id/pausepauseCampaign()Pause Campaign
GET/workspaces/:workspaceId/campaigns/:id/resumeresumeCampaign()Resume Campaign
GET/workspaces/:workspaceId/campaigns/:id/cancelcancelCampaign()Cancel Campaign
GET/workspaces/:workspaceId/campaigns/:id/upload-progressgetUploadProgress()getUploadProgress
GET/workspaces/:workspaceId/campaigns/:id/send-progressgetSendProgress()getSendProgress
GET/workspaces/:id/campaigns/:campaignId/contact-listsgetContactLists()Get Contact Lists
POST/workspaces/:id/campaigns/:campaignId/contact-listsaddContactList()Add Contact List
DELETE/workspaces/:id/campaigns/:campaignId/contact-lists/:campaignContactListIdremoveContactListByRecordId()Remove Contact List by Record Id
GET/workspaces/:workspaceId/campaigns?order=DESC&limit=100&types=SINGLE_BLASTlist()Get All
GET/workspaces/:workspaceId/campaigns/:idgetCampaign()Get Campaign
POST/workspaces/:workspaceId/campaignscreateCampaign()Create Campaign
GET/workspaces/:id/campaigns/:campaignId/campaign-contactsgetCampaignContacts()Get Campaign Contacts
GET/workspaces/:id/campaigns/:campaignId/contacts?lastid=0&limit=20&order=ASCgetContacts()Get Contacts
POST/workspaces/:workspaceId/campaigns/:campaignId/contactsaddContacts()Add Contacts
GET/workspaces/:workspaceId/campaigns/:campaignId/sendsend()Send
POST/workspaces/:workspaceId/campaigns/:id/testsendtestMessage()Send Test Message
GET/workspaces/:workspaceId/campaigns/:campaignId/analytics-summarycampaignAnalyticsSummary()Campaign Analytics Summary
POST/workspaces/:workspaceId/campaigns/:campaignId/schedulescheduleCampaign()Schedule Campaign
GET/workspaces/:workspaceId/channels?claimed=truegetChannels()Get Channels
GET/workspaces/:workspaceId/channels/:idgetChannel()Get Channel
PATCH/workspaces/:workspaceId/channels/:idupdateChannel()Update Channel
POST/workspaces/:workspaceId/channels/:id/create-shortlinkcreateChannelShortlink()Create Channel Shortlink
GET/workspaces/:workspaceId/channels/:id/meta?email=truegetChannelMeta()Get Channel Meta
GET/workspaces/:workspaceId/channels/:id/syft-messagessyftMessages()Syft Messages
DELETE/workspaces/:workspaceId/channels/:id/deleteChannels()Delete Channels
GET/workspaces/:workspaceId/channels/:id/unclaimunclaim()Unclaim
POST/workspaces/:workspaceId/channels/:id/assignassign()Assign
POST/workspaces/:workspaceId/channels/bulk-assign-flagbulkFlagAssign()Bulk Flag Assign
PUT/workspaces/:workspaceId/contacts/:contactId/metaaddMeta()Add Meta
PUT/workspaces/:workspaceId/channels/:id/metaremoveMeta()Remove Meta
GET/workspaces/:workspaceId/contacts?limit=300&order=ASCgetContacts()Get Contacts
GET/workspaces/:workspaceId/contacts/:contactIdgetContact()Get Contact
PATCH/workspaces/:workspaceId/contacts/:idupdateContact()Update Contact
GET/workspaces//contact-lists?limit=100&order=ASClistContactLists()Get All Contact Lists
GET/workspaces/:workspaceId/contact-lists/:id?lastid=2&limit=100&order=ASCgetContactListById()Get Contact List By Id
POST/workspaces/:workspaceId/contact-listscreateContactList()Create Contact List
PATCH/workspaces/:workspaceId/contact-lists/:idupdateContactListById()Update Contact List By Id
GET/workspaces/:workspaceId/contact-lists/:id/contacts?lastid=0&limit=100&order=ASCgetContactsInList()Get Contacts in List
POST/workspaces//contact-lists/:contactListId/importsimportByFile()Import By File
POST/workspaces/:workspaceId/contact-lists/:contactListId/importsimportByJsonBody()Import By Json Body
PATCH/workspaces/:workspaceId/contact-lists/imports/:idupdateImport()Update Import
GET/workspaces/:workspaceId/contact-lists/:id/imports?lastid=0&order=ASC&limit=100getContactListImports()Get Contact List Imports
GET/workspaces/:workspaceId/contact-lists/imports/:importId/contacts?lastId=0&order=ASC&limit=100getContactsByImport()Get Contacts By Import
GET/workspaces/:workspaceId/messages?channelid=&limit=100&ts=2025-03-17T19:11:02.461Z&order=ASCget()Get
POST/workspaces/:workspaceId/messagessendMessage()Send Message
POST/workspaces/:workspaceId/messagessendMessageMMS()Send Message MMS
GET/workspaces/:id/assignedgetWorkspaceUsers()Get Workspace Users
POST/workspaces/:workspaceId/assignassignUserToWorkspace()Assign User To Workspace
PATCH/workspaces/:workspaceId/assigned/:userIdupdateUserAssignPermission()Update User Assign Permission
DELETE/workspaces/:workspaceId/assigned/:userIddeleteUserAssignment()Delete User Assignment
GET/workspaces/:workspaceId/webhooks/:webhookIdgetWebhook()Get Webhook
DELETE/workspaces/:workspaceId/webhooks/:webhookIddeleteWebhook()Delete Webhook
POST/workspaces/:workspaceId/webhooks/:webhookId/subscribesubscribeToEvents()Subscribe To Events
POST/workspaces/:workspaceId/webhooks/:webhookId/unsubscribeunsubscribeFromEvents()Unsubscribe From Events
GET/workspacesgetWorkspaces()Get Workspaces
GET/workspaces/:workspaceId/permissiongetWorkspacePermission()Get Workspace Permission
POST/workspacescreateWorkspace()Create Workspace
GET/workspaces/:workspaceIdgetWorkspace()Get Workspace
PUT/workspaces/:workspaceIdupdateWorkspace()Update Workspace
DELETE/workspaces/:workspaceIdarchiveWorkspace()Archive Workspace
GET/workspaces//settingslistSettings()Get All Settings
GET/workspaces//settings?setting=disable_claimsgetSpecificSetting()Get Specific Setting
PUT/workspaces//settingsupdateSetting()Update Setting
GET/workspaces//daily-analyticsdailyAnalytics()Daily Analytics

}

MethodEndpointFunctionDescription
GET}/workspaces/:workspaceId/contacts?lastid=0&limit=100&order=ASCgetStops()Get Stops

Usage Examples

Authentication

// Login
const loginResult = await client.login({
  email: 'user@example.com',
  password: 'password'
});

client.setAccessToken(loginResult.record.access_token);

// Refresh token
const refreshResult = await client.refreshToken({
  client_id: 'your-client-id',
  refresh_token: 'your-refresh-token'
});

// Logout
await client.logout();

SMS Marketing & Campaigns

// Get all campaigns
const campaigns = await client.listCampaigns({
  workspaceId: 'workspace-id',
  query: { last_id: 0, limit: 20, order: 'DESC' }
});

// Get a specific campaign
const campaign = await client.getCampaign({
  workspaceId: 'workspace-id',
  id: 'campaign-id'
});

// Create a campaign
const newCampaign = await client.createCampaign({
  workspaceId: 'workspace-id',
  body: {
    name: 'My SMS Campaign',
    message: 'Hello from Entrance!'
    // ... other fields
  }
});

// Send campaign
await client.sendCampaign({
  workspaceId: 'workspace-id',
  id: 'campaign-id'
});

// Get campaign responses
const responses = await client.getResponses({
  id: 'campaign-id'
}, {
  lastid: 0,
  limit: 20,
  order: 'ASC'
});

Contacts & Contact Lists

// Get contacts
const contacts = await client.getContacts({
  workspaceId: 'workspace-id'
}, {
  last_id: 0,
  limit: 100
});

// Create contact
const contact = await client.createContact({
  workspaceId: 'workspace-id'
}, {
  phone_number: '+1234567890',
  first_name: 'John',
  last_name: 'Doe'
});

// Get contact lists
const lists = await client.getAllContactLists({
  workspaceId: 'workspace-id'
});

// Create contact list
const list = await client.createContactList({
  workspaceId: 'workspace-id'
}, {
  name: 'My Contact List'
});

Workspaces & Users

// Get workspaces
const workspaces = await client.getWorkspaces();

// Get workspace
const workspace = await client.getWorkspace({
  id: 'workspace-id'
});

// Get workspace users
const users = await client.listWorkspaceUsers({
  workspaceId: 'workspace-id'
}, {
  last_id: 0,
  limit: 20
});

// Add workspace user
const newUser = await client.addWorkspaceUser({
  workspaceId: 'workspace-id'
}, {
  email: 'user@example.com',
  firstname: 'John',
  lastname: 'Doe'
});

Error Handling

All methods return Promises and can throw errors. Errors include:

  • status: HTTP status code
  • response: Error response body
  • message: Error message
try {
  const result = await client.getCampaign({ id: 'invalid-id' });
} catch (error) {
  console.error('Status:', error.status);
  console.error('Response:', error.response);
  console.error('Message:', error.message);
}

License

MIT

Support

For API documentation and support, visit the Entrance API documentation.

Keywords

entrance
api
sdk
sms
marketing
campaigns

FAQs

Package last updated on 05 Nov 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

Attackers Are Hunting High-Impact Node.js Maintainers in a Coordinated Social Engineering Campaign

Security News

Attackers Are Hunting High-Impact Node.js Maintainers in a Coordinated Social Engineering Campaign

Multiple high-impact npm maintainers confirm they have been targeted in the same social engineering campaign that compromised Axios.

By Sarah Gooding  -  Apr 03, 2026