Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcDisplayName
LOCAL lnConversationRetentionSeconds
LOCAL lnMaskCreditCardNumbers
LOCAL lnUseAnimalNames
LOCAL lnEchoPostback
LOCAL lnIgnoreAutoConversationStart
LOCAL lnMultiConvoEnabled
LOCAL lcAttachmentsAccess
LOCAL lnAttachmentsTokenExpirationSeconds
LOCAL lcLang
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.BasicAuth = 1
loHttp.Login = "username"
loHttp.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"
* }
* }
loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("displayName","proi")
loJson.UpdateInt("settings.conversationRetentionSeconds",12466975)
loJson.UpdateBool("settings.maskCreditCardNumbers",0)
loJson.UpdateBool("settings.useAnimalNames",1)
loJson.UpdateBool("settings.echoPostback",0)
loJson.UpdateBool("settings.ignoreAutoConversationStart",0)
loJson.UpdateBool("settings.multiConvoEnabled",0)
loJson.UpdateString("settings.attachmentsAccess","public")
loJson.UpdateInt("settings.attachmentsTokenExpirationSeconds",64028)
loJson.UpdateString("metadata.lang","en-ca")
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.PostJson3("https://domain.com/","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcId = loJResp.StringOf("app.id")
lcDisplayName = loJResp.StringOf("app.displayName")
lnConversationRetentionSeconds = loJResp.IntOf("app.settings.conversationRetentionSeconds")
lnMaskCreditCardNumbers = loJResp.BoolOf("app.settings.maskCreditCardNumbers")
lnUseAnimalNames = loJResp.BoolOf("app.settings.useAnimalNames")
lnEchoPostback = loJResp.BoolOf("app.settings.echoPostback")
lnIgnoreAutoConversationStart = loJResp.BoolOf("app.settings.ignoreAutoConversationStart")
lnMultiConvoEnabled = loJResp.BoolOf("app.settings.multiConvoEnabled")
lcAttachmentsAccess = loJResp.StringOf("app.settings.attachmentsAccess")
lnAttachmentsTokenExpirationSeconds = loJResp.IntOf("app.settings.attachmentsTokenExpirationSeconds")
lcLang = loJResp.StringOf("app.metadata.lang")
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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": ""
}
]
}
