Summary
This article describes the certified specifications and actions supported for Metaswitch. Provisioning currently supports a subset of the Metaswitch provisioning capabilities.
Specifications
Provider: Metaswitch
Link: https://www.metaswitch.com/
Application Interface: MetaView Service
Application Version: 9.5 – 7.4
IDI Platform Metaswitch Provider Version: 1.15
IDI Platform Bundle Version: 25.4
Certified Platforms:
- MetaSphere CFS
- MetaSphere EAS
Overview
The section below will highlight how Provisioning interacts with the Metaswitch APIs. As well as some helpful advice and guidelines.
- The use of Persistent Profiles is required for Metaswitch provisioning. Provisioning will not update properties that can be set by the persistent profile.
- The system has a list of provisioning actions. Some actions can be fulfilled in one API call, while others may require multiple API calls to perform the action.
- In most cases, Metaswitch expects a string or text values as the valid input for a parameter, instead of using database ids. For example, if the persistent profile is labeled “IDI Premium” in MetaView, the API will expect “IDI Premium” as the correct value.
- Parameters will only display as required if they’re required for every call. Some fields may be conditionally required. Based on the enablement of a preceding parameter, the subsequent parameter is now required. Conditionally required parameters will not display as required on the Provisioning profile pages but will be identified in the Action Details section. If a required value is not populated on the action, provisioning will error the request, before sending it to the endpoint, and state that it’s a required field.
Available Actions:
The current actions supported for Metaswitch include:
| Provider | Action | Available |
| Metaswitch | Add Business Group Line (Deprecated) | 21.2 |
| Metaswitch | Add Managed Device – Business Group | 21.2 |
| Metaswitch | Add Managed Device – Individual | 21.2 |
| Metaswitch | Add Number Block | 21.2 |
| Metaswitch | Create Business Group (Deprecated) | 21.2 |
| Metaswitch | Create Individual Line (Deprecated) | 21.2 |
| Metaswitch | Set Subscriber Status | 21.2 |
| Metaswitch | Set Suspend Value | 21.2 |
| Metaswitch | Update Additional Features | 21.2 |
| Metaswitch | Update Customer Information | 21.2 |
| Metaswitch | Update Business Group Line | 23.2 |
| Metaswitch | Update Individual Line (Deprecated) | 23.2 |
| Metaswitch | Delete Business Group Line | 23.2 |
| Metaswitch | Delete Individual Line | 23.2 |
| Metaswitch | Update Line Class Codes – Subscriber | 23.3 |
| Metaswitch | Add/Update Individual Line | 23.4 |
| Metaswitch | Add/Update Business Group | 23.5 |
| Metaswitch | Add/Update Business Group Line | 23.5 |
Add Business Group Line (DEPRECATED)
Note: As of the 23.5 release, IDI recommends using the Add/Update Business Group Line (Link) action instead of the Add Business Group Line action. Going forward, all new parameters will be added to the Add/Update Business Group action.
This action adds a line to a Business Group. One action exists in provisioning; however, multiple API calls may be sent based on the chosen parameters. Example calls:
- Add a line to a business group
- Build EAS line
- Associate EAS line to Business Group
Two options are available for password fields:
- Enter your own password in the Password parameter.
- Have the system generate a random password using the Password Seed parameter.
The password seed will be used to randomly generate a password. IDI recommends using an object that will be variable on each service or order, for example, internal object id or account number. If using in combination with Calix, use the same password seed in Metaswitch as you do in Calix.
Parameters:
* Field is conditionally required. Values selected in preceding fields may change the field from optional to required.
Add Managed Device – Business Group
This action adds a managed device to a Business Group.
Parameters:
| Name | Type | Required* | Notes |
| Connection Information | |||
| Address | String | Required | URL of the Metaswitch Web Service |
| Username | String | Required | Username to login |
| Password | String | Required | Password to login |
| Client Version | String | Required | Metaswitch Version |
| General Information | |||
| Business Group Name | String | Required | |
| Network Element | String | Required | Use CFS Name |
| Metaswitch Name | String | Required | Use CFS Name |
| Device | |||
| MAC Address | String | Required | |
| Description | String | Required | Description of Device |
| Assign To User | Boolean | Required | Yes or No |
| User Service Number | String | Optional* | Required if Assign to User is Yes. Use Internal Object ID. |
| Authenticate Until | Date/Time | Optional | Avoid using a time of 12:00 AM. Errors on Metaswitch API |
* Field is conditionally required. Values selected in preceding fields may change the field from optional to required.
Add Managed Device – Individual
This action adds a managed device to an individual line.
Parameters:
| Name | Type | Required | Notes |
| Connection Information | |||
| Address | String | Required | URL of the Metaswitch Web Service |
| Username | String | Required | Username to login |
| Password | String | Required | Password to login |
| Client Version | String | Required | Metaswitch Version |
| General Information | |||
| Service Number | String | Required | Use Internal Object ID |
| Network Element | String | Required | Use CFS Name |
| Metaswitch Name | String | Required | Use CFS Name |
| Device | |||
| MAC Address | String | Required | |
| Description | String | Required | Description of Device |
| Assign To User | Boolean | Required | Yes or No |
| Authenticate Until | Date/Time | Optional | Avoid using a time of 12:00 AM. Errors on Metaswitch API |
Add Number Block
This action adds a number block to the Business Group. The system will create one Business Group Number Block for each service number.
Parameters:
| Name | Type | Required | Notes |
| Connection Information | |||
| Address | String | Required | URL of the Metaswitch Web Service |
| Username | String | Required | Username to login |
| Password | String | Required | Password to login |
| Client Version | String | Required | Metaswitch Version |
| General Information | |||
| Network Element | String | Required | Use CFS Name |
| Metaswitch Name | String | Required | Use CFS Name |
| Business Group Name | String | Required | |
| Metaview User Identity | String | Required | |
| Service Number | String | Required | Use Internal Object ID |
| Subscriber Group | String | Required | Default value or Create a custom list |
Create Business Group (Deprecated)
Note: As of the 23.5 release, IDI recommends using the Add/Update Business Group (Link) action instead of the Create Business Group action. Going forward, all new parameters will be added to the Add/Update Business Group action. The new action lets you configure a single profile for both add and update provisioning actions.
This action creates a Business Group.
One action exists in provisioning; however, multiple API calls may be sent based on the chosen parameters. Example calls:
- Create the Business Group
- Add Call Pickup
- Add Call Pickup No Barge In
- Create EAS Group
It is recommended to create a new IDI platform service type for the business group, although not required. Use the service number as the business group name. The service number character length is 30. Advantages of adding business groups as a service number are:
- The business group name will be searchable in Customer Care.
- The duplicate service number check ensures you don’t have multiple business groups with the same name.
Parameters:
| Name | Type | Required | Notes |
| Connection Information | |||
| Address | String | Required | URL of the Metaswitch Web Service |
| Username | String | Required | Username to login |
| Password | String | Required | Password to login |
| Client Version | String | Required | Metaswitch Version |
| General Information | |||
| Business Group Name | String | Required | |
| Network Element | String | Required | Use CFS Name |
| Metaswitch Name | String | Required | Use CFS Name |
| Persistent Profile | String | Required | Default value or create a custom list |
| Account Information | |||
| Long Distance Carrier | String | Optional | |
| Intra LATA Carrier | String | Optional | |
| International Carrier | String | Optional | |
| Business Group Features | |||
| Call Pickup Subscribed | Boolean | Required | |
| Call Pickup No-Barge in Subscribed | Boolean | Required | |
| Distinctive Alerting | Select List | Optional | |
| Traffic Study | Boolean | Optional |
Create Individual Line (Deprecated)
Note: As of the 23.4 release, IDI recommends using the Add/Update Individual Line (Link) action instead of the Create Individual Line action. Going forward, all new parameters will be added to the Add/Update Individual line action. The new action lets you configure a single profile for both add and update provisioning actions.
This action creates a new individual line. Two options are available for Password fields:
- Enter your own password in the Password parameter.
- Have the system generate a random password using the Password Seed parameter.
The password seed will be used to randomly generate a password. It is recommended to use an object that will be variable on each service or order, for example, internal object id or account number. If using in combination with Calix, use the same password seed in Metaswitch as you do in Calix.
Parameters:
| Name | Type | Required* | Notes |
| Connection Information | |||
| Address | String | Required | URL of the Metaswitch Web Service |
| Username | String | Required | Username to login |
| Password | String | Required | Password to login |
| Client Version | String | Required | Metaswitch Version |
| General Information | |||
| Network Element | String | Required | Use CFS Name |
| Metaswitch Name | String | Required | Use CFS Name |
| Persistent Profile | String | Required | |
| Subscriber Group | String | Required | |
| Service Number | String | Required | Use Internal Object ID |
| Account Information | |||
| Long Distance Carrier | String | Optional | |
| Intra LATA Carrier | String | Optional | |
| International Carrier | String | Optional | |
| Service Information | |||
| Number Status | Select List | Required | |
| PIN | Number | Required | |
| Signaling Type | Select List | Required | |
| Call Agent Signaling Type | Select List | Optional | |
| Charge Number | String | Optional | |
| Use Static NAT Mapping | Boolean | Optional | |
| Calling Party Number | String | Optional | |
| Use Service Number for Identification | Boolean | Required | If Yes, will use the value in the Service Number field for Identification |
| SIP Information | |||
| SIP Domain Name | String | Required | |
| SIP Username | String | Optional* | Required if Use Service Number for Identification = No |
| SIP Authentication Required | Boolean | Required | Yes or No |
| SIP Password | String | Optional* | Required if Generate Password = No |
| Generate Password | Boolean | Optional | Yes or No. If no, populate the password field. If yes, populate the password seed field |
| Password Seed | String | Optional | Required if Generate Password = Yes. |
| EAS Information | |||
| Configure EAS Line | Boolean | Optional | Yes or No |
| Display Name | String | Optional* | Required if Configure EAS Line = Yes. |
| Surname | String | Optional* | Required if Configure EAS Line = Yes. Last Name |
| EAS Customer Group | String | Optional* | Required if Configure EAS Line = Yes. |
| Device Type | String | Optional* | Required if Configure EAS Line = Yes. Cellular or Landline |
| CoS ID | String | Optional* | Required if Configure EAS Line = Yes. EAS Class of Service |
| EAS PIN | String | Optional* | Required if Configure EAS Line = Yes. |
| EAS Generate Password | Boolean | Optional | Yes or No. If no, populate the password field. If yes, populate the password seed field |
| EAS Password Seed | String | Optional* | Required if EAS Generate Password = Yes |
| EAS Password | String | Optional* | Required if EAS Generate Password = No |
| Given Name | String | Optional | |
| Email Address | String | Optional | |
| Disable | Boolean | Optional | |
| Disable for Migration | Boolean | Optional | |
| Account Email | String | Optional | |
| Allow Email Login | Boolean | Optional |
* Field is conditionally required. Values selected in preceding fields may change the field from optional to required.
Set Subscriber Status
This action updates the status of a service number and let you add a note. This is used to enable or disable the service number.
Parameters:
| Name | Type | Required | Notes |
| Connection Information | |||
| Address | String | Required | URL of the Metaswitch Web Service |
| Username | String | Required | Username to login |
| Password | String | Required | Password to login |
| Client Version | String | Required | Metaswitch Version |
| Service Number | String | Required | User Internal Object ID |
| Subscriber Status | List | Required | Choose Enabled or Disabled |
| Customer Note | String | Optional | Updates CFS Customer Info field |
Set Suspend Value
This action updates the CFS Service Suspend value and lets you add a note. Update the CFS Service Suspend field to one of the following options:
- None
- Incoming Calls
- Incoming and Outgoing Calls
- Outgoing Calls
Parameters:
| Name | Type | Required | Notes |
| Connection Information | |||
| Address | String | Required | URL of the Metaswitch Web Service |
| Username | String | Required | Username to login |
| Password | String | Required | Password to login |
| Client Version | String | Required | Metaswitch Version |
| Suspend Value | List | Required | Choose Enabled or Disabled |
| Customer Note | String | Optional | Updates CFS Customer Info field |
| General Information | |||
| Service Number | String | Required | User Internal Object ID |
| Metaview User Identity | String | Required | |
| EAS User Identity | String | Required |
Update Additional Features
This action updates specific features and their corresponding parameters for a service number.
One action exists in provisioning; however, multiple API calls may be sent based on the chosen parameters. Example calls:
- A separate API may be sent for each feature.
- The system will send an ShPull call to pull down existing values.
- The system will send an ShUpdate call to update the values.
- Some parameters may display as optional but may be required in Metaswitch based on the configuration of preceding parameters.
- For features that allow you to configure numbers Metaswitch, for example, Hunting or Call Forwarding (Selective), The IDI platform will allow you to add up to five numbers.
- With the 25.4 release, the ShPull call will retrieve all existing account codes. When processing updates, only new (non-duplicate) account codes from the input parameters will be added. These new codes will then be sent through ShUpdate, ensuring that existing account codes remain unchanged.
Parameters:
| Name | Type | Required | Notes |
| Connection Information | |||
| Address | String | Required | URL of the Metaswitch Web Service |
| Username | String | Required | Username to login |
| Password | String | Required | Password to login |
| Client Version | String | Required | Metaswitch Version |
| General Information | |||
| Metaview User Identity | String | Required | |
| Service Number | String | Required | Use Internal Object ID |
| Features | |||
| Do Not Disturb | String | Optional | Choose Do Not Set, Yes, No |
| Advanced Voice Codec | |||
| Subscribed | Boolean | Optional | Yes or No |
| Anonymous Call Rejection | |||
| Subscribed | Boolean | Optional | Yes or No |
| Enabled | Boolean | Optional | Yes or No |
| Automatic Call Back | |||
| Subscribed | Boolean | Optional | Yes or No |
| Basic Line Hunting | |||
| Subscribed | Boolean | Optional | Yes or No |
| Enabled | Boolean | Optional | Yes or No |
| Number 1 | String | Optional | |
| Number 2 | String | Optional | |
| Number 3 | String | Optional | |
| Number 4 | String | Optional | |
| Number 5 | String | Optional | |
| Business Call Manager | |||
| Subscribed | Boolean | Optional | Yes or No |
| Call Barring | |||
| Subscribed | Boolean | Optional | Yes or No |
| Subscriber Barred International | Boolean | Optional | Yes or No |
| Subscriber Barred National and Mobile | Boolean | Optional | Yes or No |
| Subscriber Barred Local | Boolean | Optional | Yes or No |
| Subscriber Barred Operator | Boolean | Optional | Yes or No |
| Subscriber Barred Access Code | Boolean | Optional | Yes or No |
| Subscriber Barred Premium | Boolean | Optional | Yes or No |
| Subscriber Barred Access Codes that Change Configuration | Boolean | Optional | Yes or No |
| Subscriber Barred Directory Assistance | Boolean | Optional | Yes or No |
| Call Transfer/3-Way Calling | |||
| 3-Way Calling Subscribed | Boolean | Optional | Yes or No |
| Call Transfer Subscribed | Boolean | Optional | Yes or No |
| 3-Way Calling/Call Transfer Billing – Conferencing – Usage Sensitive Billing | Boolean | Optional | Yes or No |
| Call Trace | |||
| Subscribed | Boolean | Optional | Yes or No |
| Usage Sensitive Billing | Boolean | Optional | Yes or No |
| Call Waiting | |||
| Subscribed | Boolean | Optional | Yes or No |
| Call Waiting with Caller ID | |||
| Subscribed | Boolean | Optional | Yes or No |
| Call ID Presentation | |||
| Subscribed | Boolean | Optional | Yes or No |
| Withhold Number by Default | Boolean | Optional | Yes or No |
| Number Withhold Rejection Reason | List | Optional | Choose Blocked, Number Unavailable |
| Calling Name | |||
| Subscribed | Boolean | Optional | |
| Enabled | Boolean | Optional | |
| Local Name | String | Optional | |
| Calling Number Delivery | |||
| Subscribed | Boolean | Optional | |
| Enabled | Boolean | Optional | |
| Preferred SIP Format | List | Optional | Choose Directory Number, SIP URI |
| Call Forwarding Settings | |||
| Maximum Simultaneous Forwardings | Integer | Optional | |
| Number Released to Diverted-to User | Boolean | Optional | Yes or No |
| Diverted-to Number Released to Caller | Boolean | Optional | Yes or No |
| Call Forwarding (Unconditional) | |||
| Subscribed | Boolean | Optional | |
| Variant | List | Optional | Choose Variable, Fixed Number |
| Enabled | Boolean | Optional | |
| Number | String | Optional | Required in Metaswitch when Enabled = Yes |
| Ringsplash | Boolean | Optional | Yes or No |
| Call Forwarding (On Busy) | |||
| Subscribed | Boolean | Optional | Yes or No |
| Variant | List | Optional | Choose Variable, Fixed Number |
| Enabled | Boolean | Optional | Yes or No |
| Number | String | Optional | Required in Metaswitch when Enabled = Yes |
| Call Forwarding (Delayed) | |||
| Subscribed | Boolean | Optional | Yes or No |
| Variant | List | Optional | Choose Variable, Fixed Number |
| Enabled | Boolean | Optional | |
| Number | String | Optional | Required in Metaswitch when Enabled = Yes |
| No Reply Time | Integer | Optional | |
| Call Forwarding (Selective) | |||
| Subscribed | Boolean | Optional | Yes or No |
| Enabled | Boolean | Optional | Yes or No |
| Number to Forward to | String | Optional | Required in Metaswitch when Enabled = Yes |
| Automatically Forwarded Number 1 | String | Optional | |
| Automatically Forwarded Number 2 | String | Optional | |
| Automatically Forwarded Number 3 | String | Optional | |
| Automatically Forwarded Number 4 | String | Optional | |
| Automatically Forwarded Number 5 | String | Optional | |
| Call Forwarding (Unavailable) | |||
| Subscribed | Boolean | Optional | Yes or No |
| Enabled | Boolean | Optional | Yes or No |
| Number | String | Optional | Required in Metaswitch when Enabled = Yes |
| CFS Find Me Follow Me | |||
| Subscribed | Boolean | Optional | Yes or No |
| Service Level | List | Optional | Choose Basic (SimRing), Enhanced |
| Enabled | Boolean | Optional | Yes or No |
| Number 1 | String | Optional | |
| Number 2 | String | Optional | |
| Number 3 | String | Optional | |
| Number 4 | String | Optional | |
| Number 5 | String | Optional | |
| Last Caller ID Erasure | |||
| Subscribed | Boolean | Optional | Yes or No |
| Mandatory Account Codes | |||
| Subscribed | Boolean | Optional | Yes or No |
| Variant | List | Optional | Choose Nonvalidated, Validated |
| Call Type Local | Boolean | Optional | Yes or No |
| Call Type Operator | Boolean | Optional | Yes or No |
| Call Type Premium | Boolean | Optional | Yes or No |
| Call Type Directory | Boolean | Optional | Yes or No |
| Call Type Local Business Group | Boolean | Optional | Yes or No |
| Call Type Other Business Group | Boolean | Optional | Yes or No |
| Call Type National | Boolean | Optional | Yes or No |
| Call Type Regional | Boolean | Optional | Yes or No |
| Call Type Carrier Dialed | Boolean | Optional | Yes or No |
| Call Type International | Boolean | Optional | Yes or No |
| Inherit Codes and Code Length | Boolean | Optional | Yes or No |
| Code Length | Integer | Optional | |
| Max Incorrect Code Attempts Per Call | Integer | Optional | |
| Valid Codes | String | Optional | |
| PIN Change | |||
| Subscribed | Boolean | Optional | Yes or No |
| Priority Call | |||
| Subscribed | Boolean | Optional | Yes or No |
| Enabled | Boolean | Optional | Yes or No |
| Number 1 | String | Optional | |
| Number 2 | String | Optional | |
| Number 3 | String | Optional | |
| Number 4 | String | Optional | |
| Number 5 | String | Optional | |
| Selective Call Rejection | |||
| Subscribed | Boolean | Optional | Yes or No |
| Enabled | Boolean | Optional | Yes or No |
| Speed Calling | |||
| Subscribed | Boolean | Optional | Yes or No |
| Allowed Types | List | Optional | Choose One Digit, Two Digit, One and Two Digit |
| Handset Allowed Access | Boolean | Optional | |
| Teen Service Line | |||
| Subscribed | Boolean | Optional | Yes or No |
| Ring Pattern | List | Optional | Choose Long-Long, Short-Long-Short, Short-Short-Long, Cadence 1, Cadence 2, Cadence 3, Distinctive Ring Pattern 2, Distinctive Ring Pattern 3, Distinctive Ring Pattern 4 |
| Number Status | List | Optional | Choose Ported to, Ported from (UK Only), Recently moved, Reserved – old number, Reserved for future use, Ported out (North America only), Reserved – ported in (North America only), Non-geographic |
| Voicemail | |||
| Subscribed | Boolean | Optional | Yes or No |
| SIP Message Waiting Indicator | Boolean | Optional | Yes or No |
| Call Transfer Time | Integer | Optional |
Update Customer Information
This action updates the Customer Information field associated with the service number. The call will update Customer Info fields 1 – 6.
Parameters:
| Name | Type | Required | Notes |
| Connection Information | |||
| Address | String | Required | URL of the Metaswitch Web Service |
| Username | String | Required | Username to login |
| Password | String | Required | Password to login |
| Client Version | String | Required | Metaswitch Version |
| General Information | |||
| Metaview User Identity | String | Required | |
| EAS User Identity | String | Required | |
| Service Number | String | Required | Use Internal Object ID |
| Service Information | |||
| CFS Customer Info | String | Optional | |
| CFS Customer Info 2 | String | Optional | |
| CFS Customer Info 3 | String | Optional | |
| CFS Customer Info 4 | String | Optional | |
| CFS Customer Info 5 | String | Optional | |
| CFS Customer Info 6 | String | Optional |
Update Business Group Line
This action updates a Business Group line. One action exists in provisioning; however, multiple API calls may be sent based on the chosen parameters. Example calls:
- Update a business group line
- Update EAS line
- Associate EAS line to Business Group
Two options are available for Password fields:
- Enter your own password in the Password parameter.
- Have the system generate a random password using the Password Seed parameter.
The password seed will be used to randomly generate a password. It is recommended to uise an object that will be variable on each service or order, for example, internal object id or account number. If using in combination with Calix, use the same password seed in Metaswitch as you do in Calix.
Parameters:
| Name | Type | Required* | Notes |
| Connection Information | |||
| Address | String | Required | URL of the Metaswitch Web Service |
| Username | String | Required | Username to login |
| Password | String | Required | Password to login |
| Client Version | String | Required | Metaswitch Version |
| General Information | |||
| Service Number | String | Required | Use Internal Object ID |
| Name | String | Optional | |
| Business Group Name | String | Optional | |
| Network Element | String | Optional | Use CFS Name |
| Metaswitch Name | String | Optional | Use CFS Name |
| Persistent Profile | String | Optional | |
| Number Status | Select List | Optional | |
| Signaling Type | Select List | Optional | |
| Call Agent Signaling Type | Select List | Optional | |
| Calling Party Number | String | Optional | |
| Calling Party Number For Emergency Calls | String | Optional | |
| Charge Number | String | Optional | |
| Use Static NAT Mapping | Boolean | Optional | |
| Use Service Number for Identification | Boolean | Optional | If Yes, will use the value in the Service Number field for Identification |
| Account Information | |||
| Long Distance Carrier | String | Optional | |
| Intra LATA Carrier | String | Optional | |
| International Carrier | String | Optional | |
| EAS Information | |||
| Given Name | String | Optional | |
| Email Address | String | Optional | |
| Disable | Boolean | Optional | |
| Disable for Migration | Boolean | Optional | |
| Account Email | String | Optional | |
| Allow Email Login | Boolean | Optional | |
| EAS Generate Password | Boolean | Optional | |
| EAS Password Seed | String | Optional* | Required if Generate Password is Yes. |
| EAS Password | String | Optional* | Required if Generate Password is No or Null |
| Account Type | Select List | Optional* | Required if Configure EAS is Yes |
| Device Type | Select List | Optional* | Required if Configure EAS is Yes |
| CoS ID | String | Optional* | Required if Configure EAS is Yes.
Expecting EAS Class of Service |
| SIP Information | |||
| SIP Domain Name | String | Optional | |
| SIP Username | String | Optional* | Required if Use Service Number for Identification = No |
| SIP Authentication Required | Boolean | Optional | |
| SIP Generate Password | Boolean | Optional* | Required if SIP Authentication Required is Yes |
| SIP Password Seed | String | Optional* | Required is Generate Password is Yes. |
| SIP Password | String | Optional* | Required if Generate Password is No or Null |
* Field is conditionally required. Values selected in preceding fields may change the field from optional to required.
Update Individual Line (Deprecated)
Note: As of the 23.4 release, IDI recommends using the Add/Update Individual Line (Link) action instead of the Update Individual Line action. Going forward, all new parameters will be added to the Add/Update Individual line action. The new action lets you configure a single profile for both add and update provisioning actions.
This action updates an individual line. Two options are available for Password fields:
- Enter your own password in the Password parameter.
- Have the system generate a random password using the Password Seed parameter.
The password seed will be used to randomly generate a password. It is recommended to use an object that will be variable on each service or order, for example, internal object id or account number. If using in combination with Calix, use the same password seed in Metaswitch as you do in Calix.
Parameters:
| Name | Type | Required* | Notes |
| Connection Information | |||
| Address | String | Required | URL of the Metaswitch Web Service |
| Username | String | Required | Username to login |
| Password | String | Required | Password to login |
| Client Version | String | Required | Metaswitch Version |
| General Information | |||
| Network Element | String | Required | Use CFS Name |
| Metaswitch Name | String | Required | Use CFS Name |
| Persistent Profile | String | Required | |
| Subscriber Group | String | Required | |
| Service Number | String | Required | Use Internal Object ID |
| Account Information | |||
| Long Distance Carrier | String | Optional | |
| Intra LATA Carrier | String | Optional | |
| International Carrier | String | Optional | |
| Service Information | |||
| Number Status | Select List | Required | |
| PIN | Number | Required | |
| Signaling Type | Select List | Optional | |
| Call Agent Signaling Type | Select List | Optional | |
| Charge Number | String | Optional | |
| Use Static NAT Mapping | Boolean | Optional | |
| Calling Party Number | String | Optional | |
| Use Service Number for Identification | Boolean | Required | If Yes, will use the value in the Service Number field for Identification |
| SIP Information | |||
| SIP Domain Name | String | Required | |
| SIP Username | String | Optional* | Required if Use Service Number for Identification = No |
| SIP Authentication Required | Boolean | Required | Yes or No |
| SIP Password | String | Optional* | Required if Generate Password = No |
| Generate Password | Boolean | Optional | Yes or No. If no, populate the password field. If yes, populate the password seed field |
| Password Seed | String | Optional | Required if Generate Password = Yes. |
| EAS Information | |||
| Configure EAS Line | Boolean | Optional | Yes or No |
| Display Name | String | Optional* | Required if Configure EAS Line = Yes. |
| Surname | String | Optional* | Required if Configure EAS Line = Yes. Last Name |
| EAS Customer Group | String | Optional* | Required if Configure EAS Line = Yes. |
| Device Type | String | Optional* | Required if Configure EAS Line = Yes. Cellular or Landline |
| CoS ID | String | Optional* | Required if Configure EAS Line = Yes. EAS Class of Service |
| EAS PIN | String | Optional* | Required if Configure EAS Line = Yes. |
| EAS Generate Password | Boolean | Optional | Yes or No. If no, populate the password field. If yes, populate the password seed field |
| EAS Password Seed | String | Optional* | Required if EAS Generate Password = Yes |
| EAS Password | String | Optional* | Required if EAS Generate Password = No |
| Given Name | String | Optional | |
| Email Address | String | Optional | |
| Disable | Boolean | Optional | |
| Disable for Migration | Boolean | Optional | |
| Account Email | String | Optional | |
| Allow Email Login | Boolean | Optional |
* Field is conditionally required. Values selected in preceding fields may change the field from optional to required.
Update Line Class Codes – Subscriber
This action updates line class codes associated with a subscriber. One action exists in provisioning; however, multiple API calls may be sent based on whether the line exists in Metaview. Potential calls made:
- ShPull to MetaView to retrieve the current values of the line class codes
- ShUpdate to MetaView with the new values for the specified line class codes
Parameters:
| Name | Type | Required | Notes |
| General Information | |||
| Metaview User Identity | String | Required | |
| Service Number | String | Required | Use Internal Object ID |
| Line Class Codes | |||
| Code 1 | String | Optional | |
| Code 2 | String | Optional | |
| Code 3 | String | Optional | |
| Code 4 | String | Optional | |
| Code 5 | String | Optional | |
| Code 6 | String | Optional | |
| Code 7 | String | Optional | |
| Code 8 | String | Optional | |
| Code 9 | String | Optional | |
| Code 10 | String | Optional | |
| Code 11 | String | Optional | |
| Code 12 | String | Optional | |
| Code 13 | String | Optional | |
| Code 14 | String | Optional | |
| Code 15 | String | Optional | |
| Code 16 | String | Optional | |
| Code 17 | String | Optional | |
| Code 18 | String | Optional | |
| Code 19 | String | Optional | |
| Code 20 | String | Optional |
Delete Business Group Line
This action deletes a Business Group line. One action exists in provisioning; however, multiple API calls may be sent based on whether the line exists in both MV and EAS. Potential calls made:
- ShPull to MetaVview to determine whether to delete the group line
- Delete a business group line from MetaView
- ShPull to EAS to determine whether to delete the group line
- Delete a business group line from EAS
Parameters:
| Name | Type | Required | Notes |
| Connection Information | |||
| Address | String | Required | URL of the Metaswitch Web Service |
| Username | String | Required | Username to login |
| Password | String | Required | Password to login |
| Client Version | String | Required | Metaswitch Version |
| General Information | |||
| EAS User Identity | String | Required | |
| Service Number | String | Required | User Internal Object ID |
Delete Individual Line
This action deletes an Individual line. One action exists in provisioning; however, multiple API calls may be sent based on whether the line exists in both MV and EAS. Potential calls made:
- ShPull to MetaView to determine whether to delete the line
- Delete a line from MetaView
- ShPull to EAS to determine whether to delete the line
- Delete a line from EAS
Parameters:
| Name | Type | Required | Notes |
| Connection Information | |||
| Address | String | Required | URL of the Metaswitch Web Service |
| Username | String | Required | Username to login |
| Password | String | Required | Password to login |
| Client Version | String | Required | Metaswitch Version |
| General Information | |||
| Service Number | String | Required | Use Internal Object ID |
| Metaview User Identity | String | Required | |
| EAS User Identity | String | Required |
Add/Update Individual Line
This action replaces the existing Create Individual Line and Update Individual Line actions by combining both actions into one. Configure one action to add or update an individual line.
When Add-Update Mode is set to:
- “Add/Update” – This action will perform a ShPull API call to determine if the individual line exists in Metaswitch. If so, the system will perform an update call.
- “Add-Only” – This action will create a new individual line. If the individual line already exists, an error will be returned.
- “Update-Only” – This action will perform a ShPull API call to retrieve information about the existing individual line before updating the individual line with the new information. If the individual line does not already exist, an error will be returned.
Two options are available for Password fields:
- Enter your own password in the Password parameter.
- Have the system generate a random password using the Password Seed parameter.
The password seed will be used to randomly generate a password. It is recommended to use an object that will be variable on each service or order, for example, internal object id or account number. If using in combination with Calix, use the same password seed in Metaswitch as you do in Calix.
Parameters:
| Name | Type | Required* | Notes |
| Add-Update Mode | |||
| Add-Update Mode | String | Required | “Add/Update”, “Add-Only”, “Update-Only” |
| Connection Information | |||
| Address | String | Required | URL of the Metaswitch Web Service |
| Username | String | Required | Username to login |
| Password | String | Required | Password to login |
| Client Version | String | Required | Metaswitch Version |
| General Information | |||
| Network Element | String | Optional | Use CFS Name |
| Metaswitch Name | String | Optional | Use CFS Name |
| Persistent Profile | String | Optional | |
| Subscriber Group | String | Optional | |
| Metaview User Identity | String | Required | |
| EAS User Identity | String | Optional* | Required if Configure EAS Line = Yes. |
| Service Number | String | Required | Use Internal Object ID |
| Account Information | |||
| Long Distance Carrier | String | Optional | |
| Intra LATA Carrier | String | Optional | |
| International Carrier | String | Optional | |
| Service Information | |||
| Number Status | Select List | Optional | |
| PIN | Number | Optional | |
| Signaling Type | Select List | Optional | |
| Call Agent Signaling Type | Select List | Optional | |
| Charge Number | String | Optional | |
| Use Static NAT Mapping | Boolean | Optional | |
| Calling Party Number | String | Optional | |
| Use Service Number for Identification | Boolean | Optional | If Yes, will use the value in the Service Number field for Identification |
| SIP Information | |||
| SIP Domain Name | String | Optional | |
| SIP Username | String | Optional* | Required if Use Service Number for Identification = No |
| SIP Authentication Required | Boolean | Optional | Yes or No |
| SIP Password | String | Optional* | Required if Generate Password = No or Null |
| Generate Password | Boolean | Optional | Yes or No. If no, populate the password field. If yes, populate the password seed field |
| Password Seed | String | Optional* | Required if Generate Password = Yes. |
| Use Phone Number for SIP User Name | Boolen | Optional | Yes or No |
| Max Permitted Contact Refresh Interval on SIP Registers (secs) | Number | Optional | |
| Maxium Simultaneous Registrations | Number | Optional | |
| Accession Client Only | Boolen | Optional | Yes or No |
| Maximum Call Appearences | Number | Optional | |
| Flash-Hook Call Services Provided By (CFS) | List | Optional | Choose: Endpoint, MetaSphere CFS, Metaswitch, Metaswitch AGC, TAS |
| Device Twinning Support | List | Optional | Choose: “Not subscribed”, “Subscribed and enabled”, “Subescribed, not enabled” |
| EAS Information | |||
| Configure EAS Line | Boolean | Optional | Yes or No |
| Display Name | String | Optional* | Required if Configure EAS Line = Yes. |
| Surname | String | Optional* | Required if Configure EAS Line = Yes. Last Name |
| EAS Customer Group | String | Optional* | Required if Configure EAS Line = Yes. |
| Device Type | String | Optional* | Required if Configure EAS Line = Yes. Cellular or Landline |
| CoS ID | String | Optional* | Required if Configure EAS Line = Yes. EAS Class of Service |
| EAS PIN | String | Optional* | Required if Configure EAS Line = Yes. |
| EAS Generate Password | Boolean | Optional | Yes or No. If no, populate the password field. If yes, populate the password seed field |
| EAS Password Seed | String | Optional* | Required if EAS Generate Password = Yes |
| EAS Password | String | Optional* | Required if EAS Generate Password = No or Null |
| Given Name | String | Optional | |
| Email Address | String | Optional | |
| Disable | Boolean | Optional | |
| Disable for Migration | Boolean | Optional | |
| Account Email | String | Optional | |
| Allow Email Login | Boolean | Optional | |
| Advanced | |||
| Recently Moved Old Number | Boolen | Optional | Yes or No |
| Moved From Phone Number | String | Optional* | Required in Metaswitch if Recently Moved Old Number is set to Yes. |
| Orginating SIP Service | Boolean | Optional | Yes or No |
| Orginating Service (SIP) – Service | String | Optional |
* Field is conditionally required. Values selected in preceding fields may change the field from optional to required.
Add/Update Business Group
This action replaces the existing Create Business Group action. Configure one action to add or update a business group.
When Add-Update Mode is set to:
- “Add/Update” – This action will perform a ShPull API call to determine if the business group exists in Metaswitch. If so, the system will perform an update call.
- “Add-Only” – This action will create a new business group. If the business group already exists, an error will be returned.
- “Update-Only” – This action will perform a ShPull API call to retrieve information about the existing business group before updating the business group with the new information. If the business group does not already exist, an error will be returned.
It is recommended to create a new IDI platform service type for the business group, although not required. Use the service number as the business group name. The service number character length is 30. Advantages of adding business groups as a service number are:
- The business group name will be searchable in Customer Care.
The duplicate service number check ensures you don’t have multiple business groups with the same name.
Parameters:
* Field is conditionally required. Values selected in preceding fields may change the field from optional to required.
Add/Update Business Group Line
This action replaces the existing Create Business Group Line and Update Business Group Line actions. Configure one action to add or update a business group.
When Add-Update Mode is set to:
- “Add/Update” – This action will perform a ShPull API call to determine if the service exists in Metaswitch. If so, the system will perform an update call.
- “Add-Only” – This action will create a new service. If the service already exists, an error will be returned.
- “Update-Only” – This action will perform a ShPull API call to retrieve information about the existing service before updating the service with the new information. If the service does not already exist, an error will be returned.
Two options are available for password fields:
- Enter your own password in the Password parameter.
- Have the system generate a random password using the Password Seed parameter.
The password seed will be used to randomly generate a password. We recommend using an object that will be variable on each service or order, for example, internal object id or account number. If using in combination with Calix, use the same password seed in Metaswitch as you do in Calix.
| Name | Type | Required* | Notes |
| Add-Update Mode | |||
| Add-Update Mode | String | Required | “Add/Update”, “Add-Only”, “Update-Only” |
| Connection Information | |||
| Address | String | Required | URL of the Metaswitch Web Service |
| Username | String | Required | Username to login |
| Password | String | Required | Password to login |
| Client Version | String | Required | Metaswitch Version |
| General Information | |||
| Metaview User Identity | String | Required | |
| EAS User Identity | String | Optional* | Required if Configure EAS Line = Yes. |
| Service Number | String | Required | Use Internal Object ID |
| Name | String | Optional | |
| Business Group Name | String | Optional | |
| Network Element | String | Optional | Use CFS Name |
| Metaswitch Name | String | Optional | Use CFS Name |
| Persistent Profile | String | Optional | |
| Number Status | Select List | Optional | |
| Signaling Type | Select List | Optional | |
| Call Agent Signaling Type | Select List | Optional | |
| Calling Party Number | String | Optional | |
| Calling Party Number For Emergency Calls | String | Optional | |
| Charge Number | String | Optional | |
| Use Static NAT Mapping | Boolean | Optional | Yes or No |
| Use Service Number for Identification | Boolean | Optional | If Yes, will use the value in the Service Number field for Identification |
| Department | String | Optional | |
| Business Group Administration – Account Type | String | Optional | |
| Recording Service (SIP) | Boolean | Optional | Yes or No |
| Account Information | |||
| Long Distance Carrier | String | Optional | |
| Intra LATA Carrier | String | Optional | |
| International Carrier | String | Optional | |
| CFS Information | |||
| CFS PIN | String | Optional | |
| EAS Information | |||
| Configure EAS Line | Boolean | Optional | Yes or No |
| Surname | String | Optional* | Required if Configure EAS Line = Yes. Last Name |
| EAS Customer Group | String | Optional | |
| EAS PIN | String | Optional* | Required if Configure EAS Line is Yes |
| EAS Generate Password | Boolean | Optional | Yes or No |
| Given Name | String | Optional | |
| Email Address | String | Optional | |
| Disable | Boolean | Optional | |
| Disable for Migration | Boolean | Optional | |
| Account Email | String | Optional | |
| Allow Email Login | Boolean | Optional | |
| EAS Password | String | Optional* | Required if Generate Password is No or Null |
| EAS Password Seed | String | Optional* | Required if EAS Generate Password = Yes |
| Account Type | Select List | Optional | |
| Device Type | Select List | Optional | |
| CoS ID | String | Optional | Expecting EAS Class of Service |
| SIP Information | |||
| SIP Domain Name | String | Optional | |
| SIP User Name | String | Optional* | Required if Use Service Number for Identification = No |
| SIP Authentication Required | Boolean | Optional | |
| SIP Generate Password | Boolean | Optional* | Required if SIP Authentication Required is Yes |
| SIP Password Seed | String | Optional* | Required is Generate Password is Yes. |
| SIP Password | String | Optional* | Required if Generate Password is No or Null |
| Use Phone Number for SIP User Name | Boolean | Optional | Yes or No |
| Maximum Permitted Contact Refresh Interval on SIP Registers (secs) | Integer | Optional | |
| Maximum Simultaneous Registrations | Integer | Optional | |
| Accession Client Only | Boolean | Optional | |
| Maximum Call Appearances | Integer | Optional | |
| Flash-hook Call Services Provided By (CFS) | String | Optional | |
| Device Twinning Support | String | Optional | |
| Advanced | |||
| Recently Moved Old Number | Boolean | Optional | Yes or No |
| Moved from Phone Number | String | Optional* | Required if Recently Moved Old Number = Yes |
| Originating Service (SIP) | Boolean | Optional | |
| Originating Service (SIP) – Server | String | Optional |
* Field is conditionally required. Values selected in preceding fields may change the field from optional to required.
