1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
  "contact": {
    "display_name": "Contact Details",
    "description": "Please enter the contact details",
    "type": "text",
    "required": true
  },
  "age": {
    "display_name": "Age",
    "description": "Please enter your age in years",
    "type": "number"
  },
  "contactType": {
    "display_name": "Contact Type",
    "description": "Please select the contact type",
    "type": "dropdown",
    "options": [
      "Phone",
      "Email"
    ],
    "default_value": "Email"
  },
  "domainName": {
    "display_name": "Domain Name",
    "description": "Please enter your domain name",
    "type": "domain",
    "type_attributes": {
      "product": "freshcaller"
    },
    "required": true
  },
  "apiKey": {
    "display_name": "API Key",
    "description": "Please enter your api_key",
    "type": "api_key",
    "secure": true,
    "required": true,
    "type_attributes": {
      "product": "freshcaller"
    }
  }
}

1
2
3
4
5
6
7
8
{
  "ContactDetails": {
    "display_name": "Contact details",
    "description": "Please enter the contact details",
    "type": "text",
    "required": true
  }
}

1
2
3
4
5
6
7
8
{
  "ContactAddress": {
    "display_name": "Contact address",
    "description": "Please enter the contact address",
    "type": "paragraph",
    "required": true
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
{
  "ContactType": {
    "display_name": "Contact Type",
    "description": "Please select the contact type",
    "type": "dropdown",
    "options": [
      "Phone",
      "Email"
    ],
    "default_value": "Email"
  }
}

1
2
3
4
5
6
7
8
{
  "EmailAddress": {
    "display_name": "Email Address",
    "description": "Please enter your email address",
    "type": "email",
    "required": true
  }
}

1
2
3
4
5
6
7
8
{
  "Age": {
    "display_name": "Age",
    "description": "Please enter your age in years",
    "type": "number",
    "required": true
  }
}

1
2
3
4
5
6
7
8
{
  "PhoneNumber": {
    "display_name": "Phone Number",
    "description": "Please enter your phone number with the country code",
    "type": "phone_number",
    "required": true
  }
}

1
2
3
4
5
6
7
8
{
  "Birthday": {
    "display_name": "Birthday",
    "description": "Please enter your birthday",
    "type": "date",
    "required": true
  }
}

1
2
3
4
5
6
7
8
{
  "FreshcallerDomain": {
    "display_name": "Freshcaller Domain",
    "description": "Please enter your Freshcaller domain web address",
    "type": "url",
    "required": true
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
{
  "ContactType": {
    "display_name": "Contact Type",
    "description": "Please select the contact type",
    "type": "radio",
    "options": [
      "Phone",
      "Email"
    ],
    "default_value": "Email"
  }
}

1
2
3
4
5
6
7
8
{
  "ArchiveTicket": {
    "display_name": "Archive ticket",
    "description": "Check this option if the tickets are to be archived",
    "type": "checkbox",
    "default_value": true
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "ContactMethods": {
    "display_name": "Contact Methods",
    "description": "Please select the preferred contact methods",
    "type": "multiselect",
    "options": [
      "Phone",
      "Mobile",
      "Twitter ID",
      "Email"
    ],
    "default_value": ["Mobile", "Email"]
  }
}

1
2
3
4
5
6
7
8
9
10
11
{
  "domainName": {
    "display_name": "DomainName",
    "description": "Please enter your domain name",
    "type": "domain",
    "type_attributes": {
      "product": "freshcaller"
     },
    "required": true
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
{
  "apiKey": {
    "display_name": "api_key",
    "description": "Please enter your api_key",
    "type": "api_key",
     "secure": true,
     "required": true
     "type_attributes": {
       "product": "freshcaller"
      }
    }
  }

1
utils.set(‘<iparam_key>’, {<attribute>: <value>});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
    "firstname": {
        "display_name": "First Name",
        "description": "Please enter your business name",
        "type": "text",
        "required": true,
        "events": [
            {"change": "firstnameChange"}
        ]
    },
    "lastname": {
        "display_name": "Last Name",
        "description": "Please enter your last name",
        "type": "text",
        "required": false
    }
}

1
2
3
function firstnameChange(arg) {
    utils.set(‘lastname’, {value: arg});
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "firstname": {
        "display_name": "First Name",
        "description": "Please enter your business name",
        "type": "text",
        "required": true,
        "events": [
            {"change": "firstnameChange"}
        ]
    },
    "multiselect": {
        "display_name": "Other Details",
        "description": "Please select values",
        "type": "multiselect",
        "required": true,
        "options": [
            "opt1",
            "opt2",
            "opt3"
        ]
    }
}

1
2
3
function firstnameChange(arg) {
    utils.set(‘multiselect’, {value: [opt1,opt2]});
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
    "firstname": {
        "display_name": "First Name",
        "description": "Please enter your business name",
        "type": "text",
        "required": true,
        "events": [
            {"change": "firstnameChange"}
        ]
    },
    "lastname": {
        "display_name": "Last Name",
        "description": "Please enter your last name",
        "type": "text",
        "required": false
    }
}

1
2
3
function firstnameChange(arg) {
    utils.set(‘lastname’, {visible: false});
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
    "firstname": {
        "display_name": "First Name",
        "description": "Please enter your business name",
        "type": "text",
        "required": true,
        "events": [
            {"change": "firstnameChange"}
        ]
    },
    "lastname": {
        "display_name": "Last Name",
        "description": "Please enter your last name",
        "type": "text",
        "required": false
    }
}

1
2
3
function firstnameChange(arg) {
    utils.set(‘lastname’, {visible: arg !== ‘’});
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
    "firstname": {
        "display_name": "First Name",
        "description": "Please enter your business name",
        "type": "text",
        "required": true,
        "events": [
            {"change": "firstnameChange"}
        ]
    },
    "lastname": {
        "display_name": "Last Name",
        "description": "Please enter your last name",
        "type": "text",
        "required": false
    }
    "multiselect": {
        "display_name": "Other Details",
        "description": "Please select values",
        "type": "multiselect",
        "required": true,
        "options": [
            "opt1",
            "opt2",
            "opt3"
        ]
    }
}

1
2
3
function firstnameChange(arg) {
    utils.set(‘multiselect’, {values: [Travelling, Swimming, Reading books], label: ‘Hobbies’});
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
    "firstname": {
        "display_name": "First Name",
        "description": "Please enter your business name",
        "type": "text",
        "required": true,
        "events": [
            {"change": "firstnameChange"}
        ]
    },
    "age": {
        "display_name": "Last Name",
        "description": "Please enter your last name",
        "type": "number",
        "required": false
    }
}

1
2
3
function firstnameChange(arg) {
    utils.set(‘age’, {label: ‘Age in years’, min: 18, max: 65});
}

1
utils.get(‘<iparam_key>’);

1
return <validation criteria> ? ‘<Success Message>’: ‘<Error Message>’;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "APIKey": {
        "display_name": "API Key",
        "description": "Please enter your api key",
        "type": "api_key",
        "secure": true,
        "required": true,
        "type_attributes": {
            "product": "freshcaller"
        },
        "events": [
            {"change": "APIKeyChange"}
        ]
    }
}

1
2
3
4
5
function APIKeyChange(arg) {
    //API call by using arg which is the API Key entered by the app user
    //value is the response returned by the API call
      return value==‘’ ? ‘Invalid API Key’: ‘’;
}

1
2
3
4
5
6
7
8
9
10
11
{
    "acc_id": {
        "display_name": "Account ID",
        "description": "Please enter your Acc. ID",
        "type": "text",
        "required": true,
        "events": [{
          "change": "checkAccountID"
        }]
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
/* global app, client, utils */
app.initialized().then(
    function(_client) {
        //If successful, register the app activated and deactivated event callback.
        window.client = _client;
    },
    function(error) {
        //If unsuccessful
        console.log(error);
    }
);
    /* Using the iparam callback function, we are validating the iparam value after a third-party API call. */
    /* Payload and other options can be specified using ‘options’. */
function checkAccountID(newValue) {
    var url = "https://example.com/verify";
        var options = {
            body: JSON.stringify({
              param: newValue
            })
        };
        var p = new Promise(function(resolve, reject) {
            client.request.post(url, options).then(
                function(data) {
                    // Upon success
                    resolve();
                },
                function(error) {
                    // Upon failure - send an appropriate validation error message
                    reject("The account does not exist.");
                }
            );
        });
    return p;
}

1
2
3
4
5
6
7
8
9
10
client.iparams.get().then (
    function(data) {
        // success output
        // "data" is returned with the list of all the iparams
    },
    function(error) {
        console.log(error);
        // failure operation
    }
);

1
2
3
4
5
6
{
    "contact": "rachel@freshcaller.com",
    "contact-type": "Email",
    "request_domain": "sample.freshcaller.com",
    "subdomian": "sample"
}

1
2
3
4
5
6
7
8
9
10
client.iparams.get("contact").then (
    function(data) {
        // success output
        // "data" is returned with the value of the "contact" attribute.
    },
    function(error) {
        console.log(error);
        // failure operation
    }
);

1
2
3
{
    "contact": "rachel@freshcaller.com"
}

1
2
3
{
    "message": "Could not find an installation parameter that matches this key."
}