Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "username"
CkHttp_put_Password $http "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"
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "displayName" "proi"
CkJsonObject_UpdateInt $json "settings.conversationRetentionSeconds" 12466975
CkJsonObject_UpdateBool $json "settings.maskCreditCardNumbers" 0
CkJsonObject_UpdateBool $json "settings.useAnimalNames" 1
CkJsonObject_UpdateBool $json "settings.echoPostback" 0
CkJsonObject_UpdateBool $json "settings.ignoreAutoConversationStart" 0
CkJsonObject_UpdateBool $json "settings.multiConvoEnabled" 0
CkJsonObject_UpdateString $json "settings.attachmentsAccess" "public"
CkJsonObject_UpdateInt $json "settings.attachmentsTokenExpirationSeconds" 64028
CkJsonObject_UpdateString $json "metadata.lang" "en-ca"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set Id [CkJsonObject_stringOf $jResp "app.id"]
set DisplayName [CkJsonObject_stringOf $jResp "app.displayName"]
set ConversationRetentionSeconds [CkJsonObject_IntOf $jResp "app.settings.conversationRetentionSeconds"]
set MaskCreditCardNumbers [CkJsonObject_BoolOf $jResp "app.settings.maskCreditCardNumbers"]
set UseAnimalNames [CkJsonObject_BoolOf $jResp "app.settings.useAnimalNames"]
set EchoPostback [CkJsonObject_BoolOf $jResp "app.settings.echoPostback"]
set IgnoreAutoConversationStart [CkJsonObject_BoolOf $jResp "app.settings.ignoreAutoConversationStart"]
set MultiConvoEnabled [CkJsonObject_BoolOf $jResp "app.settings.multiConvoEnabled"]
set AttachmentsAccess [CkJsonObject_stringOf $jResp "app.settings.attachmentsAccess"]
set AttachmentsTokenExpirationSeconds [CkJsonObject_IntOf $jResp "app.settings.attachmentsTokenExpirationSeconds"]
set Lang [CkJsonObject_stringOf $jResp "app.metadata.lang"]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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": ""
}
]
}
