Product Alias Names

Products	Product Display Name - Business Zone Online Journey	Product Alias Name - API Order Journey	Product Category	Refer To Table for Characteristics
WHC Hosted Communications	Company	WHCCompany	Root Product WHC Hosted Communications	Company
	Company administrator details	WHCCompanyadministratordetails	Child of Company	Company administrator details
	Company emergency service details	WHCCompanyemergencyservicedetails	Child of Company	Company emergency service details
	Company SIPT channel capacity	WHCCompanySIPTchannelcapacity	Child of Company	Company SIPT channel capacity
Numbers	New number(s)	WHCNewnumber	Network child of Company	New number(s)
	Ported number(s)	WHCPortednumber	Network child of Company	Ported number(s)
WHC Hosted Site	Site	WHCSite	Network child of Company	Site
	Site emergency service details	WHCSiteemergencyservicedetails	Child of Site	Site emergency service details
	Site numbers	WHCSitenumbers	Child of Site	Site numbers
	Teams Direct Connect	WHCTeamsDirectConnect	Child of Site	Teams Direct Connect
	SIP device(s)	WHCSIPdevice(s)	Child of Site	SIP device(s)
	Trunk(s)	WHCTrunk(s)	Child of Site	Trunk(s)
WHC Hosted User	User	WHCUser	Network child of Site	User
	Trunking User	WHCTrunkingUser	Network child of Site	Trunking User
WHC Broadband Complete	Broadband Complete	WHCBroadbandComplete	Network child of Site	Broadband Complete
Company Add-Ons - iCS Call Analytics	iCS Insight package	WHCiCSInsightpackage	Child of Company	Company Add-Ons - iCS Call Analytics
	iCS Report package	WHCiCSReportpackage	Child of Company
	iCS Report Premier package	WHCiCSReportPremierpackage	Child of Company
	iCS Insight Supervisor licence	WHCiCSInsightSupervisorlicence	Child of 'iCS Insight package'
	iCS Dashboard Supervisor licence	WHCiCSDashboardSupervisorlicence	Child of 'iCS Report package'
	iCS Report Supervisor licence	WHCiCSReportSupervisorlicence	Child of 'iCS Report package'
	iCS MyConsole licence	WHCiCSMyConsolelicence	Child of 'iCS Report package'
	iCS Dashboard Supervisor licence	WHCiCSDashboardSupervisorlicence	Child of 'iCS Report Premier package'
	iCS Report Premier Supervisor licence	WHCiCSReportPremierSupervisorlicence	Child of 'iCS Report Premier package'
	iCS MyConsole licence	WHCiCSMyConsolelicence	Child of 'iCS Report Premier package'
	iCS Contact Centre Agent licence	WHCiCSContactCentreAgentlicence	Child of 'iCS Report Premier package'
Site Add-Ons - iCS Call Analytics	iCS Insight	WHCSiteICSInsightPackage	Child of Site	Site Add-Ons - iCS Call Analytics
	iCS Report	WHCSiteICSReportPackage	Child of Site
	iCS Premier	WHCSiteICSReportPremierPackage	Child of Site
	iCS Site Insight Supervisor licence	WHCiCSSiteInsightSupervisorlicence	Child of 'iCS Insight'
	iCS Dashboard Supervisor licence	WHCiCSDashboardSupervisorlicence	Child of 'iCS Report'
	iCS Report Supervisor licence	WHCiCSReportSupervisorlicence	Child of 'iCS Report'
	iCS MyConsole licence	WHCiCSMyConsolelicence	Child of 'iCS Report'
	iCS Dashboard Supervisor licence	WHCiCSDashboardSupervisorlicence	Child of 'iCS Report Premier'
	iCS Report Premier Supervisor licence	WHCiCSReportPremierSupervisorlicence	Child of 'iCS Report Premier'
	iCS MyConsole licence	WHCiCSMyConsolelicence	Child of 'iCS Report Premier'
	iCS Contact Centre Agent licence	WHCiCSContactCentreAgentlicence	Child of 'iCS Report Premier'
Site Add-Ons - Voice Recording	30 days	WHC30days	Child of Site	Site Add-Ons - Voice Recording
	180 days	WHC180days	Child of Site
	7 years	WHC7years	Child of Site
WHC Broadband Complete Add-Ons	Fibre	WHCFibre	Child of Broadband Complete	WHC Broadband Complete Add-Ons
	WBC	WHCWBC	Child of Broadband Complete
	IPstream	WHCIPstream	Child of Broadband Complete
	ZyXel Router	WHCZyXelRouter	Child of 'Fibre', 'WBC' & 'IPstream'
User license	Functional User	WHCFunctionaluser	Child of User	User license
	Fixed User	WHCFixeduser	Child of User
	Mobile User	WHCMobileuser	Child of User
	Foundation User	WHCFoundationuser	Child of User
	SIPT Functional User	WHCSIPTFunctionalUser	Child of User
	SIPT Fixed User	WHCSIPTFixedUser	Child of User
	SIPT Mobile User	WHCSIPTMobileUser	Child of User
User Add-ons	Voicemail	WHCVoicemail	Child of User license	User Add-ons
	Voice Recording	WHCVoiceRecording	Child of User license
	Call Handling feature pack	WHCCallHandlingfeaturepack	Child of User license
	Softphone	WHCWebexSoftphone	Child of User license
	Basic	WHCWebexBasic	Child of User license
	Standard	WHCWebexStandard	Child of User license
	Premium	WHCWebexPremium	Child of User license
	Call Centre Agent	WHCCallCentreAgent	Child of User license
	Call Centre Supervisor	WHCCallCentreSupervisor	Child of User license
	GoIntegrator DB (CRMConnect)	WHCGoIntegratorDB(CRMConnect)	Child of User license
	GoIntegrator DB Lite (CRMConnect)	WHCGoIntegratorDBLite(CRMConnect)	Child of User license
	Go TAPI	WHCGoTAPI	Child of User license
	Reception Console - Enterprise	WHCReceptionConsole-Enterprise	Child of User license
	Reception Console - Small Business	WHCReceptionConsole-SmallBusiness	Child of User license
	Fax Messaging	WHCFaxMessaging	Child of User license
	Busy Lamp Field (BLF)	WHCBusyLampField(BLF)	Child of User license
	Call Centre Agent	WHCCallCentreAgent	Child of User license
	Call Centre Supervisor	WHCCallCentreSupervisor	Child of User license
	Contact Centre Agent	WHCContactCentreAgent	Child of User license
	Contact Centre Supervisor	WHCContactCentreSupervisor	Child of User license
IP Phones	Polycom 8300	WHCPolycomTrio8300	Child of User	IP Phones
	Polycom CCX500	WHCPolycomCCX500	Child of User
	Polycom CCX600	WHCPolycomCCX600	Child of User
	Polycom CCX700	WHCPolycomCCX700	Child of User
	Polycom VVX 250	WHCPolycomVVX250	Child of User
	Polycom VVX 450	WHCPolycomVVX450	Child of User
	Yealink T31G	WHCYealinkT31G	Child of User
	Yealink T43U	WHCYealinkT43U	Child of User
	Yealink T46U	WHCYealinkT46U	Child of User
	Yealink T48U	WHCYealinkT48U	Child of User
	Yealink T53	WHCYealinkT53	Child of User
	Yealink T53W	WHCYealinkT53W	Child of User
	Yealink T54W	WHCYealinkT54W	Child of User
	Yealink T57W	WHCYealinkT57W	Child of User
	AudioCodes Mediant 500Li MSBR	AudioCodesMediant500LiMSBR	Child of User
	Cisco ATA 191	CiscoATA191	Child of User
	Cisco ATA 192	CiscoATA192	Child of User
	Yealink CP925	WHCYealinkCP925	Child of User
	Yealink CP965	WHCYealinkCP965	Child of User
	Yealink T58W	WHCYealinkT58W	Child of User
	Yealink W70B	WHCYealinkW70B	Child of User
	Yealink W73P	WHCYealinkW73P	Child of User
	Yealink W80DM	WHCYealinkW80DM	Child of User
	Use own device	WHCUseowndevice	Child of User
Headsets	Jabra BIZ 2300 - Duo NC/Phone	WHCJabraBIZ2300-DuoNC/Phone	Child of User	Headsets
	Jabra BIZ 2300 - Duo NC/USB	WHCJabraBIZ2300–DuoNC/USB	Child of User
	Jabra BIZ 2300 - Mono NC/Phone	WHCJabraBIZ2300-MonoNC/Phone	Child of User
	Jabra BIZ 2300 - Mono NC/USB	WHCJabraBIZ2300-MonoNC/USB	Child of User
	Jabra Motion UC MS Plus	WHCJabraMotionUCMSPlus	Child of User
	Jabra PRO 920 - Duo for Polycom	WHCJabraPRO920-DuoforPolycom	Child of User
	Jabra PRO 920 - Duo for Yealink	WHCJabraPRO920-DuoforYealink	Child of User
	Jabra PRO 920 - Mono for Polycom	WHCJabraPRO920-MonoforPolycom	Child of User
	Jabra PRO 920 - Mono for Yealink	WHCJabraPRO920-MonoforYealink	Child of User
	Jabra Pro930 Duo	WHCJabraPro930Duo	Child of User
	Plantronics CS540 Mono - Poly	WHCPlantronicsCS540MonoPoly	Child of User
	Plantronics CS540 Mono - Yealink	WHCPlantronicsCS540MonoYealink	Child of User
	Plantronics HW510 Mono - Poly	WHCPlantronicsHW510MonoPoly	Child of User
	Plantronics HW510 Mono - Yealink	WHCPlantronicsHW510MonoYealink	Child of User
	Plantronics HW520 Duo - Poly	WHCPlantronicsHW520DuoPoly	Child of User
	Plantronics HW520 Duo - Yealink	WHCPlantronicsHW520DuoYealink	Child of User
	Plantronics Savi 7220 Duo - Poly	WHCPlantronicsSavi7220DuoPoly	Child of User
	Plantronics Savi 7220 Duo - Yealink	WHCPlantronicsSavi7220DuoYealink	Child of User
	Plantronics Savi W8220 USB Duo - USB	WHCPlantronicsSaviW8220USBDuoUSB	Child of User
	Plantronics Savi W8240 USB Mono - USB	WHCPlantronicsSaviW8240USBMonoUSB	Child of User
	Plantronics W8220 Duo - Poly	WHCPlantronicsW8220DuoPoly	Child of User
	Plantronics W8220 Duo - Yealink	WHCPlantronicsW8220DuoYealink	Child of User
	Plantronics W8240 Mono - Poly	WHCPlantronicsW8240MonoPoly	Child of User
	Plantronics W8240 Mono - Yealink	WHCPlantronicsW8240MonoYealink	Child of User
Accessories	Jabra SPEAK 510	JabraSPEAK510	Child of User	Accessories
	Polycom PSU for CCX500 CCX600 CCX700	PolycomPSUforCCX500CCX600CCX700	Child of User
	Polycom Trio 8300 Power Kit	PolycomTrio8300PowerKit	Child of User
	Polycom VVX EM 50 Sidecar	PolycomVVXEM50Sidecar	Child of User
	Polycom VVX PSU	PolycomVVXPSU	Child of User
	Polycom VVX wifi Dongle	PolycomVVXwifiDongle	Child of User
	Yealink Bluetooth Adaptor	YealinkBluetoothAdaptor	Child of User
	Yealink CP700 Speaker	YealinkCP700Speaker	Child of User
	Yealink CP900 Speaker	YealinkCP900Speaker	Child of User
	Yealink DD10K DECK	YealinkDD10KDECK	Child of User
	Yealink WF50	YealinkWF50	Child of User
	Yealink W59R	YealinkW59R	Child of User
	Yealink T4U EHS40	YealinkT4UEHS40	Child of User
	Yealink RT30 DECT Repeater	YealinkRT30DECTRepeater	Child of User
	Yealink UVC40	YealinkUVC40	Child of User
	Yealink EXP43	YealinkEXP43	Child of User
	Yealink EXP50	YealinkEXP50	Child of User
	Yealink EXP UVC30	YealinkEXPUVC30	Child of User
	Polycom Calisto 5300	PolycomCalisto5300	Child of User
	Yealink CAM50	YealinkCAM50	Child of User
	Yealink 10W PSU	Yealink10WPSU	Child of User
	Yealink W73H	YealinkW73H	Child of User
	Yealink W80B	YealinkW80B	Child of User
WHC Trunk Device	Trunk Device	WHCTrunkDevice	Child of User (only with SIPT User license) and TrunkingUser	Trunk Device
WHC CPE Additional	WHC Jabra BIZ 2300-Mono NC/USB Addnl	WHCJabraBIZ2300-MonoNC/USBAddnl	Network Child of Site Can be added only in Subsequent provide order	IP Phones
	WHC Jabra Motion UC MS Plus Addnl	WHCJabraMotionUCMSPlusAddnl	Network Child of Site
	WHC Jabra BIZ 2300-Duo NC/USB Addnl	WHCJabraBIZ2300-DuoNC/USBAddnl	Network Child of Site
	WHC Jabra Pro930 Duo Addl	WHCJabraPro930DuoAddl	Network Child of Site
	WHC Plantronics Savi W8220 USB Duo Addl	WHCPlantronicsSaviW8220USBDuoAddl	Network Child of Site
	WHC Plantronics Savi W8240 USB Mono Addl	WHCPlantronicsSaviW8240USBMonoAddl	Network Child of Site
	WHC Jabra SPEAK 510 Additional	WHCJabraSPEAK510Additional	Network Child of Site
	WHC Yealink EXP UVC30 Addl	WHCYealinkEXPUVC30Addl	Network Child of Site
	WHC Yealink CP700 Speaker Addl	WHCYealinkCP700SpeakerAddl	Network Child of Site
	WHC Yealink CP900 Speaker Addl	WHCYealinkCP900SpeakerAddl	Network Child of Site
	WHC Yealink UVC40 Addl	WHCYealinkUVC40Addl	Network Child of Site
	WHC Polycom Calisto 5300 Addl	WHCPolycomCalisto5300Addl	Network Child of Site

 

Company

Product Display Name on Business Zone	Product Alias Name - API Journey
Company	WHCCompany

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
Company name	customerName	TestCompany			3 to 30 characters and use letters, numbers and spaces.	Mandatory
Customer group	customerGroup	TestGroup				Mandatory	This attribute value could be retrieved using Verify data API (Retrieve Reseller details).
Company domain	customerDomain	testcompany1.abc			1 to 30 characters using lower case letters (a-z), numbers(0-9), fullstops(.) or hyphens(-). There needs to be at least one dot in the domain name.	Mandatory
Extension length	extensionLength	4	2,3,4,5,6	2,3,4,5,6	We recommend using 4- digit extensions. If you have more than 9,999 users or you're replicating an existing set-up it can be changed.	Mandatory
Business Portal admin rights	restrictedAdminAccessFlag	true	Config Config & Order	true false		Mandatory	If Config - true Config & Order - false
Call Analytics level	callAnalyticsLevel	Company	Company Site	Company Site		Optional	This attribute value should be provided only if Call Analytics feature to be added.
SalesTag	salesTag	Test				Mandatory	This attribute value could be retrieved using Verify data API (Retrieve Reseller details). This value is only required for 'VEL' network.
This attribute doesn't exist in Business Zone	resellerId	Test1234				Mandatory	This attribute value could be retrieved using Verify data API (Retrieve Reseller details). This value is only required for 'VEL' network.
This attribute doesn't exist in Business Zone	serviceOffering	Wholesale Hosted Communications		WholesaleHostedCommunications		Mandatory	This attribute will have default value and can be retrieved/reviewed using Verify data API (Retrieve Reseller details) as well.

 

Company Administrator Details

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
Company administrator details	WHCCompanyadministratordetails	Child product of WHCCompany. This is a mandatory product.

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
Title	title	Mr	Mr Mrs Miss Ms Prof Dr	Mr Mrs Miss Ms Prof Dr	Upto 8 characters using only letters, noting that the first letter must be a capital.	Mandatory	Select a title from the list of allowed values or enter any valid title.
First name	firstName	Test			2 to 30 characters and use letters, hyphens(-)and apostrophe(').	Mandatory	This is the First name of the company administrator.
Last name	lastName	User			2 to 30 characters and use letters, spaces, hyphens (-) and apostrophe (').	Mandatory	This is the surname of the company administrator.
Primary contact number	primaryNumber	02033322211			A valid UK phone number with 10-11 digits, starting with 01, 02, 03, 07 or 08 and without spaces.	Mandatory	This is the Primary contact number for the company administrator.
Secondary contact number	secondaryNumber	02033322211			A valid UK phone number with 10-11 digits, starting with 01, 02, 03, 07 or 08 and without spaces.	Mandatory	This is the Secondary contact number for the company administrator.
Email address	emailAddress	name@example.com			Please enter a valid email address such as name@example.com. Prefix should be at least 2 characters long.	Mandatory	This is the email address of the company administrator.
Job title	position	Admin			1 to 40 letters and use letters and spaces only.	Mandatory	This is the job title of the company administrator.
Admin username	adminName	TestAdmin			1 to 40 characters and use letters, numbers, hyphens(-), fullstops(.) and underscores(_).	Mandatory	This is the username of the company administrator.
Admin password	adminPassword	abcd===			The password needs to be 8-30 characters in length, containing atleast one lower case letter(a-z), one upper case letter (A-Z), one number (0-9)and one special character from !$%+_@~?#	Mandatory	This is the password for the company administrator account. We recommend you create the administrator as a user in this order. When the user is created, the password that is entered here will be automatically be reset for them.The user will then receive an email with the new password details. This password should be encrypted. Details will be shared during establishment.

 

Company Emergency Service Details

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
Company emergency service details	WHCCompanyemergencyservicedetails	Child product of WHCCompany. This is a mandatory product.

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
999 Display Name	ESDBCompanyDisplayName	Test			1 to 50 characters and can use letters, numbers and spaces	Mandatory	Enter 999 Display Name for the company
Title	title	Mr	Mr Mrs Miss Ms Prof Dr	Mr Mrs Miss Ms Prof Dr	Upto 8 characters using only letters, noting that the first letter must be a capital.	Mandatory	Select a title from the list of allowed values or enter any valid title.
First name	firstName	Test			2 to 30 characters and use letters, hyphens(-)and apostrophe(').	Mandatory	This is the First name of the company administrator.
Last name	lastName	User			2 to 30 characters and use letters, spaces, hyphens (-) and apostrophe (').	Mandatory	This is the surname of the company administrator.
Primary contact number	primaryNumber	02033322211			A valid UK phone number with 10-11 digits, starting with 01, 02, 03, 07 or 08 and without spaces.	Mandatory	This is the Primary contact number for the company administrator.
Secondary contact number	secondaryNumber	02033322211			A valid UK phone number with 10-11 digits, starting with 01, 02, 03, 07 or 08 and without spaces.	Mandatory	This is the Secondary contact number for the company administrator.
Email address	emailAddress	name@example.com			Please enter a valid email address such as name@example.com. Prefix should be at least 2 characters long.	Mandatory	This is the email address of the company administrator.
Job title	position	Admin			1 to 40 letters and use letters and spaces only.	Mandatory	This is the job title of the company administrator.

 

Company SIPT Channel Capacity

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
Company SIPT channel capacity	WHCCompanySIPTchannelcapacity	Child product of WHCCompany. This is an optional product and should be added only when SIPT or Mixed site with Trunk will be added. Please don't add this product when only Centrex site added.

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
Contract term	contractTerm	1	30 days 1 year 2 years 3 years	1 12 24 36	Number	Mandatory	This is the contract term length in months.
This attribute doesn't exist in Business Zone	contractTermUnit	M	M	M		Mandatory	Default value M for 'months'.
Total number of channels	overallCallCapacityLimit	5			Number	Mandatory	This is the maximum number of concurrent calls across all the trunks for this company. You can enter a value from 1-10000 above the value of maximum channels per trunk at all the sites.
Channel type	type	Basic	Basic Premium	Basic Premium		Mandatory

 

Company add-on - Call Analytics

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
iCS Insight package	WHCiCSInsightpackage	Child Add-on of WHCCompany. This is an optional product. Only one out of three add-ons can be added.
iCS Report package	WHCiCSReportpackage
iCS Report Premier package	WHCiCSReportPremierpackage

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Format/Regex	Mandatory/Optional	Comments
Administrator email address	iCSCallAdminEmailAddress	name@example.com	Please enter a valid email address.	Mandatory	Please enter the email address for the administrator of the iCSCallAnalytics portal.

 

Below are the child products of each package:

Parent Product
WHCiCSInsightpackage
Child Product Name	Business Zone Attribute Name	API Journey Attribute Name	Sample value	Format/Regex	Mandatory/Optional	Comments
WHCiCSInsightSupervisorlicence	ICS Insight Supervisor licence	quantity	1	Number	Mandatory	Default value - 1

 

Parent Product
WHCiCSReportpackage
Child Product Name	Business Zone Attribute Name	API Journey Attribute Name	Sample value	Format/Regex	Mandatory/Optional	Comments
WHCiCSReportSupervisorlicence	iCS Report Supervisor licence	quantity	2	Number	Mandatory
WHCiCSDashboardSupervisorlicence	iCS Dashboard Supervisor licence	quantity	1	Number	Optional
WHCiCSMyConsolelicence	iCS My Console licence	quantity	3	Number	Optional

 

Parent Product
WHCiCSReportPremierpackage
Child Product Name	Business Zone Attribute Name	API Journey Attribute Name	Sample value	Format/Regex	Mandatory/Optional	Comments
WHCiCSReportPremierSupervisorlicence	iCS Report Premier Supervisor licence	quantity	2	Number	Mandatory
WHCiCSDashboardSupervisorlicenceforRP	iCS Dashboard Supervisor licence	quantity	1	Number	Optional
WHCiCSMyConsolelicenceforRP	iCS My Console licence	quantity	3	Number	Optional
WHCiCSContactCentreAgentlicence	ICS Contact Centre Agent licence	quantity	1	Number	Optional

 

New Numbers

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
New number(s)	WHCNewnumber	Network Child product of WHCCompany. Either New Number(s) or Ported Number(s) product should be added with Company.

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Format/Regex	Mandatory/Optional	Comments
This attribute doesn't exist in Business Zone	startNumber	0123123232	Number	Mandatory	This value will be received from 'Reserve number API'.
This attribute doesn't exist in Business Zone	endNumber	0123123234	Number	Mandatory	This value will be received from 'Reserve number API'.
Location code	customLocationCode	0203	Number	Mandatory	Area code
Location name	customLocationName	London(pan)	String	Mandatory	Area name

 

Ported Numbers

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
Ported number(s)	WHCPortednumber	Network Child product of WHCCompany. Either New Number(s) or Ported Number(s) product  should be added with Company.

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Format/Regex	Mandatory/Optional	Comments
This attribute doesn't exist in Business Zone	startingLineNumber	0123123232	Number	Mandatory
This attribute doesn't exist in Business Zone	endingLineNumber	0123123232	Number	Mandatory

 

Site

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
Site	WHCSite	Network Child product of WHCCompany. This is a mandatory product.

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
Site name	siteName	TestCompany			3 to 19 characters and use letters, numbers and spaces.	Mandatory	A unique name for the site.
Site workstyle	SiteWithOffsiteUsers	No	Onsite Only Onsite & Remote	No Yes		Mandatory
Site billing reference	siteBillingRef	BTWABC1234			3 to 20 characters using lower case letters, numbers, hyphens(-) and underscore(_).	Optional	This field is optional but if used will apply the reference number to Sites and Users in the BBU and CDR files.
Site location code	siteLocationCode	123456789			Numbers upto 15 digits	Optional	If you're creating more than 1 site and both sites have users with the same extension numbers, then also please enter a unique code for each site. When a user extension dials from Site 1 to Site 2, they will need to enter this Site location code followed by the extension number. Please make sure the site location code is a number between 1-15 digits long
Extension length	extensionLength	4	2,3,4,5,6	2,3,4,5,6	We recommend you use the same extension length across the company.	Mandatory
Maximum users	userLimit	99			Numbers 1 to 9999	Mandatory	Please enter the maximum number of users allowed on this site.
This attribute doesn't exist in Business Zone	siteTechnology	SIPT	Centrex SIPT Mixed	Centrex SIPT Mixed		Mandatory
This attribute doesn't exist in Business Zone	trunkGroupCapacityLimit	100			Numbers 1 to 1000	Optional	This attribute only required when SIPT or Mixed Site added with Hosted Trunk.

 

Site Emergency Service Details

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
Site emergency service details	WHCSiteemergencyservicedetails	Child product of WHCSite. This is a mandatory product.

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
999 Display Name	ESDBCompanyDisplayName	Test			1 to 50 characters and can use letters, numbers and spaces	Mandatory	Enter 999 Display Name for the Site
Title	title	Mr	Mr Mrs Miss Ms Prof Dr	Mr Mrs Miss Ms Prof Dr	Upto 8 characters using only letters, noting that the first letter must be a capital.	Mandatory	Can select a title from the list of allowed values or enter any valid title.
First name	firstName	Test			2 to 30 characters and use letters, hyphens(-)and apostrophe(').	Mandatory	This is the First name of the site administrator.
Last name	lastName	User			2 to 30 characters and use letters, spaces, hyphens (-) and apostrophe (').	Mandatory	This is the surname o fthe site administrator.
Primary contact number	primaryNumber	02033322211			A valid UK phone number with 10-11 digits, starting with 01, 02, 03, 07 or 08 and without spaces.	Mandatory	This is thePrimary contact number for the site administrator.
Secondary contact number	secondaryNumber	02033322211			A valid UK phone number with 10-11 digits, starting with 01, 02, 03, 07 or 08 and without spaces.	Mandatory	This is the Secondary contact number for the site administrator.
Email address	emailAddress	name@example.com			Please enter a valid email address such as name@example.com. Prefix should be at least 2 characters long.	Mandatory	This is the email address of the site administrator.
Job title	position	Admin			1 to 40 letters and use letters and spaces only.	Mandatory	This is the job title of the site administrator.

 

Site Numbers

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
Site numbers	WHCSitenumbers	Child product of WHCSite. This is a mandatory product.

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
Starting line number	startingLineNumber	02033322211			Number	Mandatory
Ending line number	endingLineNumber	02033322211			Number	Mandatory
Status	isActive	true	Active Inactive	true false		Mandatory	For New Numbers - Always true For Ported Numbers - true or false

 

SIP Device(s)

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
SIP device(s)	WHCSIPdevice(s)	Child product of WHCSite. This is an optional product for Mixed site and mandatory for SIPT site. At least one SIP device or TDC should be added in Mixed if Trunks required.

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional
Friendly name	deviceName	Device A			1 to 30 characters and use letters, numbers and spaces.	Mandatory	Unique friendly name for SIP device.
Manufacturer	sharedDeviceManufacturer	3CX			Select from list of Manufacturers added below	Mandatory
Model	sharedDeviceType	3CX Phone System			Select from list of Models added below	Mandatory
Software version	softwareVersion	Version 15.5 Onwards			Select from list of Devices added below	Mandatory

 

Manufacturer	Model	Software version
3CX	3CX Phone System	Version 15.5 Onwards
Asterisk	FreePBX	Asterisk version 13 Onwards
AudioCodes	Mediant Media Gateway	Version 7.20A Onwards
Avaya	Communication Server with ASBCE	ASBCE Version 7.1 Onwards
Avaya	IP Office	Version 7.0 Onwards
Avaya	IP Office with ASBCE	ASBCE Version 7.1 Onwards
Avaya	Communication Manager with ASBCE	ASBCE Version 7.1 Onwards
Cisco	UC320	Version 7.1 Onwards
Cisco	UC500 Series	Version 7.1 Onwards
Cisco	CUCM with CUBE	CUBE IOS 15.1 Onwards
Cisco	CME	Version 7.1 Onwards
Ericsson-LG	iPECS UCP	Version 2.1 Onwards
Ericsson-LG	iPECS eMG80	Version 2.1 Onwards
IPCortex	IPCortex IP PBX	Version 6.2 Onwards
Microsoft	Skype for Business with Sonus SBC	Sonus SBC Version 6.1 Onwards
Microsoft	Lync 2013 with Audiocodes SBC	Audiocodes 7.20A Onwards
Microsoft	Skype for Business with Audiocodes SBC	Audiocodes 7.20A Onwards
Microsoft	Teams with Audiocodes SBC	Audiocodes 7.20A Onwards
Mitel	MiVoice 250 with MBG	MBG Version 10.0 Onwards
Mitel	MiVoice 400 with MBG	MBG Version 10.1 Onwards
Mitel	MX-ONE with MBG	MBG Version 10.1 Onwards
Mitel	MiVoice Office 250	Version 6.3
Mitel	MiVoice Business (3300) with MBG	MBG Version 9.0 Onwards
Mitel	MiVoice Business (was 3300)	Version 13.2
NEC	SL2100	Version 1.04 Onwards
NEC	SL1100	Version 5.12 Onwards
NEC	SV9100	Version 6.0 Onwards
NEC	SV8100	Version 9.55 Onwards
OneAccess	ONEOS	Version 5.2R1E2 Onwards
Panasonic	NSX Series	Version 4.1 Onwards
Panasonic	NS Series	Version 4.1 Onwards
Panasonic	KX-TDE	Version 8 Onwards
Panasonic	KX-NCP	Version 8 Onwards
Qunifi	Call2Teams SBC	Version 5.0 Onwards
Samsung	SCM	5.0 Onwards
Samsung	Ubigate	Version 1.3 Onwards
Samsung	OfficeServ	Version 4.3 Onwards
ShoreTel	Connect ONSITE with Ingate SBC	Ingate SBC Version 5.0 Onwards
Splicecom	ISIP Gateway	Version 1.2 Onwards
Splicecom	SelectVoice	Version 1.2 Onwards
Swyx	SwyxWare	Release 40.3 Onwards
Toshiba	Strata CIX	Version 5.2 Onwards
Toshiba	IPedge	Version 1.6 Onwards
Unify	Openscape Business	Version V2R4 Onwards
Wildix	WPBX	V5.02 Onwards

 

Teams Direct Connect

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
Teams Direct Connect	WHCTeamsDirectConnect	Child product of WHCSite. This is an optional product for Mixed site and mandatory for SIPT site. At least one SIP device or TDC should be added in Mixed if Trunks required.

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
Tenant ID	tenantId	8555b51d-6f6d-843c-91s2-daa1c25fd5ee			GUID	Mandatory	Enter the unique Tenant ID of your customers Office 365 account after you have provided 'consent' for BT to provide an operator connection.

 

Trunk(s)

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
Trunk(s)	WHCTrunk(s)	Child product of WHCSite. This is an optional product for Mixed site and mandatory for SIPT site. Trunk should be added if SIP device/TDC is added.

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
Friendly name	trunkName	TrunkA			1 to 30 characters and use letters, numbers and spaces.	Mandatory
SIP device name	deviceName	DeviceA			1 to 30 characters and use letters, numbers and spaces.	Mandatory
Phone number	telephoneNumber	01212022961				Mandatory	Telephone Number should be provided from list of available site numbers.
Extension	extension	2961			A valid number between 2-6 digits matching the site extension length policy, 3+ digit values cannot be or start with 112, 999.	Mandatory	Enter a valid number between 2-6 digits as per the site's extension length and note that 3 or more digit extentions cannot be or start with 112 or 999.
Total number of channels	maxActiveCalls	5			Numbers from 1 to 2500.	Mandatory	This is the maximum number of concurrent calls for this trunk.
Authentication username	authenticationUserName	admin			4 to 40 characters long use letters, numbers, hyphens(-), fullstops(.) and underscores(_).	Mandatory	This is the SIP authentication username that will need to be configured on the SIPdevice.
Initial Password	authenticationPassword	86FUgv$!			The password needs to be 8-30 characters in length, containing atleast one lower case letter (a-z), one upper case letter (A-Z), one number (0-9) and one special character from !$%+_@~?#	Mandatory	This is the password for the SIP authentication. This password should be encrypted. Details will be shared during establishment.
User location	UserTypeLocation	ONSITE	Onsite Remote	ONSITE OFFSITE		Mandatory	If Onsite - ONSITE Remote - OFFSITE
Enable PBX CLI pass-through	cliPassthrough	No	Yes No	Yes No		Mandatory

 

Site Add-Ons - Call Analytics

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
iCS Insight	WHCSiteICSInsightPackage	Child Add-on of WHCSite. This is an optional product. Only one out of three add-ons can be added.
iCS Report	WHCSiteICSReportPackage
iCS Premier	WHCSiteICSReportPremierPackage

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Format/Regex	Mandatory/Optional	Comments
Administrator email address	iCSCallAdminEmailAddress	name@example.com	Please enter a valid email address.	Mandatory	Please enter the email address for the administrator of the iCSCallAnalytics portal.

 

Below are the child products of each package:

Parent Product
WHCSiteICSInsightPackage
Child Product Name	Business Zone Attribute Name	API Journey Attribute Name	Sample value	Format/Regex	Mandatory/Optional	Comments
WHCiCSSiteInsightSupervisorlicence	ICSInsight Supervisor licence	quantity	1	Number	Mandatory	Default value-1

 

Parent Product
WHCSiteICSReportPackage
Child Product Name	Business Zone Attribute Name	API Journey Attribute Name	Sample value	Format/Regex	Mandatory/Optional	Comments
WHCiCSSiteDashboardSupervisorlicence	iCS Report Supervisorlicence	quantity	2	Number	Mandatory
WHCiCSSiteDashboardSupervisorlicence	iCS Dashboard Supervisor licence	quantity	1	Number	Optional
WHCiCSSiteMyConsolelicence	iCS MyConsole licence	quantity	3	Number	Optional

 

Parent Product
WHCSiteICSReportPremierPackage
Child Product Name	Business Zone Attribute Name	API Journey Attribute Name	Sample value	Format/Regex	Mandatory/Optional	Comments
WHCiCSSiteReportPremierSupervisorlicence	iCS Report Premier Supervisor licence	quantity	2	Number	Mandatory
WHCiCSSiteDashboardSupervisorlicenceforRP	iCS Dashboard Supervisor licence	quantity	1	Number	Optional
WHCiCSSiteMyConsolelicenceforRP	iCS MyConsole licence	quantity	3	Number	Optional
WHCiCSSiteContactCentreAgentlicence	ICS Contact Centre Agent licence	quantity	1	Number	Optional

 

Site Add-Ons - Voice Recording

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
30 days	WHCCallRecording30days	Child Add-on of WHCSite. This is an optional product. Only one out of three add-ons can be added. No characteristics present for these products.
180 days	WHCCallRecording180days
7 years	WHCCallRecording7years
No characteristics at Parent level.

 

CPE Additional

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
CPE additional	WHCCPEadditional	Network Child product of WHCSite. This is an optional product and can be added only in a subsequent provide journey.
No characteristics at Parent level.

 

Below are the child products of WHCCPEadditional:

Below Characteristics are same for all child products
Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
Quantity	quantity	1			Number	Mandatory	Please ensure total headsets count doesn't exceed 8 per user

 

Child product list as below: 

	Product Display Name on Business Zone	Product Alias Name - API Journey
Headset	WHC Jabra BIZ 2300-Mono NC/USB Addnl	WHCJabraBIZ2300-MonoNC/USBAddnl
	WHC Jabra Motion UC MS Plus Addnl	WHCJabraMotionUCMSPlusAddnl
	WHC Jabra BIZ 2300-Duo NC/USB Addnl	WHCJabraBIZ2300-DuoNC/USBAddnl
	WHC Jabra Pro930 Duo Addl	WHCJabraPro930DuoAddl
	WHC Plantronics Savi W8220 USB Duo Addl	WHCPlantronicsSaviW8220USBDuoAddl
	WHC Plantronics Savi W8240 USB Mono Addl	WHCPlantronicsSaviW8240USBMonoAddl
Accessories	WHC Jabra SPEAK 510 Additional	WHCJabraSPEAK510Additional
	WHC Yealink EXP UVC30 Addl	WHCYealinkEXPUVC30Addl
	WHC Yealink CP700 Speaker Addl	WHCYealinkCP700SpeakerAddl
	WHC Yealink CP900 Speaker Addl	WHCYealinkCP900SpeakerAddl
	WHC Yealink UVC40 Addl	WHCYealinkUVC40Addl
	WHC Polycom Calisto 5300 Addl	WHCPolycomCalisto5300Addl

 

Broadband

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
Broadband Complete	WHCBroadbandComplete	Network Child product of WHCSite. This is an optional product.

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
Do I have a landline number?	simProvideOrder	false	Yes No	false true		Mandatory	If Yes - false No - true
Landline number	landline	0123213222			A valid UK phone number with 10-11 digits, starting with 01 or 02 and without spaces	Mandatory	Landline number value will be required only when 'simProvideOrder' value provided as 'false'
SIM Code	simCode	SIM24AC6S2			A valid sim code (10 characters). You can use 4-character prefix in uppercase (SIM2) followed by 6 digits Alpha numeric	Mandatory	SIM Code value will be required only when 'simProvideOrder' value provided as 'true'
Is there an existing broadband service on this line?	connectionType	Brand new connection	No Yes	Brand new connection Existing connection		Mandatory	If Yes - Existing connection No - Brand new connection
IP address type	iPAddressType	2xStatic	2xStatic Dynamic 1xStatic	2xStatic Dynamic 1xStatic		Mandatory

 

Broadband Child Products

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
Fibre	WHCFibre	Any one out of these three child products can be added. All three products have the same characteristics mentioned below.
WBC	WHCWBC
IPstream	WHCIPstream

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
Usage	usage	50GB	50GB Unlimited	50GB Unlimited		Mandatory	The usage required per month.

 

Below are the child products of above products which are optional and don't have any characteristics:

Product Display Name on Business Zone	Product Alias Name - API Journey	Parent Product
ZyXel Router	WHCZyXelRouter	WHCIPstream, WHCFibre & WHCWBC

 

User

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
User	WHCUser	Network Child product of WHCSite. This is an optional product.

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
999 Display Name	ESDBUserDisplayName	Test			1 to 50 characters and can use letters, numbers and spaces	Optional	Enter 999 Display Name for the User
Title	title	Mr	Mr Mrs Miss Ms Prof Dr	Mr Mrs Miss Ms Prof Dr	Upto 8 characters using only letters, noting that the first letter must be a capital.	Mandatory	Can select a title from the list of allowed values or enter any valid title.
First name	firstName	First			2 to 30 characters and use letters, numbers, hyphens(-), full stops(.) and apostrophe(').	Mandatory	This is the user's first name.
Last name	lastName	Last			2 to 30 characters and use letters, numbers, spaces, hyphens (-) and full stops( .).	Mandatory	This is the user's surname.
Email address	emailAddress	name@example.com			Please enter a valid email address such as name@example.com. Prefix should be at least 2 characters long.	Mandatory	This is the user's email address.
Phone number	telephoneNumber	0123213232				Mandatory	Provide phone number from list of available site numbers.
Extension	extension	3232			A valid number between 2-6 digits matching the site extension length policy, 3+ digit values cannot be or start with 112, 999.	Mandatory
Username type	userNameType		Name Phone number Other	Name Phone number Other		Mandatory
User location	UserTypeLocation	ONSITE	Onsite Remote	ONSITE OFFSITE		Mandatory	If Onsite - ONSITE Remote - OFFSITE
User name	userName				2-40 characters and use letters, numbers, hyphens(-), fullstops(.) and underscores(_).	Mandatory	Please enter a valid username upto 40 characters.
This attribute doesn't exist in Business Zone	userType	Business Trunking User		IP Centrex User Business Trunking User		Mandatory	If Centrex User - IP Centrex User SIPT User - Business Trunking User

 

User License

Child product of WHCUser. One license must be added to WHC User.
Product Display Name on Business Zone	Product Alias Name - API Journey	User Type
Functional User	WHCFunctionaluser	Centrex User License
Fixed User	WHCFixeduser	Centrex User License
Mobile User	WHCMobileuser	Centrex User License
Foundation User	WHCFoundationuser	Centrex User License
SIPT Functional User	WHCSIPTFunctionalUser	SIPT User License
SIPT Fixed User	WHCSIPTFixedUser	SIPT User License
SIPT Mobile User	WHCSIPTMobileUser	SIPT User License

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
Contract term	contractTerm	0	1 day 1 year 2 years+	0 12 24		Mandatory	If 1 day - 0 1 year - 12 2 years+ - 24

 

User Add-Ons

Child add-ons of WHCUser licenses and these are optional. There are no characterstics required for these products.
User Licenses	Group	Product Name - Current Online Journey	Product Alias Name - API Journey
WHCFoundationuser	General add-ons Min 0 from group. Voice Recording can be added only if Voice Recording enabled at Site.	Voicemail	WHCVoicemail
		Voice Recording	WHCVoiceRecording
		Call Handling feature pack	WHCCallHandlingfeaturepack
	Collaboration with Cisco Webex Max 1 Min 0 from group	Softphone	WHCWebexSoftphone
		Basic	WHCWebexBasic
		Standard	WHCWebexStandard
		Premium	WHCWebexPremium
WHCFixeduser	Call Center ACD add-ons Max 2 Min 0 from group	Call Centre Agent	WHCCallCentreAgent
		Call Centre Supervisor	WHCCallCentreSupervisor
	CRM add-ons Max 2 Min 0 from group	GoIntegrator DB (CRMConnect)	WHCGoIntegratorDB(CRMConnect)
		GoIntegrator DB Lite (CRMConnect)	WHCGoIntegratorDBLite(CRMConnect)
		Go TAPI	WHCGoTAPI
	Reception Console add-ons Max 1 Min 0 from group	Reception Console - Enterprise	WHCReceptionConsole-Enterprise
		Reception Console - Small Business	WHCReceptionConsole-SmallBusiness
	General add-ons Min 0 from group. Voice Recording can be added only if Voice Recording enabled at Site.	Fax Messaging	WHCFaxMessaging
		Busy Lamp Field (BLF)	WHCBusyLampField(BLF)
		Voice Recording	WHCVoiceRecording
	Collaboration with Cisco Webex Max 1 Min 0 from group	Softphone	WHCWebexSoftphone
		Basic	WHCWebexBasic
		Standard	WHCWebexStandard
		Premium	WHCWebexPremium
	Unity Contact Centre Max 1 Min 0 from group	Call Centre Agent	WHCCallCentreAgent
		Call Centre Supervisor	WHCCallCentreSupervisor
		Contact Centre Agent	WHCContactCentreAgent
		Contact Centre Supervisor	WHCContactCentreSupervisor
WHCFunctionaluser	Call Center ACD add-ons Max 2 Min 0 from group	Call Centre Agent	WHCCallCentreAgent
		Call Centre Supervisor	WHCCallCentreSupervisor
	CRM add-ons Max 2 Min 0 from group	GoIntegrator DB (CRMConnect)	WHCGoIntegratorDB(CRMConnect)
		GoIntegrator DB Lite (CRMConnect)	WHCGoIntegratorDBLite(CRMConnect)
		Go TAPI	WHCGoTAPI
	Reception Console add-ons Max 1 Min 0 from group	Reception Console - Enterprise	WHCReceptionConsole-Enterprise
		Reception Console - Small Business	WHCReceptionConsole-SmallBusiness
	General add-ons Min 0 from group. Voice Recording can be added only if Voice Recording enabled at Site.	Voicemail	WHCVoicemail
		Voice Recording	WHCVoiceRecording
	Collaboration with Cisco Webex Max 1 Min 0 from group	Softphone	WHCWebexSoftphone
		Basic	WHCWebexBasic
		Standard	WHCWebexStandard
		Premium	WHCWebexPremium
	Unity Contact Centre Max 1 Min 0 from group	Call Centre Agent	WHCCallCentreAgent
		Call Centre Supervisor	WHCCallCentreSupervisor
		Contact Centre Agent	WHCContactCentreAgent
		Contact Centre Supervisor	WHCContactCentreSupervisor
WHCMobileuser	Call Center ACD add-ons Max 2 Min 0 from group	Call Centre Agent	WHCCallCentreAgent
		Call Centre Supervisor	WHCCallCentreSupervisor
	CRM add-ons Max 2 Min 0 from group	GoIntegrator DB (CRMConnect)	WHCGoIntegratorDB(CRMConnect)
		GoIntegrator DB Lite (CRMConnect)	WHCGoIntegratorDBLite(CRMConnect)
		Go TAPI	WHCGoTAPI
	Reception Console add-ons Max 1 Min 0 from group	Reception Console - Enterprise	WHCReceptionConsole-Enterprise
		Reception Console - Small Business	WHCReceptionConsole-SmallBusiness
	General add-ons Min 0 from group. Voice Recording can be added only if Voice Recording enabled at Site.	Fax Messaging	WHCFaxMessaging
		Busy Lamp Field (BLF)	WHCBusyLampField(BLF)
		Voice Recording	WHCVoiceRecording
	Collaboration with Cisco Webex Max 1 Min 0 from group	Softphone	WHCWebexSoftphone
		Basic	WHCWebexBasic
		Standard	WHCWebexStandard
		Premium	WHCWebexPremium
	Unity Contact Centre Max 1 Min 0 from group	Call Centre Agent	WHCCallCentreAgent
		Call Centre Supervisor	WHCCallCentreSupervisor
		Contact Centre Agent	WHCContactCentreAgent
		Contact Centre Supervisor	WHCContactCentreSupervisor
WHCSIPTFunctionalUser	Call Center ACD add-ons Max 2 Min 0 from group	Call Centre Agent	WHCCallCentreAgent
		Call Centre Supervisor	WHCCallCentreSupervisor
	CRM add-ons Max 2 Min 0 from group	GoIntegrator DB (CRMConnect)	WHCGoIntegratorDB(CRMConnect)
		GoIntegrator DB Lite (CRMConnect)	WHCGoIntegratorDBLite(CRMConnect)
		Go TAPI	WHCGoTAPI
	General add-ons Min 0 from group. Voice Recording can be added only if Voice Recording enabled at Site.	Voicemail	WHCVoicemail
		Voice Recording	WHCVoiceRecording
	Collaboration with Cisco Webex Max 1 Min 0 from group	Softphone	WHCWebexSoftphone
		Basic	WHCWebexBasic
		Standard	WHCWebexStandard
		Premium	WHCWebexPremium
	Unity Contact Centre Max 1 Min 0 from group	Call Centre Agent	WHCCallCentreAgent
		Call Centre Supervisor	WHCCallCentreSupervisor
		Contact Centre Agent	WHCContactCentreAgent
		Contact Centre Supervisor	WHCContactCentreSupervisor
WHCSIPTFixedUser	Call Center ACD add-ons Max 2 Min 0 from group	Call Centre Agent	WHCCallCentreAgent
		Call Centre Supervisor	WHCCallCentreSupervisor
	CRM add-ons Max 2 Min 0 from group	GoIntegrator DB (CRMConnect)	WHCGoIntegratorDB(CRMConnect)
		GoIntegrator DB Lite (CRMConnect)	WHCGoIntegratorDBLite(CRMConnect)
		Go TAPI	WHCGoTAPI
	General add-ons Min 0 from group. Voice Recording can be added only if Voice Recording enabled at Site.	Fax Messaging	WHCFaxMessaging
		Voicemail	WHCVoicemail
		Voice Recording	WHCVoiceRecording
	Collaboration with Cisco Webex Max 1 Min 0 from group	Softphone	WHCWebexSoftphone
		Basic	WHCWebexBasic
		Standard	WHCWebexStandard
		Premium	WHCWebexPremium
	Unity Contact Centre Max 1 Min 0 from group	Call Centre Agent	WHCCallCentreAgent
		Call Centre Supervisor	WHCCallCentreSupervisor
		Contact Centre Agent	WHCContactCentreAgent
		Contact Centre Supervisor	WHCContactCentreSupervisor
WHCSIPTMobileUser	Call Center ACD add-ons Max 2 Min 0 from group	Call Centre Agent	WHCCallCentreAgent
		Call Centre Supervisor	WHCCallCentreSupervisor
	CRM add-ons Max 2 Min 0 from group	GoIntegrator DB (CRMConnect)	WHCGoIntegratorDB(CRMConnect)
		GoIntegrator DB Lite (CRMConnect)	WHCGoIntegratorDBLite(CRMConnect)
		Go TAPI	WHCGoTAPI
	General add-ons Min 0 from group. Voice Recording can be added only if Voice Recording enabled at Site.	Fax Messaging	WHCFaxMessaging
		Voicemail	WHCVoicemail
		Voice Recording	WHCVoiceRecording
	Collaboration with Cisco Webex Max 1 Min 0 from group	Softphone	WHCWebexSoftphone
		Basic	WHCWebexBasic
		Standard	WHCWebexStandard
		Premium	WHCWebexPremium
	Unity Contact Centre Max 1 Min 0 from group	Call Centre Agent	WHCCallCentreAgent
		Call Centre Supervisor	WHCCallCentreSupervisor
		Contact Centre Agent	WHCContactCentreAgent
		Contact Centre Supervisor	WHCContactCentreSupervisor

 

IP Phones

Child product of WHCUser. IP Phone is mandatory product and either of IP Phone or Use own device must be selected if User is added. List of available IP Phones and Use own devices are mentioned below.
IP Phone Display Name - Online Journey	IP Phone Alias Name - API Journey	deviceType
Polycom 8300	WHCPolycomTrio8300	Polycom Trio 8300
Polycom CCX500	WHCPolycomCCX500	Poly CCX 500 VDM
Polycom CCX600	WHCPolycomCCX600	Poly CCX 600 VDM
Polycom CCX700	WHCPolycomCCX700	Poly CCX 700 VDM
Polycom VVX 250	WHCPolycomVVX250	Polycom VVX 250 VDM
Polycom VVX 450	WHCPolycomVVX450	Polycom VVX 450 VDM
Yealink T31G	WHCYealinkT31G	Yealink T31G VDM
Yealink T43U	WHCYealinkT43U	Yealink T43U VDM
Yealink T46U	WHCYealinkT46U	Yealink T46U VDM
Yealink T48U	WHCYealinkT48U	Yealink T48U VDM
Yealink T53	WHCYealinkT53	Yealink T53 VDM
Yealink T53W	WHCYealinkT53W	Yealink T53W VDM
Yealink T54W	WHCYealinkT54W	Yealink T54W VDM
Yealink T57W	WHCYealinkT57W	Yealink T57W VDM
AudioCodes Mediant 500Li MSBR	AudioCodesMediant500LiMSBR	AudioCodes Mediant 500Li MSBR FXS
Cisco ATA 191	CiscoATA191	Cisco ATA 191
Cisco ATA 192	CiscoATA192	Cisco ATA 192
Yealink CP925	WHCYealinkCP925	Yealink CP925
Yealink CP965	WHCYealinkCP965	Yealink CP965
Yealink T58W	WHCYealinkT58W	Yealink T58W VDM
Yealink W70B	WHCYealinkW70B	Yealink W70
Yealink W73P	WHCYealinkW73P	Yealink W70
Yealink W80DM	WHCYealinkW80DM	Yealink W80B
Use own device	WHCUseowndevice

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
This attribute doesn't exist in Business Zone	deviceType	Yealink T46U VDM				Mandatory	Select from above list of IPphones.

 

Use own device characteristics:

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
Device to be used	deviceType	Cisco SPA-501G				Mandatory	Select from below list of use own devices.
MAC address	macAddress	0123456789AB			This should be 12 characters long and contain letters (a-f or A-F) and numbers only. Please do not enter any colons, full stops or spaces. For example: 0123456789ab or 0123456789AB not 0123.4567.89ab or 01:23:45:67:89:AB	Mandatory	Please enter the valid MAC Address. Please note MAC Address not required for below three device types:   Webex Desktop   Webex Tablet   Webex Mobile

 

Use own devices - Online Journey Display name	Use own devices - API Journey Alias name
Cisco SPA 501G	Cisco SPA-501G
Cisco SPA 502G	Cisco SPA-502G
Cisco SPA 504G	Cisco SPA-504G
Cisco SPA 508G	Cisco SPA-508G
Cisco SPA 509G	Cisco SPA-509G
Cisco SPA 512G	Cisco SPA-512G
Cisco SPA 514G	Cisco SPA-514G
Cisco SPA 525G	Cisco SPA-525
Panasonic KX-TGP500	Panasonic KX-TGP500
Polycom IP 331	Polycom Soundpoint IP 331 S
Polycom IP 335	Polycom Soundpoint IP 335 S
Polycom IP 450	Polycom Soundpoint IP 450 S
Polycom IP 5000	Polycom Soundstation IP 5000 S
Polycom IP 6000	Polycom Soundstation IP 6000 S
Polycom IP 650	Polycom Soundpoint IP 650 S
Polycom IP 7000	Polycom Soundstation IP 7000 S
Cisco SPA 112	Cisco SPA-112
Cisco SPA 122	Cisco SPA-122
2N IP Intercom	2N IP Intercom
Yealink T48G	Yealink T48G
Yealink T48S	Yealink T48S VDM
Yealink W52P	Yealink W52P
Yealink W60	Yealink W60
Polycom Trio 8800	Polycom Trio 8800
Polycom VVX 1500	Polycom VVX 1500
Polycom Trio 8500	Polycom Trio 8500
Polycom VVX 201	Polycom VVX 201
Polycom VVX 300	Polycom VVX 300 310
Polycom VVX 301	Polycom VVX 301
Polycom VVX 310	Polycom VVX 300 310
Polycom VVX 400	Polycom VVX 400 410
Polycom VVX 410	Polycom VVX 400 410
Polycom VVX 411	Polycom VVX 411
Polycom VVX 500	Polycom VVX 500
Polycom VVX 600	Polycom VVX 600
Polycom VVX 601	Polycom VVX 601
Yealink C860 LARGE Conference Room Phone	Yealink CP860
Yealink CP920 LARGE Conference Room Phone	Yealink CP920
Yealink T40G	Yealink T40G
Yealink T40P	Yealink T40P
Yealink T41P	Yealink T41P
Yealink T42G	Yealink T42G
Yealink T42S	Yealink T42S VDM
Yealink T46G	Yealink T46G
Yealink T46S	Yealink T46S VDM
Algo 8180 G2	Algo 8180 G2
Polycom IP 321	Polycom Soundpoint IP 321 S
Yealink T23	Yealink T23
Yealink W80B	Yealink W80B
Polycom VVX 150	Polycom VVX 150 VDM
Polycom VVX 250	Polycom VVX 250 VDM
Polycom VVX 450	Polycom VVX 450 VDM
Cisco ATA 191	Cisco ATA 191
Cisco ATA 192	Cisco ATA 192
Yealink T53	Yealink T53 VDM
Yealink T53W	Yealink T53W VDM
Yealink T54W	Yealink T54W VDM
Yealink T57W	Yealink T57W VDM
Polycom CCX500	Poly CCX 500 VDM
Polycom CCX600	Poly CCX 600 VDM
Polycom CCX700	Poly CCX 700 VDM
Polycom 8300	Polycom Trio 8300
Yealink T31G	Yealink T31G VDM
Yealink T43U	Yealink T43U VDM
Yealink T46U	Yealink T46U VDM
Yealink T48U	Yealink T48U VDM
Yealink W53P	Yealink W60
Yealink CP960	Yealink CP960
Webex Desktop	Business Communicator - PC
Webex Tablet	Connect - Tablet
Webex Mobile	Connect - Mobile
Yealink CP925	Yealink CP925
Yealink CP965	Yealink CP965
Yealink T58W	Yealink T58W VDM
Yealink W70B	Yealink W70
Yealink W73P	Yealink W70P
AudioCodes Mediant 500Li MSBR	AudioCodes Mediant 500Li MSBR FXS

 

Headsets

Child product of WHCUser, these are optional products.
Headsets Display Name - Online Journey	Headsets Alias Name - API Journey
Jabra BIZ 2300 - Duo NC/Phone	WHCJabraBIZ2300-DuoNC/Phone
Jabra BIZ 2300 - Duo NC/USB	WHCJabraBIZ2300-DuoNC/USB
Jabra BIZ 2300 - Mono NC/Phone	WHCJabraBIZ2300-MonoNC/Phone
Jabra BIZ 2300 - Mono NC/USB	WHCJabraBIZ2300-MonoNC/USB
Jabra Motion UC MS Plus	WHCJabraMotionUCMSPlus
Jabra PRO 920 - Duo for Polycom	WHCJabraPRO920-DuoforPolycom
Jabra PRO 920 - Duo for Yealink	WHCJabraPRO920-DuoforYealink
Jabra PRO 920 - Mono for Polycom	WHCJabraPRO920-MonoforPolycom
Jabra PRO 920 - Mono for Yealink	WHCJabraPRO920-MonoforYealink
Jabra Pro930 Duo	WHCJabraPro930Duo
Plantronics CS540 Mono - Poly	WHCPlantronicsCS540MonoPoly
Plantronics CS540 Mono - Yealink	WHCPlantronicsCS540MonoYealink
Plantronics HW510 Mono - Poly	WHCPlantronicsHW510MonoPoly
Plantronics HW510 Mono - Yealink	WHCPlantronicsHW510MonoYealink
Plantronics HW520 Duo - Poly	WHCPlantronicsHW520DuoPoly
Plantronics HW520 Duo - Yealink	WHCPlantronicsHW520DuoYealink
Plantronics Savi 7220 Duo - Poly	WHCPlantronicsSavi7220DuoPoly
Plantronics Savi 7220 Duo - Yealink	WHCPlantronicsSavi7220DuoYealink
Plantronics Savi W8220 USB Duo - USB	WHCPlantronicsSaviW8220USBDuoUSB
Plantronics Savi W8240 USB Mono - USB	WHCPlantronicsSaviW8240USBMonoUSB
Plantronics W8220 Duo - Poly	WHCPlantronicsW8220DuoPoly
Plantronics W8220 Duo - Yealink	WHCPlantronicsW8220DuoYealink
Plantronics W8240 Mono - Poly	WHCPlantronicsW8240MonoPoly
Plantronics W8240 Mono - Yealink	WHCPlantronicsW8240MonoYealink

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
Quantity	quantity	1			Number	Mandatory	Please ensure total headsets count doesn't exceed 8 per user

 

Accessories

Child product of WHCUser, these are optional products.
Accessories Display Name - Online Journey	Accessories Alias Name-API Journey
Jabra SPEAK 510	JabraSPEAK510
Polycom PSU for CCX500 CCX600 CCX700	PolycomPSUforCCX500CCX600CCX700
Polycom Trio 8300 Power Kit	PolycomTrio8300PowerKit
Polycom VVX EM 50 Sidecar	PolycomVVXEM50Sidecar
Polycom VVX PSU	PolycomVVXPSU
Polycom VVX wifi Dongle	PolycomVVXwifiDongle
Yealink Bluetooth Adaptor	YealinkBluetoothAdaptor
Yealink CP700 Speaker	YealinkCP700Speaker
Yealink CP900 Speaker	YealinkCP900Speaker
Yealink DD10K DECK	YealinkDD10KDECK
Yealink WF50	YealinkWF50
Yealink W59R	YealinkW59R
Yealink T4U EHS40	YealinkT4UEHS40
Yealink RT30 DECT Repeater	YealinkRT30DECTRepeater
Yealink UVC40	YealinkUVC40
Yealink EXP43	YealinkEXP43
Yealink EXP50	YealinkEXP50
Yealink EXP UVC30	YealinkEXPUVC30
Polycom Calisto 5300	PolycomCalisto5300
Yealink CAM50	YealinkCAM50
Yealink 10W PSU	Yealink10WPSU
Yealink W73H	YealinkW73H
Yealink W80B	YealinkW80B

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
Quantity	quantity	1			Number	Mandatory	This is the number of units you want to purchase of this item. Can have up to 99 units of this item per user.

 

Trunking User

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
Trunking User	WHCTrunkingUser	Network Child product of WHCSite. This is an optional product and can be added against SIPT and Mixed Site only

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
999 Display Name	ESDBUserDisplayName	Test			1 to 50 characters and can use letters, numbers and spaces	Optional	Enter 999 Display Name for the User
Extension	extension	3232				Mandatory
Telphone Number	telephoneNumber	0123213232				Mandatory	Provide phone number from list of available site numbers.
User location	UserTypeLocation	ONSITE	Onsite Remote	ONSITE OFFSITE		Mandatory	If Onsite - ONSITE Remote - OFFSITE
This attribute doesn't exist in Business Zone	userType	Business Trunking User				Mandatory	Default value as 'Business Trunking User'.

 

Trunk Device

Product Display Name on Business Zone	Product Alias Name - API Journey	Comments
This product is default product in online journey	WHCTrunkDevice	Child product of WHCUser (only with SIPT User license) and WHCTrunkingUser. This is a mandatory product if WHCUser (only with SIPT User license) or WHCTrunkingUser is added.

 

Business Zone Attribute Name	API Journey Attribute Name	Sample value	Business Zone Attribute Allowed Value	API Journey Attribute Allowed Value	Format/Regex	Mandatory/Optional	Comments
This attribute doesn't exist in Business Zone	deviceType	Trunk A			1 to 30 characters and use letters, numbers and spaces.	Mandatory	This value should be same as 'trunkName' of associated WHCTrunk(s) product.