Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
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"
' }
' }
Dim json As New ChilkatJsonObject
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"
Dim resp As ChilkatHttpResponse
Set resp = http.PostJson3("https://domain.com/","application/json",json)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
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
Dim Id As String
Id = jResp.StringOf("app.id")
Dim DisplayName As String
DisplayName = jResp.StringOf("app.displayName")
Dim ConversationRetentionSeconds As Long
ConversationRetentionSeconds = jResp.IntOf("app.settings.conversationRetentionSeconds")
Dim MaskCreditCardNumbers As Long
MaskCreditCardNumbers = jResp.BoolOf("app.settings.maskCreditCardNumbers")
Dim UseAnimalNames As Long
UseAnimalNames = jResp.BoolOf("app.settings.useAnimalNames")
Dim EchoPostback As Long
EchoPostback = jResp.BoolOf("app.settings.echoPostback")
Dim IgnoreAutoConversationStart As Long
IgnoreAutoConversationStart = jResp.BoolOf("app.settings.ignoreAutoConversationStart")
Dim MultiConvoEnabled As Long
MultiConvoEnabled = jResp.BoolOf("app.settings.multiConvoEnabled")
Dim AttachmentsAccess As String
AttachmentsAccess = jResp.StringOf("app.settings.attachmentsAccess")
Dim AttachmentsTokenExpirationSeconds As Long
AttachmentsTokenExpirationSeconds = jResp.IntOf("app.settings.attachmentsTokenExpirationSeconds")
Dim Lang As String
Lang = jResp.StringOf("app.metadata.lang")
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": ""
}
]
}
