Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcV_Type
LOCAL lcStatus
LOCAL lcDisplayName
LOCAL lcServerId
LOCAL lnCanUserCreateMoreConversations
* 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.
* {
* "type": "android",
* "status": "inactive",
* "displayName": "Channel name"
* }
loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("type","android")
loJson.UpdateString("status","inactive")
loJson.UpdateString("displayName","Channel name")
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)
* {
* "integration": {
* "id": "5e4af71a81966cfff3ef6550",
* "type": "android",
* "status": "active",
* "displayName": "Android",
* "serverId": "<sender-id>",
* "canUserCreateMoreConversations": true
* }
* }
* 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("integration.id")
lcV_Type = loJResp.StringOf("integration.type")
lcStatus = loJResp.StringOf("integration.status")
lcDisplayName = loJResp.StringOf("integration.displayName")
lcServerId = loJResp.StringOf("integration.serverId")
lnCanUserCreateMoreConversations = loJResp.BoolOf("integration.canUserCreateMoreConversations")
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -X POST
-u 'username:password'
-H "Content-Type: application/json"
-d '{
"type": "android",
"status": "inactive",
"displayName": "Channel name"
}'
https://domain.com/
Postman Collection Item JSON
{
"name": "Create Integration",
"_postman_id": "80a66b25-9cd7-45fd-9797-078819996d0d",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"android\",\n \"status\": \"inactive\",\n \"displayName\": \"Channel name\"\n}"
},
"url": "{{url}}/v2/apps/{{appId}}/integrations",
"description": "The Create Integration endpoint allows you to provision apps with front-end messaging channels. Selecting a `custom` integration allows the creation of webhooks."
},
"response": [
{
"id": "423dee8e-37bd-4c2a-9372-cd614554ff0e",
"name": "Invalid integration type",
"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 \"type\": \"android\",\n \"status\": \"inactive\",\n \"displayName\": \"Channel name\"\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/integrations",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"integrations"
],
"variable": [
{
"key": "appId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"id": "5268f4cc-51fa-4a3c-83f3-b496702386c6",
"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 \"type\": \"android\",\n \"status\": \"inactive\",\n \"displayName\": \"Channel name\"\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/integrations",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"integrations"
],
"variable": [
{
"key": "appId"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"integration\": {\n \"id\": \"5e4af71a81966cfff3ef6550\",\n \"type\": \"android\",\n \"status\": \"active\",\n \"displayName\": \"Android\",\n \"serverId\": \"<sender-id>\",\n \"canUserCreateMoreConversations\": true\n }\n}"
}
]
}
