View to add a Subscriber using a Service Profile.
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": {
"username": {
"required": true,
"type": "string",
"description": "Username of the subscriber.",
"title": "Username"
},
"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"
},
"pin": {
"required": false,
"is_password": true,
"type": "string",
"description": "The corresponding CUCM and CUC user PIN will be set with this PIN",
"title": "PIN"
},
"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": {
"pattern": "^([^.@]+)(\\.[^.@]+)*@([^.@]+\\.)+([^.@]+)$",
"required": true,
"type": "string",
"description": "Email address of the subscriber.",
"title": "Email Address"
},
"automatic_line": {
"default": "true",
"type": "boolean",
"description": "Use the next available line from the inventory.",
"title": "Use next available line"
},
"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"
},
"cucm_user": {
"type": "string",
"description": "The CUCM User field.",
"title": "CUCM User"
},
"subscriber_profile": {
"required": true,
"type": "string",
"description": "The profile to use for subscriber configuration.",
"title": "Subscriber Profile"
},
"mobile_number": {
"pattern": "^(\\+?[0-9]*)$",
"type": "string",
"description": "Mobile number of the subscriber.",
"title": "Mobile Number"
},
"line_filter": {
"default": "default",
"choices": [
{
"value": "default",
"title": "Default"
},
{
"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"
}
],
"required": false,
"type": "string",
"title": "Inventory Filter"
},
"cucm_user_ldapDirectoryName": {
"type": "string",
"description": "The CUCM User LDAP directory name field.",
"title": "CUCM User LDAP Directory Name"
},
"line": {
"type": "string",
"description": "The line number to use for this subscriber.",
"title": "Line"
},
"password": {
"required": false,
"is_password": true,
"type": "string",
"description": "The corresponding CUCM, CUC and WebEx user password will be set with this password",
"title": "Password"
},
"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"
},
"cucm_bkey": {
"required": false,
"type": "string",
"description": "Business Key of the CUCM.",
"title": "CUCM bkey"
},
"ldap_user": {
"type": "string",
"description": "The LDAP user field.",
"title": "LDAP User"
},
"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"
}
},
"schema_version": "1.1"
}