Chilkat Online Tools

Classic ASP / Sunshine Conversations API / Create App

Back to Collection Items

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = Server.CreateObject("Chilkat.Http")

http.BasicAuth = 1
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"
'   }
' }

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set json = Server.CreateObject("Chilkat.JsonObject")
success = json.UpdateString("displayName","proi")
success = json.UpdateInt("settings.conversationRetentionSeconds",12466975)
success = json.UpdateBool("settings.maskCreditCardNumbers",0)
success = json.UpdateBool("settings.useAnimalNames",1)
success = json.UpdateBool("settings.echoPostback",0)
success = json.UpdateBool("settings.ignoreAutoConversationStart",0)
success = json.UpdateBool("settings.multiConvoEnabled",0)
success = json.UpdateString("settings.attachmentsAccess","public")
success = json.UpdateInt("settings.attachmentsTokenExpirationSeconds",64028)
success = json.UpdateString("metadata.lang","en-ca")

http.SetRequestHeader "Content-Type","application/json"

' resp is a Chilkat.HttpResponse
Set resp = http.PostJson3("https://domain.com/","application/json",json)
If (http.LastMethodSuccess = 0) Then
    Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
    Response.End
End If

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = Server.CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = Server.CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Response.Write "<pre>" & Server.HTMLEncode( "Response Body:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( jResp.Emit()) & "</pre>"

respStatusCode = resp.StatusCode
Response.Write "<pre>" & Server.HTMLEncode( "Response Status Code = " & respStatusCode) & "</pre>"
If (respStatusCode >= 400) Then
    Response.Write "<pre>" & Server.HTMLEncode( "Response Header:") & "</pre>"
    Response.Write "<pre>" & Server.HTMLEncode( resp.Header) & "</pre>"
    Response.Write "<pre>" & Server.HTMLEncode( "Failed.") & "</pre>"

    Response.End
End If

' 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

Id = jResp.StringOf("app.id")
DisplayName = jResp.StringOf("app.displayName")
ConversationRetentionSeconds = jResp.IntOf("app.settings.conversationRetentionSeconds")
MaskCreditCardNumbers = jResp.BoolOf("app.settings.maskCreditCardNumbers")
UseAnimalNames = jResp.BoolOf("app.settings.useAnimalNames")
EchoPostback = jResp.BoolOf("app.settings.echoPostback")
IgnoreAutoConversationStart = jResp.BoolOf("app.settings.ignoreAutoConversationStart")
MultiConvoEnabled = jResp.BoolOf("app.settings.multiConvoEnabled")
AttachmentsAccess = jResp.StringOf("app.settings.attachmentsAccess")
AttachmentsTokenExpirationSeconds = jResp.IntOf("app.settings.attachmentsTokenExpirationSeconds")
Lang = jResp.StringOf("app.metadata.lang")

%>
</body>
</html>

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": ""
    }
  ]
}