Skip to main content

What You Can Do with the SMS Platform APIs

The HORISEN SMS Platform APIs let you manage every commercial and operational aspect of your SMS business programmatically — from real-time billing, invoicing, and credit control, to Business Partner onboarding, bulk traffic reporting, Supplier Gate management, and campaign traffic protection.

Finance & Billing Automation​

  • Retrieve payables and receivables.
  • Access invoices, invoice files, and line items.
  • Automate clearing and reconciliation of paid invoices.
  • Integrate billing systems with live balances and traffic/usage data.

Real-Time Balance & Credit Control​

  • Fetch Customer and Supplier balances instantly.
  • Retrieve credit records and credit record types.
  • Enforce prepaid and postpaid billing logic programmatically.

Business Partners Management​

  • Create and manage Customers, Suppliers, and routing partners.
  • Manage companies, contacts, addresses, and partner relationships.
  • Automate onboarding from CRMs or external systems.
  • Keep account configuration synced across platforms.

Campaign Detector & Traffic Protection​

  • Detect and classify SMS campaign traffic versus person-to-person traffic.
  • Track which customer accounts and supplier gates a campaign is detected on.
  • Tag, classify, and prioritize campaign traffic.
  • Protect operator and customer networks from harmful traffic.

Traffic Reporting & Gate Management​

  • Retrieve postpaid and overall traffic reports for Customers and Suppliers.
  • Export Supplier Gate configuration and data files in bulk.
  • Schedule CDR file exports and deliver them in real time via Webhook.

SMS Platform API Modules​

The API suite is divided into several focused modules, each representing a specific part of the HORISEN SMS ecosystem:

API GroupDescription
Business Partner APIManage Business Partner companies, contacts, addresses, and partner relationships.
Billing APIRetrieve Customer and Supplier balances, credit records, and credit record types.
SIT APIManage invoices, balance sheets, clearing records, and payment types.
Invoice Docs APIList and download generated Customer and Supplier invoice files.
Bulk Traffic Report APIPostpaid and overall SMS traffic reports for Customers and Suppliers.
Bulk Gates APIExport Supplier Gate configuration and data files.
Campaign Detector APIDetect SMS campaign traffic and let you tag, group, and monitor it across accounts and gates.
SMS Session Manager APIView and manage real-time Customer and Supplier connections.
CDR ManagerSchedule CDR file exports and configure Webhook delivery.

Each module follows consistent REST conventions, shared OAuth2 authentication, and standardized response formats.

Authentication & Security​

All SMS Platform APIs use OAuth2 Bearer Tokens, obtained via the client credentials grant type.

Example header:

Authorization: Bearer <ACCESS_TOKEN>

Your API credentials (client_id and client_secret) must be kept secure and must never be exposed on the client side. For a full walkthrough of obtaining and using an access token, see the OAuth2 Authentication Guidelines page.

Error Handling​

Most SMS Platform APIs wrap errors in a common shape: a machine-readable code, a human-readable message, and — for validation failures — an items array with the specific field that failed.

Example:

{
  "error": {
    "code": "INVALID-DATA",
    "message": "Request validation failed",
    "items": [
      {
        "name": "totalBalanceId",
        "message": "not allowed",
        "description": "totalBalanceId must reference an existing balance"
      }
    ]
  }
}

Typical Integrations​

Billing Automation​

Connect your billing engine to the Billing API and SIT API to automate invoices, credit control, and month-end reconciliation.

CRM Integration​

Provision partners via the Business Partner API and sync account data automatically.

Traffic Quality Protection​

Run Campaign Detector API checks before accepting large SMS batches to filter spam and protect your brand.

Customer Portals​

Expose balances (Billing API), invoices and invoice files (SIT API, Invoice Docs API), and traffic reports (Bulk Traffic Report API) through custom dashboards.

Use Cases​

Use the SMS Platform APIs to:

  • Integrate your own Billing System

    • Use data from CDRs received via Webhooks or SFTP, to handle the entire billing process on your side.

  • Integrate your ERP/Invoicing System, to create your own invoices

  • Build your own Customer Portal, or integrate the existing one

    • Use the Business Partner API to create/update Business Partners. You can use the API for onboarding process on your own system, or use its methods to update details of an existing Business Partner, inside the Platform.

    • Integrate the Billing API with your existing payment gateway (such as Stripe or Paypal), to manage prepaid and postpaid lifecycle, including credit records for top-ups and part payments.

    • Show Invoices using the SIT API, and let customers download invoice files using the Invoice Docs API.

    • Use the Bulk Traffic Report API to display traffic reports directly in your own interface. Design your own layout and present traffic data retrieved from our system in a way that best fits your product and users.

    • Automatically clear paid invoices for postpaid accounts using the Clearing endpoints of the SIT API.

  • Monitor and Manage Customer/Supplier Connections

  • Manage Supplier Gate Configuration in Bulk

    • Use the Bulk Gates API to export Supplier Gate configuration and data files for reporting or integration purposes.

  • Use Campaign Detector Data and/or CDR Records with your own BI to create reports

  • Integrate External Monitoring Tools