1. REST API for <ProductName>REST API for Enterprise Communications Broker, Release 4.0.0
  2. Send Requests

Send Requests

Use these guidelines when sending requests using the Enterprise Communications Broker (ECB) REST API.

URL Structure

Here's the URL structure for the requests: 

https://<subdomain>.<domain>.com:<port>/<resource-path>
Where:

  • <subdomain.domain>.com:<port>: Host and port where the ECB is running.

  • <resource-path>: Relative path that defines the resource.

Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) on a resource by using standard HTTP method requests, as summarized in the following table.

HTTP Method Description
GET Retrieve information about the ECB.
POST Configure the ECB.
PUT Update the ECB.
DELETE Delete an ECB configuration element.

Media Types

The following media types are supported by the ECB REST API:

  • application/xml

Supported Headers

The ECB REST API supports the following headers that may be passed in the header section of the HTTP request or response.

Header Description Example
Content-Type Media type of the body of the request. Required for POST and PUT requests. Content-Type: application/xml
Authorization

When requesting the access token, this header's value is the word "Basic" followed by the base64 encoding of the credentials.

When sending the access token, this header's value is the word "Bearer" followed by the previously returned access token.

See Authenticate for details.

Requesting a token:

Authorization: Basic YWRtaW46Y29ycmVjdCBob3JzZSBiYXR0ZXJ5IHN0YXBsZQ==

Sending a token:

Authorization: Bearer YWRtaW4sYWRtaW4sMjAxOC0wOC0wOSAxOToyNzow