Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "username"
CkHttp_put_Password $http "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"
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "type" "personal"
CkJsonObject_UpdateString $json "participants[0].userId" "42589ad070d43be9b00ff7e5"
CkJsonObject_UpdateBool $json "participants[0].subscribeSDKClient" 0
CkJsonObject_UpdateString $json "participants[1].userId" "42589ad070d43be9b00ff7e5"
CkJsonObject_UpdateBool $json "participants[1].subscribeSDKClient" 0
CkJsonObject_UpdateString $json "displayName" "nost"
CkJsonObject_UpdateString $json "description" "Conversation between Rogers and Carl."
CkJsonObject_UpdateString $json "iconUrl" "https://www.gravatar.com/image.jpg"
CkJsonObject_UpdateString $json "metadata.lang" "en-ca"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set Id [CkJsonObject_stringOf $jResp "conversation.id"]
set v_Type [CkJsonObject_stringOf $jResp "conversation.type"]
set ActiveSwitchboardIntegrationId [CkJsonObject_stringOf $jResp "conversation.activeSwitchboardIntegration.id"]
set Name [CkJsonObject_stringOf $jResp "conversation.activeSwitchboardIntegration.name"]
set IntegrationId [CkJsonObject_stringOf $jResp "conversation.activeSwitchboardIntegration.integrationId"]
set IntegrationType [CkJsonObject_stringOf $jResp "conversation.activeSwitchboardIntegration.integrationType"]
set PendingSwitchboardIntegrationId [CkJsonObject_stringOf $jResp "conversation.pendingSwitchboardIntegration.id"]
set PendingSwitchboardIntegrationName [CkJsonObject_stringOf $jResp "conversation.pendingSwitchboardIntegration.name"]
set PendingSwitchboardIntegrationIntegrationId [CkJsonObject_stringOf $jResp "conversation.pendingSwitchboardIntegration.integrationId"]
set PendingSwitchboardIntegrationIntegrationType [CkJsonObject_stringOf $jResp "conversation.pendingSwitchboardIntegration.integrationType"]
set IsDefault [CkJsonObject_BoolOf $jResp "conversation.isDefault"]
set DisplayName [CkJsonObject_stringOf $jResp "conversation.displayName"]
set Description [CkJsonObject_stringOf $jResp "conversation.description"]
set IconUrl [CkJsonObject_stringOf $jResp "conversation.iconUrl"]
set Lang [CkJsonObject_stringOf $jResp "conversation.metadata.lang"]
set BusinessLastRead [CkJsonObject_stringOf $jResp "conversation.businessLastRead"]
set LastUpdatedAt [CkJsonObject_stringOf $jResp "conversation.lastUpdatedAt"]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}