[Index]

API Reference for view/AddSubscriberFromProfile

View to add a Subscriber using a Service Profile.

Model ref.: view/AddSubscriberFromProfile

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/view/AddSubscriberFromProfile/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "cucm_bkey": {
               "required": false,
               "type": "string",
               "description": "Business Key of the CUCM.",
               "title": "CUCM bkey"
          },
          "username": {
               "required": true,
               "type": "string",
               "description": "Username of the subscriber.",
               "title": "Username"
          },
          "firstname": {
               "type": "string",
               "description": "First name of the subscriber.",
               "title": "First Name"
          },
          "lastname": {
               "required": true,
               "type": "string",
               "description": "Last name of the subscriber.",
               "title": "Last Name"
          },
          "email": {
               "description": "Email address of the subscriber.",
               "title": "Email Address",
               "pattern": "^([^.@]+)(\\.[^.@]+)*@([^.@]+\\.)+([^.@]+)$",
               "required": false,
               "type": "string"
          },
          "send_email": {
               "type": "boolean",
               "description": "Send Email to user using predefined HTML Email Template. Email template used is 'Quick Add Subscriber'",
               "title": "Send welcome email"
          },
          "send_email_flag": {
               "type": "boolean",
               "description": "Send Email to user using predefined HTML Email Template. Email template used is 'Quick Add Subscriber'",
               "title": "Send Email to user flag"
          },
          "mobile_number": {
               "pattern": "^(\\+?[0-9]*)$",
               "type": "string",
               "description": "Mobile number of the subscriber.",
               "title": "Mobile Number"
          },
          "password": {
               "is_password": true,
               "description": "The corresponding CUCM, CUC and WebEx user password will be set with this password",
               "title": "Password",
               "required": false,
               "type": "string"
          },
          "pin": {
               "is_password": true,
               "description": "The corresponding CUCM and CUC user PIN will be set with this PIN",
               "title": "PIN",
               "required": false,
               "type": "string"
          },
          "generate_phone_name": {
               "default": "true",
               "type": "boolean",
               "description": "A random phone name will be generated by the system. This is only applicable if the selected Subscriber Profile has the Voice service enabled.",
               "title": "Use generated phone name"
          },
          "phone_name": {
               "type": "string",
               "description": "Name to be used when provisioning a phone for e.g. SEPAABBCCDDEEFF. The specific format is dependent on the phone type specified in the profile configuration. This is only applicable if the selected Subscriber Profile has the Voice service enabled.",
               "title": "Phone Name"
          },
          "automatic_line": {
               "default": "true",
               "type": "boolean",
               "description": "Use the next available line from the inventory.",
               "title": "Use next available line"
          },
          "line_filter": {
               "title": "Inventory Filter",
               "default": "default",
               "required": false,
               "choices": [
                    {
                         "value": "default",
                         "title": "Default"
                    },
                    {
                         "value": "lines_unused_only_local",
                         "title": "Show Unused Numbers (Site Only)"
                    },
                    {
                         "value": "lines_unused_only",
                         "title": "Show Unused Numbers"
                    },
                    {
                         "value": "lines_e164_unused_local",
                         "title": "Show Unused Numbers with Associated E164's (Site Only)"
                    },
                    {
                         "value": "lines_e164_unused",
                         "title": "Show Unused Numbers with Associated E164's"
                    },
                    {
                         "value": "lines_used_only_local",
                         "title": "Show Used Numbers (Site Only)"
                    },
                    {
                         "value": "lines_used_only",
                         "title": "Show Used Numbers"
                    },
                    {
                         "value": "lines_userid_used",
                         "title": "Show Numbers belonging to this Subscriber"
                    }
               ],
               "type": "string"
          },
          "line": {
               "type": "string",
               "description": "The line number to use for this subscriber.",
               "title": "Line"
          },
          "subscriber_profile": {
               "required": true,
               "type": "string",
               "description": "The profile to use for subscriber configuration.",
               "title": "Subscriber Profile"
          },
          "ldap_user": {
               "type": "string",
               "description": "The LDAP user field.",
               "title": "LDAP User"
          },
          "cucm_user_ldapDirectoryName": {
               "type": "string",
               "description": "The CUCM User LDAP directory name field.",
               "title": "CUCM User LDAP Directory Name"
          },
          "cucm_user": {
               "type": "string",
               "description": "The CUCM User field.",
               "title": "CUCM User"
          },
          "username_ms_365": {
               "type": "string",
               "description": "The O365 User field.",
               "title": "O365 User"
          },
          "username_ms_teams": {
               "type": "string",
               "description": "The MS Teams User field.",
               "title": "MS Teams User"
          },
          "new_services_status": {
               "type": "boolean",
               "description": "New Services status field.",
               "title": "New Services status field"
          },
          "existing": {
               "type": "object",
               "description": "Subscriber's existing services.",
               "title": "Existing Services",
               "properties": {
                    "phones": {
                         "type": "string",
                         "title": "Phones"
                    },
                    "ext_mobilities": {
                         "type": "string",
                         "title": "Extension Mobility Profile"
                    },
                    "voicemail": {
                         "type": "string",
                         "title": "Voicemail Extension"
                    },
                    "webex": {
                         "type": "string",
                         "title": "Webex Meetings"
                    },
                    "snr": {
                         "type": "string",
                         "title": "Single Number Reach"
                    },
                    "spark": {
                         "type": "string",
                         "title": "Webex App"
                    },
                    "pexip": {
                         "type": "string",
                         "title": "Pexip Conferencing"
                    },
                    "contact_center": {
                         "type": "string",
                         "title": "Contact Center"
                    },
                    "microsoft_hosted_voice_mail": {
                         "type": "string",
                         "title": "Microsoft Hosted Voicemail"
                    },
                    "microsoft_enterprise_voice_enabled": {
                         "type": "string",
                         "title": "Microsoft Teams Phone System"
                    },
                    "hybrid": {
                         "type": "string",
                         "title": "Hybrid Service"
                    }
               }
          },
          "subscriber_profile_services": {
               "type": "object",
               "description": "Subscriber Profile Services that will be added.",
               "title": "New Services",
               "properties": {
                    "line": {
                         "type": "string",
                         "title": "Line"
                    },
                    "phone": {
                         "type": "string",
                         "title": "Phone"
                    },
                    "jabber_iphone": {
                         "type": "string",
                         "title": "Jabber (iPhone)"
                    },
                    "jabber_android": {
                         "type": "string",
                         "title": "Jabber (Android)"
                    },
                    "jabber_tablet": {
                         "type": "string",
                         "title": "Jabber (Tablet)"
                    },
                    "jabber_csf": {
                         "type": "string",
                         "title": "Jabber (CSF)"
                    },
                    "jabber_cim": {
                         "type": "string",
                         "title": "Jabber (CIM)"
                    },
                    "jabber_cti": {
                         "type": "string",
                         "title": "Jabber (CTI)"
                    },
                    "ext_mobilities": {
                         "type": "string",
                         "title": "Extension Mobility Profile"
                    },
                    "voicemail": {
                         "type": "string",
                         "title": "Voicemail Extension"
                    },
                    "webex": {
                         "type": "string",
                         "title": "WebEx"
                    },
                    "snr": {
                         "type": "string",
                         "title": "Single Number Reach"
                    },
                    "spark": {
                         "type": "string",
                         "title": "Webex App"
                    },
                    "webex_calling": {
                         "type": "string",
                         "title": "Webex Calling"
                    },
                    "pexip": {
                         "type": "string",
                         "title": "Pexip Conferencing"
                    },
                    "contact_center": {
                         "type": "string",
                         "title": "Contact Center"
                    },
                    "microsoft_hosted_voice_mail": {
                         "type": "string",
                         "title": "Microsoft Hosted Voicemail"
                    },
                    "microsoft_enterprise_voice_enabled": {
                         "type": "string",
                         "title": "Microsoft Teams Phone System"
                    }
               }
          }
     },
     "schema_version": "2.1"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/AddSubscriberFromProfile/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/AddSubscriberFromProfile as JSON

The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.

Task	Call	URL	Parameters	Payload
Create	POST	/api/view/AddSubscriberFromProfile	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

The GET call to

tool/Transaction/[trans pkid]

shows the View resource has no instance pkid, because a view model stores no instances.

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for view/AddSubscriberFromProfile	POST	/api/view/AddSubscriberFromProfile/export_bulkload_template/	hierarchy=[hierarchy] modeltype=view/AddSubscriberFromProfile	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/view/AddSubscriberFromProfile/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/view/AddSubscriberFromProfile/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get the on-line Help for view/AddSubscriberFromProfile.	GET	/api/view/AddSubscriberFromProfile/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/AddSubscriberFromProfile as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Response
Get	GET	/api/view/AddSubscriberFromProfile/[pkid]	hierarchy=[hierarchy]	The view/AddSubscriberFromProfile instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/view/AddSubscriberFromProfile/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for view/AddSubscriberFromProfile.

API Reference for view/AddSubscriberFromProfile

GET http://[host-proxy]/api/view/AddSubscriberFromProfile/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Export Bulk Load Template

Configuration Template

Field Display Policy

Help

Instance API Reference

Get

Help