Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
http.BasicAuth = true;
http.Login = "username";
http.Password = "password";
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "displayName": "proi",
// "settings": {
// "conversationRetentionSeconds": 12466975,
// "maskCreditCardNumbers": false,
// "useAnimalNames": true,
// "echoPostback": false,
// "ignoreAutoConversationStart": false,
// "multiConvoEnabled": false,
// "attachmentsAccess": "public",
// "attachmentsTokenExpirationSeconds": 64028
// },
// "metadata": {
// "lang": "en-ca"
// }
// }
var json = new chilkat.JsonObject();
json.UpdateString("displayName","proi");
json.UpdateInt("settings.conversationRetentionSeconds",12466975);
json.UpdateBool("settings.maskCreditCardNumbers",false);
json.UpdateBool("settings.useAnimalNames",true);
json.UpdateBool("settings.echoPostback",false);
json.UpdateBool("settings.ignoreAutoConversationStart",false);
json.UpdateBool("settings.multiConvoEnabled",false);
json.UpdateString("settings.attachmentsAccess","public");
json.UpdateInt("settings.attachmentsTokenExpirationSeconds",64028);
json.UpdateString("metadata.lang","en-ca");
http.SetRequestHeader("Content-Type","application/json");
// resp: HttpResponse
var resp = http.PostJson3("https://domain.com/","application/json",json);
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
var sbResponseBody = new chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(resp.Header);
console.log("Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "app": {
// "id": "5d8cff3cd55b040010928b5b",
// "displayName": "utoc",
// "settings": {
// "conversationRetentionSeconds": 35855812,
// "maskCreditCardNumbers": true,
// "useAnimalNames": false,
// "echoPostback": true,
// "ignoreAutoConversationStart": true,
// "multiConvoEnabled": true,
// "attachmentsAccess": "public",
// "attachmentsTokenExpirationSeconds": 64028
// },
// "metadata": {
// "lang": "en-ca"
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var Id = jResp.StringOf("app.id");
var DisplayName = jResp.StringOf("app.displayName");
var ConversationRetentionSeconds = jResp.IntOf("app.settings.conversationRetentionSeconds");
var MaskCreditCardNumbers = jResp.BoolOf("app.settings.maskCreditCardNumbers");
var UseAnimalNames = jResp.BoolOf("app.settings.useAnimalNames");
var EchoPostback = jResp.BoolOf("app.settings.echoPostback");
var IgnoreAutoConversationStart = jResp.BoolOf("app.settings.ignoreAutoConversationStart");
var MultiConvoEnabled = jResp.BoolOf("app.settings.multiConvoEnabled");
var AttachmentsAccess = jResp.StringOf("app.settings.attachmentsAccess");
var AttachmentsTokenExpirationSeconds = jResp.IntOf("app.settings.attachmentsTokenExpirationSeconds");
var Lang = jResp.StringOf("app.metadata.lang");
}
chilkatExample();
Curl Command
curl -X POST
-u 'username:password'
-H "Content-Type: application/json"
-d '{
"displayName": "proi",
"settings": {
"conversationRetentionSeconds": 12466975,
"maskCreditCardNumbers": false,
"useAnimalNames": true,
"echoPostback": false,
"ignoreAutoConversationStart": false,
"multiConvoEnabled": false,
"attachmentsAccess": "public",
"attachmentsTokenExpirationSeconds": 64028
},
"metadata": {
"lang": "en-ca"
}
}'
https://domain.com/
Postman Collection Item JSON
{
"name": "Create App",
"_postman_id": "4e199592-ca64-47d6-ad91-f5a1a05abfb2",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"displayName\": \"proi\",\n \"settings\": {\n \"conversationRetentionSeconds\": 12466975,\n \"maskCreditCardNumbers\": false,\n \"useAnimalNames\": true,\n \"echoPostback\": false,\n \"ignoreAutoConversationStart\": false,\n \"multiConvoEnabled\": false,\n \"attachmentsAccess\": \"public\",\n \"attachmentsTokenExpirationSeconds\": 64028\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n}"
},
"url": "{{url}}/v2/apps",
"description": "Creates a new app. When using [service account](#service-accounts) credentials, the service account is automatically granted access to the app."
},
"response": [
{
"id": "17a454e4-dc50-4600-8337-693271b27f98",
"name": "Your account has reached the maximum number of apps for your subscription plan",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"displayName\": \"proi\",\n \"settings\": {\n \"conversationRetentionSeconds\": 12466975,\n \"maskCreditCardNumbers\": false,\n \"useAnimalNames\": true,\n \"echoPostback\": false,\n \"ignoreAutoConversationStart\": false,\n \"multiConvoEnabled\": false,\n \"attachmentsAccess\": \"public\",\n \"attachmentsTokenExpirationSeconds\": 64028\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n}"
},
"url": "{{baseUrl}}/v2/apps"
},
"status": "Payment Required",
"code": 402,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"id": "288fc92e-2d6f-46cf-b38e-856fc5946b5d",
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"displayName\": \"proi\",\n \"settings\": {\n \"conversationRetentionSeconds\": 12466975,\n \"maskCreditCardNumbers\": false,\n \"useAnimalNames\": true,\n \"echoPostback\": false,\n \"ignoreAutoConversationStart\": false,\n \"multiConvoEnabled\": false,\n \"attachmentsAccess\": \"public\",\n \"attachmentsTokenExpirationSeconds\": 64028\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n}"
},
"url": "{{baseUrl}}/v2/apps"
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"app\": {\n \"id\": \"5d8cff3cd55b040010928b5b\",\n \"displayName\": \"utoc\",\n \"settings\": {\n \"conversationRetentionSeconds\": 35855812,\n \"maskCreditCardNumbers\": true,\n \"useAnimalNames\": false,\n \"echoPostback\": true,\n \"ignoreAutoConversationStart\": true,\n \"multiConvoEnabled\": true,\n \"attachmentsAccess\": \"public\",\n \"attachmentsTokenExpirationSeconds\": 64028\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n }\n}"
},
{
"id": "d62f7132-159c-4532-bd7b-30c6060718a1",
"name": "should have required property 'displayName'",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"displayName\": \"proi\",\n \"settings\": {\n \"conversationRetentionSeconds\": 12466975,\n \"maskCreditCardNumbers\": false,\n \"useAnimalNames\": true,\n \"echoPostback\": false,\n \"ignoreAutoConversationStart\": false,\n \"multiConvoEnabled\": false,\n \"attachmentsAccess\": \"public\",\n \"attachmentsTokenExpirationSeconds\": 64028\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n}"
},
"url": "{{baseUrl}}/v2/apps"
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
