API docs by Redocly

Hybrid Enabler Service - API Overview

Download OpenAPI specification:Download

API Overview

This API overview provides a summary of tools for managing, integrating, and provisioning the Hybrid Enabler Service. Below are the APIs that are specific for hybrid deployments. The cloud provided APIs for each service and provisioning are described under respective service section.

  1. Local APIs and callbacks for SIP Mediaserver Service

    The Mediaservice APIs enable robust call handling and advanced media management for sessions processed within the site. Callbacks provide real-time notifications for session events, allowing applications to respond dynamically.

    • Main Endpoints

      • POST /mediaservice/{domain}/hangupparticipant

        Ends a participant\'s session within a call.

      • POST /mediaservice/{domain}/interruptivrcommand

        Stops an active IVR command.

      • POST /mediaservice/{domain}/placeivrcall

        Places an outbound IVR call.

      • POST /mediaservice/{domain}/splitconnection

        Splits an active connection between participants.

      • POST /mediaservice/{domain}/startrecording

        Initiates recording for a call session.

      • POST /mediaservice/{domain}/stoprecording

        Stops an ongoing recording.

      • POST /mediaservice/{domain}/promptfile

        Accesses prompts replicated between sites via S3.

    • Main Callbacks

      • POST /callNotify

        Sends notifications about call events.

      • POST /callAnswered

        Triggered when a call is answered.

      • POST /newCall

        Notifies about a new call session.

      • POST /callEvent

        Reports specific events within a call.

      • POST /sessionCompleted

        Indicates the completion of a session.

      • POST /getCallIdentifier

        Provides the identifier for a call.

      • POST /getIvrCommand

        Sends the next IVR command.

      • POST /recordingReady

        Triggered when a recording is ready for access.

  2. Local APIs and Callbacks for Recording Service

    The call recording APIs manage recording operations locally, ensuring compliance and data privacy. Callbacks provide updates on recording events, enabling secure and efficient workflows.

    • Main Endpoints

      • POST /siprec/{domain}/stoprecording

        Stops an ongoing call recording.

      • POST /siprec/{domain}/cancelrecording

        Cancels a scheduled recording.

      • POST /siprec/{domain}/storerecording

        Manually stores a recording.

      • POST /siprec/{domain}/deleterecording

        Deletes a recording from storage.

    • Main Callbacks

      • POST /newCall

        Notifies about the initiation of a new call.

      • POST /recordingstarted

        Triggered when a recording begins.

      • POST /recordingcancelled

        Indicates a recording was canceled.

      • POST /recordingready

        Triggered when a recording is finalized and ready for retrieval.

      • POST /recordingstored

        Confirms that a recording has been stored.

      • POST /recordingdeleted

        Notifies that a recording has been deleted.

  3. Host Management APIs

    The Hybrid Enabler Service includes APIs for managing compute hosts, allowing administrators to scale resources up or down as needed. These APIs ensure flexibility and efficiency in site management.

    • Main Endpoints

      • POST /site/{siteid}/hosts/drain

        Prepares a host for decommissioning by safely draining active sessions.

      • POST /site/{siteid}/hosts/commission

        Commissions a new host to expand site capacity.

      • POST /site/{siteid}/hosts/decommission

        Removes a drained host from the site.

      • GET /site/{siteid}/hosts

        Retrieves a list of all hosts registered to the site.

These APIs and callbacks provide a comprehensive toolkit for managing media services, call recording, and site infrastructure while maintaining high availability, security, and data privacy.