Create Avaya Cloud Office

post

{protocol}://{server}{basePath}/accounts/{accountId}/aco-elements

This API requires the Account Administrator role.

Add a new Avaya Cloud Office element with required ACO Server data.

Only one instance of Avaya Cloud Office element can be created for an account.

The following field must be unique otherwise a HTTP 409 Conflict will be returned:

name

Will trigger asynchronous updates, the status of which should be monitored via GET /aco-elements/{elementId}.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

Body Params

Avaya Cloud Office

Avaya Cloud Office Element Details

name

string

required

length between 1 and 255

^[a-zA-Z0-9\p{L}\-\_\.\ ]+$

environment

string

enum

required

Allowed:

description

string

length ≤ 1024

(^$|^[a-zA-Z0-9\p{L}\-\_\.\ ]+$)

didNumbers

array of strings

length ≤ 2000

The did numbers in the E.164 format

didNumbers

isChatEnabled

boolean

Defaults to true

Indicates whether the chat is enabled for any given ACO element.

isExtensionCalling

boolean

Defaults to false

Indicates whether the extension calling is disabled for any given ACO element.

status

string

enum

This field indicates the current status of an Element.

An explanation of the values is listed below:

SUCCESS - An Element was created/updated successfully.
FAILED - operation on Element was failed.
IN_PROGRESS - operation performed on an Element is in progress.

Allowed:

presenceApplicationType

string

enum

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

202Accepted

400Constraint Violation

401Unauthorized

403Forbidden

404Not Found

409Conflict

500All other application errors