Bulk import XML for users with SIP phone

Last Updated : Mar 07, 2025 |

To create a user XML, first perform the procedure for bulk importing users in the Bulk importing users section. If communication address is added to the user, then the commPassword field is mandatory.

To assign communication address, the mapping of Communication Profile for a new SIP user is as follows:

Table 1: Mapping of Communication Profile for a new SIP user

UI field

Description

XML tag

Possible value

Name

Specifies the name of the communication profile.

 
<commProfileSetName>
... 
</commProfileSetName>

The unique name of this communication profile.

Default

Indicates whether this is a default profile.

 
<isPrimary>
... 
</isPrimary>

True or False.

The attributes to set up the communication address for a user are as follows:

Table 2: User attributes to set up communication address

UI field

Description

XML tag

Possible value

Handle

Specifies the extension number of the user.

 
<handleName>
... 
</handleName>

Extension number.

Type

Specifies the communication type of the user profile.

 
<handleType>
... 
</handleType>

Communication type. For example, sip and smtp.

SubType

Specifies the communication subtype of the user profile.

 
<handleSubType>
... 
</handleSubType>

Communication sub type. For example, username, e164, and msrtc.

Domain

Specifies the domain name of the user.

 
<domainName>
... 
</domainName>

Name of the configured SIP domain name.

The following is the mapping of Session Manager Communication profile elements with the corresponding user interface fields.

Table 3: Mapping of Session Manager Communication Profile elements

UI field

Description

XML tag

Possible value

Policy

When you enable the Enable Policy Based Assignment of Session Managers field on the Elements > Session Manager > Global Settings page, you can specify the required policy for the Session Manager communication profile.

The options are:

  • fixed:

    When you specify this option, provide the values for the Primary Session Manager, Secondary Session Manager, Third Session Manager, and Fourth Session Manager fields.

    The default value is fixed.

  • fixed-region:

    When you specify this option, provide the values to the Primary Region, Secondary Region, Third Region, and Fourth Region fields.

    The system assigns the primary, secondary, third, or fourth region to the Session Manager Communication profile.

  • location-region: When you specify this option, the system performs the dynamic assignment of Session Manager based on the mapping of locations to regions on the Elements > Session Manager > Session Manager Administration > Groups > Location to Region Mapping page.

Note:

If the Enable Policy Based Assignment of Session Managers field on the Elements > Session Manager > Global Settings page is not enabled, specify the Primary Session Manager and Secondary Session Manager fields similar to the Release 8.1.x and earlier system.

 
<sm:policyType>
... 
</sm:policyType>

  • fixed

  • fixed-region

  • location-region

Primary Session Manager

Specifies the name of the primary Session Manager instance used as the home server for a communication profile.

 
<sm:primarySM>
... 
</sm:primarySM>

Enter the name of Session Manager.

Secondary Session Manager

Specifies the name of the secondary Session Manager instance used to provide continued service to SIP devices associated with this communication profile when the primary Session Manager is unavailable.

 
<sm:secondarySM>
... 
</sm:secondarySM>

Enter the name of Session Manager.

Third Session Manager

Specifies the name of the third Session Manager instance used to provide continued service to SIP devices associated with this communication profile when the primary or the secondary Session Manager server becomes unavailable.

 
<sm:thirdSM>
... 
</sm:thirdSM>

Enter the name of Session Manager.

Fourth Session Manager

Specifies the name of the fourth Session Manager instance used to provide continued service to SIP devices associated with this communication profile when the primary, secondary, or third Session Manager server becomes unavailable.

 
<sm:fourthSM>
... 
</sm:fourthSM>

Enter the name of Session Manager.

Primary Region

When you specify the fixed-region policy type, this field indicates the primary region of the Session Manager server.

 
<sm:primaryFixedRegion>
... 
</sm:primaryFixedRegion>

Enter the name of region.

Secondary Region

When you specify the fixed-region policy type, this field indicates the secondary region of the Session Manager server.

 
<sm:secondaryFixedRegion>
... 
</sm:secondaryFixedRegion>

Enter the name of region.

Third Region

When you specify the fixed-region policy type, this field indicates the third region of the Session Manager server.

 
<sm:thirdFixedRegion>
... 
</sm:thirdFixedRegion>

Enter the name of region.

Fourth Region

When you specify the fixed-region policy type, this field indicates the fourth region of the Session Manager server.

 
<sm:fourthFixedRegion>
... 
</sm:fourthFixedRegion>

Enter the name of region.

Origination Application Sequence

Specifies the Application Sequence that is invoked when calls are routed from this user.

 
<sm:originationAppSequence>
... 
</sm:originationAppSequence>

True or False.

Termination Application Sequence

Specifies the Application Sequence that is invoked when calls are routed to this user.

 
<sm:terminationAppSequence>
... 
</sm:terminationAppSequence>

Emergency Origination Application Sequence

Specifies the emergency application sequence that is invoked when calls are routed from this user.

 
<sm:emergencyOriginationAppSequence>
... 
</sm:emergencyOriginationAppSequence>

Emergency Termination Application Sequence

Specifies the emergency application sequence that is invoked when calls are routed to this user.

 
<sm:emergencyTerminationAppSequencee>
... 
</sm:emergencyTerminationAppSequence>

Survivability Server

Specifies a survivability server to provide survivability communication services for devices associated with a communication profile when the local connectivity to Session Manager instances in Avaya is lost.

 
<sm:survivabilityServer>
... 
</sm:survivabilityServer>

The name of a Branch Session Manager, but can be any non-CM SIP Entity.

Max. Simultaneous Devices

Specifies the maximum number of endpoints that you can register at a time by using this communication profile. If you register more than one endpoint, all the endpoints receive calls simultaneously.

 
<sm:maxSimultaneousDevices>
... 
</sm:maxSimultaneousDevices>

The value is an integer between 1 and 10. The default value is 1.

Block New Registration When Maximum Registrations Active

If you set to true and if an endpoint tries to register using this communication profile when the maximum number of allowed simultaneous registrations reaches, the endpoint cannot register with Session Manager The endpoint does not have the SIP service.

 
<sm:blockNewRegistrationWhenMaxActive>
... 
</sm:blockNewRegistrationWhenMaxActive>

true or false

The default value is false.

Home Location

Specifies the routing home location.

 
<sm:homeLocation>
... 
</sm:homeLocation>

The name of the Home Location.

Conference Factory Set

Specifies the conference factory set to enable media capability-based call routing to the Conferencing SIP entities.

 
<sm:confFactorySet>
... 
</sm:confFactorySet>

The name of the conference factory set.

Enable Centralized Call History

Specifies the option to enable the call history feature for SIP users.

 
<sm:enabledisablecalllog>
... 
</sm:enabledisablecalllog>

enable or disable

Enable Client

Specifies the drop-down list of supported third party clients.

 
<sm:thirdPartyClient>
... 
</sm:thirdPartyClient>

ZOOM, Avaya Cloud Office Hybrid or blank

The following is the mapping of CM Endpoint Profile elements with the corresponding user interface fields.

Table 4: Mapping of CM Endpoint Profile elements

UI field

Description

XML tag

Possible value

System

Specifies the SIP Entity of the Communication Manager.

 
<ipt:cmName>
... 
</ipt:cmName>

Name of the configured Communication Manager.

Use Existing

Indicates whether the station is already defined in the system.

 
<ipt:useExistingExtension>
... 
</ipt:useExistingExtension>

True or False.

Extension

Specifies the extension number for this profile.

 
<ipt:extension>
... 
</ipt:extension>

Template

Specifies the template name used for creating the station.

 
<ipt:template>
... 
</ipt:template>

Set Type

Specifies the set type of the station.

 
<ipt:setType>
... 
</ipt:setType>

Port

Specifies the port number from the list for the template you select.

 
<ipt:port>
... 
</ipt:port>