SIP Mediaserver Service - API Overview

This API overview provides a detailed summary of tools for provisioning, managing, and integrating the SIP Mediaserver Service, enabling robust call handling, advanced session control, and real-time event-based application responses.

The Service Provisioning API is essential for setting up and configuring the SIP Mediaserver Service instance for your domain. This API allows you to define the SIP address, configure callback URLs, and set up authentication, providing the groundwork for media and call handling. Setting up the SIP Mediaserver Service through this API enables it to handle calls, manage sessions, and trigger the necessary callbacks to integrate seamlessly with your applications.

• Main Endpoint

  • POST /mediaservice/{domain}

    Initializes the SIP Mediaserver Service instance for a tenant. This setup includes configuring the SIP address, REST callback URL, and authentication credentials to ensure secure and integrated service operation within your domain.

These APIs are used to manage and control active sessions, handle media commands, and enable advanced call flow configurations. They support disconnecting participants, playing IVR commands, managing call connections, and recording media.

• Main Endpoints

  • POST /{domain}/hangupparticipant

    Disconnects a specified participant from a session. This can be used to end a call for a participant without affecting the entire session, ideal for scenarios where selective call control is needed.

  • POST /{domain}/interruptivrcommand

    Stops an ongoing IVR command, allowing real-time changes in IVR sequences, such as skipping prompts or redirecting users based on dynamic input.

  • POST /{domain}/placeivrcall

    Triggers an outbound call to add a participant to an ongoing session. This API supports multi-party scenarios where new participants can be dynamically added.

  • PUT /{domain}/promptfile/{filename}

    Uploads audio files or prompts to be used within the IVR or media flows. This endpoint enables management of custom audio files to personalize IVR and call interactions.

  • POST /{domain}/splitconnection

    Splits a connection between two participants, enabling advanced call control, such as transferring or isolating a participant. This is especially useful in complex call scenarios like conference splitting or hold-and-transfer.

  • POST /{domain}/startrecording

    Starts recording the audio of an active call between two participants. This is essential for compliance, quality monitoring, or customer support training.

  • POST /{domain}/stoprecording

    Ends an active recording session and finalizes the audio file. This allows flexible control over recording duration based on session requirements.

These REST callbacks provide event-driven notifications to keep your application updated on call and session statuses in real-time. By handling these callbacks, you can automate responses, update call states, and trigger specific actions based on the session's progress.

• Main Callbacks

  • POST /callNotify

    Notifies the application of important call events, such as call progress updates or ringback status. This callback provides context on the call state, allowing the application to take actions based on the call's status.

  • POST /callAnswered

    Triggered when two participants in a session are successfully connected, marking the call as active. This callback confirms the start of an ongoing call, enabling the application to manage further call interactions or logging.

  • POST /newCall

    Activated when a new inbound call is received by the SIP Mediaserver Service. The callback response provides instructions on how to handle the incoming call, such as answering it, routing it to an IVR, or redirecting it to another endpoint.

  • POST /callEvent

    Sent when there is a change in the call state for a participant, such as being placed on hold, transferred, or disconnected. The application's response to this callback can specify how to manage the remaining participant in the session, enabling dynamic call flow adjustments.

  • POST /getIvrCommand

    Requests specific IVR commands from the application when a participant connects to the IVR. The response to this callback can define actions such as playing a phrase, collecting DTMF inputs, or branching based on caller input, allowing customized IVR interactions.

  • POST /recordingReady

    Sent when a recording session is complete, indicating that the recording file is ready for download or processing. This callback notifies the application that recorded content is available, supporting workflows for storing, analyzing, or managing recorded calls.