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.
' {
' "type": "personal",
' "participants": [
' {
' "userId": "42589ad070d43be9b00ff7e5",
' "subscribeSDKClient": false
' },
' {
' "userId": "42589ad070d43be9b00ff7e5",
' "subscribeSDKClient": false
' }
' ],
' "displayName": "nost",
' "description": "Conversation between Rogers and Carl.",
' "iconUrl": "https://www.gravatar.com/image.jpg",
' "metadata": {
' "lang": "en-ca"
' }
' }
Dim json As New ChilkatJsonObject
success = json.UpdateString("type","personal")
success = json.UpdateString("participants[0].userId","42589ad070d43be9b00ff7e5")
success = json.UpdateBool("participants[0].subscribeSDKClient",0)
success = json.UpdateString("participants[1].userId","42589ad070d43be9b00ff7e5")
success = json.UpdateBool("participants[1].subscribeSDKClient",0)
success = json.UpdateString("displayName","nost")
success = json.UpdateString("description","Conversation between Rogers and Carl.")
success = json.UpdateString("iconUrl","https://www.gravatar.com/image.jpg")
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)
' {
' "conversation": {
' "id": "c93bb9c14dde8ffb94564eae",
' "type": "personal",
' "activeSwitchboardIntegration": {
' "id": "5ef21b86e933b7355c11c604",
' "name": "bot",
' "integrationId": "5ef21b86e933b7355c11c605",
' "integrationType": "zd:agentWorkspace"
' },
' "pendingSwitchboardIntegration": {
' "id": "5ef21b86e933b7355c11c604",
' "name": "bot",
' "integrationId": "5ef21b86e933b7355c11c605",
' "integrationType": "zd:agentWorkspace"
' },
' "isDefault": false,
' "displayName": "pari",
' "description": "Conversation between Rogers and Carl.",
' "iconUrl": "https://www.gravatar.com/image.jpg",
' "metadata": {
' "lang": "en-ca"
' },
' "businessLastRead": "2020-06-23T14:33:47.492Z",
' "lastUpdatedAt": "2020-06-26T14:33:47.120Z"
' }
' }
' 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("conversation.id")
Dim v_Type As String
v_Type = jResp.StringOf("conversation.type")
Dim ActiveSwitchboardIntegrationId As String
ActiveSwitchboardIntegrationId = jResp.StringOf("conversation.activeSwitchboardIntegration.id")
Dim Name As String
Name = jResp.StringOf("conversation.activeSwitchboardIntegration.name")
Dim IntegrationId As String
IntegrationId = jResp.StringOf("conversation.activeSwitchboardIntegration.integrationId")
Dim IntegrationType As String
IntegrationType = jResp.StringOf("conversation.activeSwitchboardIntegration.integrationType")
Dim PendingSwitchboardIntegrationId As String
PendingSwitchboardIntegrationId = jResp.StringOf("conversation.pendingSwitchboardIntegration.id")
Dim PendingSwitchboardIntegrationName As String
PendingSwitchboardIntegrationName = jResp.StringOf("conversation.pendingSwitchboardIntegration.name")
Dim PendingSwitchboardIntegrationIntegrationId As String
PendingSwitchboardIntegrationIntegrationId = jResp.StringOf("conversation.pendingSwitchboardIntegration.integrationId")
Dim PendingSwitchboardIntegrationIntegrationType As String
PendingSwitchboardIntegrationIntegrationType = jResp.StringOf("conversation.pendingSwitchboardIntegration.integrationType")
Dim IsDefault As Long
IsDefault = jResp.BoolOf("conversation.isDefault")
Dim DisplayName As String
DisplayName = jResp.StringOf("conversation.displayName")
Dim Description As String
Description = jResp.StringOf("conversation.description")
Dim IconUrl As String
IconUrl = jResp.StringOf("conversation.iconUrl")
Dim Lang As String
Lang = jResp.StringOf("conversation.metadata.lang")
Dim BusinessLastRead As String
BusinessLastRead = jResp.StringOf("conversation.businessLastRead")
Dim LastUpdatedAt As String
LastUpdatedAt = jResp.StringOf("conversation.lastUpdatedAt")
Curl Command
curl -X POST
-u 'username:password'
-H "Content-Type: application/json"
-d '{
"type": "personal",
"participants": [
{
"userId": "42589ad070d43be9b00ff7e5",
"subscribeSDKClient": false
},
{
"userId": "42589ad070d43be9b00ff7e5",
"subscribeSDKClient": false
}
],
"displayName": "nost",
"description": "Conversation between Rogers and Carl.",
"iconUrl": "https://www.gravatar.com/image.jpg",
"metadata": {
"lang": "en-ca"
}
}'
https://domain.com/
Postman Collection Item JSON
{
"name": "Create Conversation",
"_postman_id": "6688103e-1c82-402c-9e0f-4b96cca896b4",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"personal\",\n \"participants\": [\n {\n \"userId\": \"42589ad070d43be9b00ff7e5\",\n \"subscribeSDKClient\": false\n },\n {\n \"userId\": \"42589ad070d43be9b00ff7e5\",\n \"subscribeSDKClient\": false\n }\n ],\n \"displayName\": \"nost\",\n \"description\": \"Conversation between Rogers and Carl.\",\n \"iconUrl\": \"https://www.gravatar.com/image.jpg\",\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n}"
},
"url": "{{url}}/v2/apps/{{appId}}/conversations",
"description": "Create a conversation for the specified user(s)."
},
"response": [
{
"id": "04d65a14-1557-46bb-a278-f68f4139173c",
"name": "App not found",
"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\": \"personal\",\n \"participants\": [\n {\n \"userId\": \"42589ad070d43be9b00ff7e5\",\n \"subscribeSDKClient\": false\n },\n {\n \"userId\": \"42589ad070d43be9b00ff7e5\",\n \"subscribeSDKClient\": false\n }\n ],\n \"displayName\": \"nost\",\n \"description\": \"Conversation between Rogers and Carl.\",\n \"iconUrl\": \"https://www.gravatar.com/image.jpg\",\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/conversations",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"conversations"
],
"variable": [
{
"key": "appId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"id": "cb8fc1a2-02f1-4c6b-8a0c-311004d1d2ba",
"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\": \"personal\",\n \"participants\": [\n {\n \"userId\": \"42589ad070d43be9b00ff7e5\",\n \"subscribeSDKClient\": false\n },\n {\n \"userId\": \"42589ad070d43be9b00ff7e5\",\n \"subscribeSDKClient\": false\n }\n ],\n \"displayName\": \"nost\",\n \"description\": \"Conversation between Rogers and Carl.\",\n \"iconUrl\": \"https://www.gravatar.com/image.jpg\",\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/conversations",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"conversations"
],
"variable": [
{
"key": "appId"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"conversation\": {\n \"id\": \"c93bb9c14dde8ffb94564eae\",\n \"type\": \"personal\",\n \"activeSwitchboardIntegration\": {\n \"id\": \"5ef21b86e933b7355c11c604\",\n \"name\": \"bot\",\n \"integrationId\": \"5ef21b86e933b7355c11c605\",\n \"integrationType\": \"zd:agentWorkspace\"\n },\n \"pendingSwitchboardIntegration\": {\n \"id\": \"5ef21b86e933b7355c11c604\",\n \"name\": \"bot\",\n \"integrationId\": \"5ef21b86e933b7355c11c605\",\n \"integrationType\": \"zd:agentWorkspace\"\n },\n \"isDefault\": false,\n \"displayName\": \"pari\",\n \"description\": \"Conversation between Rogers and Carl.\",\n \"iconUrl\": \"https://www.gravatar.com/image.jpg\",\n \"metadata\": {\n \"lang\": \"en-ca\"\n },\n \"businessLastRead\": \"2020-06-23T14:33:47.492Z\",\n \"lastUpdatedAt\": \"2020-06-26T14:33:47.120Z\"\n }\n}"
}
]
}
