Access, scope by scope

The VoIP.ms API is powerful — and broad. Rather than hand your assistant the keys to your whole account, this server splits that surface into per-resource scopes. You approve exactly what an app may touch, and nothing more.

How scopes work

One resource at a time

Every part of VoIP.ms — phone numbers, messaging, voicemail, billing — is its own scope. Granting one says nothing about the others.

Read-only by default

Most resources offer a read-only :read scope alongside the full one. Let your assistant look without letting it change anything.

Write implies read

Granting a full scope (e.g. dids) includes its read access (dids:read) — so you never have to grant both, and write access always carries the read it needs.

When an app connects, the approval screen shows exactly these scopes — checked, unchecked, and adjustable — before anything is granted. You can deselect write access and keep just the reads.

The full catalog

Every resource you can grant access to, with its write and read-only scopes.

Phone numbers (DIDs)

  • didsWrite

    Manage phone numbers

    View and manage the phone numbers (DIDs) on your voip.ms account, order new ones, and search availability.

  • dids:readRead

    View phone numbers

    View the phone numbers (DIDs) on your voip.ms account and browse availability.

Sub-accounts

  • subaccountWrite

    Manage sub-accounts

    Create, update, and delete Session Initiation Protocol (SIP) sub-accounts, SIP URIs, and account locations.

  • subaccount:readRead

    View sub-accounts

    View Session Initiation Protocol (SIP) sub-accounts, registration status, SIP URIs, and locations.

Number porting (LNP)

  • portingWrite

    Manage number porting

    Submit and manage Local Number Portability (LNP) ports and attachments.

  • porting:readRead

    View number porting

    View Local Number Portability (LNP) ports, status, and notes.

E911 emergency service

  • e911Write

    Manage Enhanced 911 (E911)

    Provision, validate, update, and cancel Enhanced 911 (E911) emergency service on your phone numbers (DIDs).

  • e911:readRead

    View Enhanced 911 (E911)

    View Enhanced 911 (E911) emergency-service information for your phone numbers (DIDs).

Messaging (SMS)

  • smsWrite

    Send and read SMS messages

    Send SMS messages, read your SMS message history, and manage SMS settings.

  • sms:readRead

    Read SMS messages

    Read your SMS message history.

Messaging (MMS)

  • mmsWrite

    Send and read MMS

    Send MMS messages, read your MMS history, and delete messages.

  • mms:readRead

    Read MMS

    Read your MMS message history.

Fax

  • faxWrite

    Manage fax

    Manage fax numbers, folders, messages, and email-to-fax settings.

  • fax:readRead

    View fax

    View fax numbers, folders, and messages.

Voicemail

  • voicemailWrite

    Manage voicemail

    Create, update, and delete voicemail boxes and manage voicemail messages.

  • voicemail:readRead

    View voicemail

    View voicemail boxes and messages.

Call flow & routing

  • callflowWrite

    Manage call flow

    Manage callbacks, ring groups, call hunting, parking, time conditions, Direct Inward System Access (DISA), recordings, caller-ID filtering, and music on hold.

  • callflow:readRead

    View call flow

    View callbacks, ring groups, call hunting, time conditions, recordings, and related call-flow settings.

Call forwarding

  • forwardingWrite

    Manage forwardings

    Create, update, and delete call-forwarding entries.

  • forwarding:readRead

    View forwardings

    View call-forwarding entries.

IVR menus

  • ivrWrite

    Manage Interactive Voice Response (IVR) menus

    Create, update, and delete Interactive Voice Response (IVR) menus.

  • ivr:readRead

    View Interactive Voice Response (IVR) menus

    View Interactive Voice Response (IVR) menus.

Call queues

  • queueWrite

    Manage call queues

    Create, update, and delete call queues.

  • queue:readRead

    View call queues

    View call queues and estimated hold times.

Conferences

  • conferenceWrite

    Manage conferences

    Create, update, and delete conference bridges and their members and recordings.

  • conference:readRead

    View conferences

    View conference bridges, members, and recordings.

Account & billing

  • accountWrite

    Manage account & billing

    View account balance, charges, and transactions, and post charges or payments.

  • account:readRead

    View account & billing

    View account balance, charges, deposits, and transaction history.

Call records (CDR)

  • cdrRead

    View call records

    View Call Detail Records (CDR) for your account and reseller clients.

Reseller clients

  • resellerWrite

    Manage reseller clients

    Create, update, and delete reseller client accounts, packages, and thresholds.

  • reseller:readRead

    View reseller clients

    View reseller client accounts, packages, balances, and usage.

Phonebook

  • phonebookWrite

    Manage phonebook

    Create, update, and delete phonebook entries and groups.

  • phonebook:readRead

    View phonebook

    View phonebook entries and groups.

Reference data

  • referenceRead

    View reference data

    View static reference catalogs (countries, states, rate centers, locales, codecs, and similar lookups). No private account data.