Update voice plan

put

{protocol}://{server}{basePath}/accounts/{accountId}/communication-managers/{communicationManagerId}/voice-plans/{voicePlanId}

This API requires the Account Administrator role.

Update voice plan for specified account id, communication manager server id and voice plan id

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.

communicationManagerId

uuid

required

The unique id of the Communication Manager

voicePlanId

uuid

required

Id of existing voice plan

Body Params

Voice plan with properties which needs to be updated

Represents ranges of entities for configured Communication Manager.

name

string

required

length between 3 and 255

^(?!\s*$).+

Name of the voice plan

type

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:

userProfileId

string

length between 0 and 6

^$|^[a-zA-Z0-9\-\_\.\ ]+$

Profile for the voice plan

description

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

status

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

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200OK

400Constraint Violation

401Unauthorized

403Forbidden

404Not Found

405Method Not Allowed

409Conflict

500All other application errors