Avaya Infinity™Avaya Experience Platform™
API Reference

Create voice plan

post
{protocol}://{server}{basePath}/accounts//communication-managers//voice-plans

This API requires the Account Administrator role.

Create voice plan for specified account id and communication manager server id

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 6 and 6
^[a-zA-Z]{6}$

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

uuid
required

The unique id of the Communication Manager

Body Params

Voice plan with properties which needs to be created

Represents ranges of entities for configured Communication Manager.

string
required
length between 3 and 255
^(?!\s*$).+

Name of the voice plan

string
enum
required

The type of the Voice Plan. If SYSTEM type is set then allowed to set values for vdnDialPlanRange, reasonCodeNotReadyRange, reasonCodeLogOutRange. If USER type is set then allowed to set values for agentDialPlanRange, extensionDialPlanRange.

Allowed:
string
length between 0 and 6
^$|^[a-zA-Z0-9\-\_\.\ ]+$

Profile for the voice plan

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

Description of the voice plan

agentDialPlanRange
array of strings
length ≤ 50

Agent dial plan ranges. Allowed to be set only if voice plan type is USER.

agentDialPlanRange
extensionDialPlanRange
array of strings
length ≤ 50

Extension dial plan ranges. Allowed to be set only if voice plan type is USER.

extensionDialPlanRange
reasonCodeNotReadyRange
array of strings
length ≤ 50

Aux reason code ranges. Allowed to be set only if voice plan type is SYSTEM.

reasonCodeNotReadyRange
reasonCodeLogOutRange
array of strings
length ≤ 50

Logout reason code ranges. Allowed to be set only if voice plan type is SYSTEM.

reasonCodeLogOutRange
string
enum

Status code of the voice plan. A voice plan with status code PROFILE_NOT_ASSIGNED indicates that it is in error state and Profile associated with it is been deleted.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json

Updated 5 months ago

Did this page help you?