The unique identifier of the Call Block rule.

callBlockId

The unique identifier of the conference room.

conferenceRoomId

deviceId

The unique identifier of the E911 record.

e911Id

The unique identifier of the extension record.

extensionId

The unique identifier of the fax machine configuration.

faxMachineId

forwardId

Comma-separated list of related resources to include.

include

The unique identifier of the location record.

locationId

menuId

packageId

page

per_page

The unique identifier of the phone number record.

phoneNumberId

planId

query

ringGroupId

scheduleId

seatId

sipTrunkId

siteId

sort_by

sort_order

templateId

userId

Bad Request - The request was malformed or contained invalid data.

Not Found - The requested conference room could not be found.

Conflict - The request conflicts with the current state of the resource.

Not Found - The requested device could not be found.

Not Found - The requested E911 record could not be found.

Not Found - The requested fax machine could not be found.

Forbidden - The authenticated user does not have the necessary permissions to perform this action.

Not Found - The requested location could not be found.

Not Found - The requested menu could not be found.

Not Found - The requested resource could not be found.

Not Found - The requested phone number could not be found.

Not Found - The requested ring group could not be found.

Not Found - The requested schedule could not be found.

Not Found - The requested SIP trunk could not be found.

Not Found - The specified site could not be found.

Unauthorized - Authentication token is missing, invalid, or does not have permissions for this resource.

Not Found - The requested voicemail box could not be found.

Forbidden - The authenticated user does not have permission.

Unauthorized - Authentication token is missing or invalid.

Conflict - e.g., the extension number already exists on this site.

Not Found - The requested address could not be found.

Bad Request - Invalid data provided for the extension operation.

Not Found - The requested item could not be found.

Not Found - The requested package could not be found.

Not Found - The requested resource (e.g., specific plan) could not be found.

Conflict - The resource already exists or the request conflicts with the current state.

Not Found - The account could not be found (should be rare for /account path).

Not Found - The requested site could not be found.

Not Found - The requested resource (e.g., specific statement) could not be found.

Bad Request - Invalid data provided (e.g., new_site_id is invalid or same as current).

Not Found - The requested resource (e.g., extension, site) could not be found.

Not Found - The requested resource (e.g., schedule, site) could not be found.

Bad Request - Invalid data provided for the user operation.

Conflict - e.g., a user with the provided email already exists.

Forbidden - The authenticated user does not have permission for this user operation.

Not Found - The requested user could not be found.

Detailed information about a customer account.

Innovatech Solutions Ltd.

Desired minimum balance to maintain, in dollars.

Timestamp of when the account was created.

Primary contact email for the account (often billing or admin).

Flag indicating if international calling/services are enabled.

Maximum permissible auto-recharge amount in a single transaction, in dollars.

The official name of the account/company.

Primary contact phone number for the account.

Identifier or name of the current subscription plan.

Amount to automatically recharge when balance falls below preference, in dollars.

Specifies the fields that can be updated for an account.

Innovatech Solutions - EMEA Branch

A contact phone number associated with this address, preferably in E.164 format.

Two-letter ISO 3166-1 alpha-2 country code (e.g., US, GB, CA).

Contact email address associated with this address record.

State, province, or region, as applicable for the country.

Full street address, including building number, street name, and suite/apartment if applicable.

Unique identifier for the address record.

Registered address information, including its unique ID.

Detailed information about an address record, including its unique ID.

All fields required to update an existing address. For PUT, typically all fields are provided.

Address information provided by the user during sign-up.

Primary contact phone number, preferably in E.164 format.

Primary contact email address for the account.

State or province name or code, as applicable for the country.

Street name and number, including suite or apartment if applicable.

Whether the forward is currently assigned (e.g., to the user specified in query).

ID of the user this forward is assigned to in this context, if any.

After Hours

Lunch Break

Array of Forwards considered available or assigned in this context.

Whether the phone number is currently assigned (e.g. to the specified user or any user on the site).

ID of the user this phone number is assigned to, if any.

A list of available or contextually relevant phone numbers.

Inventory DID 1

Sales Team

Sales Voicemail

Main Office

A list of specific extension identifiers (e.g., device codes, extension numbers) to which this block applies. Used if `block_all_extensions` is false.

If true, calls from the number are blocked to all extensions on the site. If false, `applicable_extensions` must be specified.

Optional notes or reason for this call block rule.

The phone number (or pattern) to block. E.164 format recommended for specific numbers.

Block Robocalls

Unique identifier for the call block rule.

HATEOAS links related to this call block rule.

Identifier of the site this call block rule belongs to.

Detailed information about a call block rule.

Data for updating an existing Call Block rule. Only provided fields are updated.

Priority Block - Updated

Describes an error encountered during a call record request.

A human-readable message describing the validation error or issue.

Summary details of a specific call event.

Name associated with the DNI (e.g., location or service).

Duration of the answered part of the call in seconds.

Unique identifier for this call summary record.

A descriptive name for the call type or leg.

Automatic Number Identification (ANI) of the caller.

Dialing zone or rate category for the call.

Intrastate Call

Total number of records matching the query.

Total number of pages based on page_size.

Numeric PIN required for the moderator to join and control the conference.

A user-friendly name for the conference room.

Numeric PIN required for participants to join the conference.

Conference profile or type (e.g., default, enhanced audio). Specific values depend on system configuration.

Identifier of the user primarily associated with this conference room, if any.

Audio file for the greeting message played when participants join.

Audio file for music played while participants are on hold waiting for the moderator.

Data required to create a new conference room, including optional audio file uploads.

Daily Huddle Room

Weekly Sales Meeting

Unique identifier for the conference room.

HATEOAS links related to this conference room.

URL to the current music on hold audio file.

Identifier of the site this conference room belongs to.

Detailed information about a conference room.

New audio file for the greeting message. If not provided, existing greeting remains.

New audio file for music on hold. If not provided, existing music remains.

Data for updating an existing conference room, including optional audio file uploads.

Team Sync Room - Updated

Contains the token needed to confirm a user account.

The unique token sent to the user after registration, used to verify and activate their account.

Response message indicating the result of the account confirmation attempt.

Proceed to Login

HATEOAS links for next actions, like logging in.

A success message indicating the account has been confirmed.

United Kingdom - 44

United States - 1

Canada - 1

Indicates if the card is active for payments.

The brand of the credit card (e.g., Visa, Mastercard, American Express).

The expiration month of the credit card (1-12).

The expiration year of the credit card (e.g., 2025).

Indicates if the card is currently expired based on its expiration date.

Unique identifier for the credit card record.

The last four digits of the credit card number.

A custom name or label for the credit card (e.g., "Work Visa", "Personal Amex").

Priority for payment processing (higher numbers typically processed first). Range 0-100.

Indicates if the card has been successfully verified.

Information required to add and tokenize a new credit card.

Personal Amex

Set whether this card should be active for payments upon creation.

Cardholder's billing address - street line 1.

Cardholder's billing address - street line 2 (e.g., apartment, suite).

The full credit card number (PAN). This will be tokenized and not stored directly by Ringer.

Cardholder's billing address - two-letter ISO 3166-1 alpha-2 country code.

The 3 or 4-digit card verification value (CVV/CVC).

Expiration year (e.g., 2026). Future year expected.

Cardholder's billing address - postal or ZIP code.

Payment priority (0-100). Higher values are typically tried first.

Cardholder's billing address - state or province code.

HATEOAS links related to this credit card.

Detailed information about a stored credit card (excluding sensitive full PAN).

Primary Visa

Information required to register a new customer account.

Global Solutions Ltd.

The legal name of the company or business.

Details of the newly created customer account, including a confirmation token.

Confirm Account

Example Innovations Inc.

Indicates if the account is active. Typically false until confirmed.

Preferred account balance threshold (in dollars).

A unique token required to confirm and activate the account.

Unique identifier for the newly created account.

Indicates if international services are enabled for this account.

HATEOAS links related to the new account.

View Account Details

Preferred auto-recharge amount (in dollars).

Core properties of a device, used for creation and as part of responses.

Main Conference Phone

Access Control List (IP/CIDR) for device registration.

Ringer Business API Documentation