API docs by Redocly

Cloud SIP UA Service - API Overview

Download OpenAPI specification:Download

API Overview

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

Service Provisioning API

The Service Provisioning API is essential for setting up and configuring the Cloud SIP UA Service instance within your domain. It supports defining devices, configuring callback URLs, and enabling secure authentication to prepare the service for efficient operation.

  • Main Endpoints

    • POST /provisioning/cloudsipua/{domain}

      Sets up the Cloud SIP UA Service for your domain, including device registration, callback URL configuration, and credential management. This ensures secure and scalable SIP communication for your domain .

    • POST /provisioning/device/{domain}

      Manages the devices authorized to use the Cloud SIP UA Service. This endpoint allows you to add, update, or remove device configurations, ensuring secure and streamlined device management within your domain.

APIs for Application Integration

These APIs enable devices to manage and control calls, handle real-time updates, and provide seamless integration into SIP networks.

  • Main Endpoints

    • POST /mediaservice/{domain}/answerremotecall

      Answers an incoming remote call as indicated by the newRemoteCall callback. This endpoint ensures seamless connection and interaction with the caller .

    • POST /mediaservice/{domain}/hangupcall

      Terminates an active call handled by the Cloud SIP UA Service. Use this to end calls securely and efficiently .

    • POST /mediaservice/{domain}/placeremotecall

      Sends a SIP INVITE request originating from the Cloud SIP UA Service to establish a remote call. This allows dynamic outbound calling .

    • POST /mediaservice/{domain}/sendremotecallringback

      Sends a ringback signal to indicate call progress to the caller. This is useful during call setup for user feedback .

REST Callbacks for Application Integration

REST callbacks notify your application about critical SIP call events and allow real-time handling of call states.

  • Main Callbacks

    • POST /callAnswered

      Triggered when a call is successfully connected between participants. It confirms the start of an active session .

    • POST /callFailed

      Notifies the application when a call attempt fails. This allows the application to handle retries or notify users accordingly .

    • POST /callNotify

      Provides updates on call progress or state, such as ringing or on hold, enabling dynamic call flow adjustments .

    • POST /callHungup

      Sent when a call is terminated by either participant, allowing applications to conclude session-specific workflows .

    • POST /newRemoteCall

      Notifies the application of a new inbound call, providing details for decision-making, such as accepting, rejecting, or routing the call .