Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
div
classexcerptdiv
Excerpt

The REST APIs are provided for developers who want to programmatically integrate the Sonus SBC 1000/2000 into their application, and for administrators who want to script interactions with the Sonus SBC 1000/2000 gateway.

Sonus SBC 1000/2000's REST APIs provide access to resources via URI paths. To use a REST API, your application makes HTTPs requests and parses the responses. Currently, the only supported response format is XML. Methods used by developers are standard HTTP methods such as; GET, PUT, POST, and DELETE.

Tip

Because the REST API is based on open standards, you can use any Web Development Programming Language or HTTP Client Library to access the API. Refer to API Requirements for more details.

Developer's Guide

Panel
bgColor#FAFAFA
borderStylenone

API Requirements

What you need to have/consider before developing a REST client using the Sonus SBC 1000/2000 API

REST Resource Design

How the system works under the hood

API Authentication

How to authenticate with Sonus SBC 1000-2000 API requests

REST Samples

Samples for performing REST requests

Deployment Workflow

A quick guide for administrators who wish to deploy a single Sonus SBC 1000/2000 configuration onto multiple Sonus SBC 1000/2000 gateways using the REST API

API Reference

The following pages are located in the API Reference space - clicking any of these links will navigate you out of this documentation space:

Info

Please note that this release exposes a major subset of all existing Sonus SBC 1000/2000 resources via the REST API. New (and existing) resources will be incrementally added in upcoming versions of Sonus SBC 1000/2000.

Panel
borderColor#F0F0F0
bgColor#FAFAFA
borderWidth2
borderStylenone

Children Display
depth2
styleh4
pageUXAPIDOC:REST API Reference Guide