PlcmVerticalServiceCode

PlcmVerticalServiceCode

Edit a call forwarding or hunt group service invoked when callers dial the vertical service code (VSC) for that service followed by the alias. These services can’t be deleted. But API client can disable them or change their names, descriptions, or VSCs. Content-Type: application/vnd.plcm.plcm-vertical-service-code+xml. All attributes are used in ETag calculation except for entity-tag and atom-link-list.


PlcmVerticalServiceCode Fields

NameTypeDescriptionAttributes
atomLinkList Array of LinkSee Definition of Link
idstring Unique identifier for vertical service code. This id is generated by server.
namestring Display name for this service Mandatory
descriptionstring Brief description for this service
serviceEnabledboolean Turns service On/Off. Mandatory
codestring The vertical service code (VSC) for this service. Must consist of an asterisk/star (*) followed by two digits. Registered endpoints can activate this feature by dialing the VSC followed by the alias. They can deactivate it by dialing the VSC alone. Mandatory
typeType The type of service. This is read-only field and can not be changed through API.
entityTagEntityTag The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance.


Nested Types/Restrictions


NameTypeRestrictions
EntityTagstring
Length of value must be >=1
Length of value must be <=64
Typestring
Value must be one of:
  • FORWARD_UNCONDITIONALLY
  • FORWARD_ON_BUSY
  • FORWARD_NO_ANSWER
  • HUNT_GROUP_JOIN
  • HUNT_GROUP_LEAVE
  • UNKNOWN