Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "username"
$oHttp.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"
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("type","personal")
$oJson.UpdateString("participants[0].userId","42589ad070d43be9b00ff7e5")
$oJson.UpdateBool("participants[0].subscribeSDKClient",False)
$oJson.UpdateString("participants[1].userId","42589ad070d43be9b00ff7e5")
$oJson.UpdateBool("participants[1].subscribeSDKClient",False)
$oJson.UpdateString("displayName","nost")
$oJson.UpdateString("description","Conversation between Rogers and Carl.")
$oJson.UpdateString("iconUrl","https://www.gravatar.com/image.jpg")
$oJson.UpdateString("metadata.lang","en-ca")
$oHttp.SetRequestHeader "Content-Type","application/json"
Local $oResp = $oHttp.PostJson3("https://domain.com/","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sId = $oJResp.StringOf("conversation.id")
Local $sV_Type = $oJResp.StringOf("conversation.type")
Local $sActiveSwitchboardIntegrationId = $oJResp.StringOf("conversation.activeSwitchboardIntegration.id")
Local $sName = $oJResp.StringOf("conversation.activeSwitchboardIntegration.name")
Local $sIntegrationId = $oJResp.StringOf("conversation.activeSwitchboardIntegration.integrationId")
Local $sIntegrationType = $oJResp.StringOf("conversation.activeSwitchboardIntegration.integrationType")
Local $sPendingSwitchboardIntegrationId = $oJResp.StringOf("conversation.pendingSwitchboardIntegration.id")
Local $sPendingSwitchboardIntegrationName = $oJResp.StringOf("conversation.pendingSwitchboardIntegration.name")
Local $sPendingSwitchboardIntegrationIntegrationId = $oJResp.StringOf("conversation.pendingSwitchboardIntegration.integrationId")
Local $sPendingSwitchboardIntegrationIntegrationType = $oJResp.StringOf("conversation.pendingSwitchboardIntegration.integrationType")
Local $bIsDefault = $oJResp.BoolOf("conversation.isDefault")
Local $sDisplayName = $oJResp.StringOf("conversation.displayName")
Local $sDescription = $oJResp.StringOf("conversation.description")
Local $sIconUrl = $oJResp.StringOf("conversation.iconUrl")
Local $sLang = $oJResp.StringOf("conversation.metadata.lang")
Local $sBusinessLastRead = $oJResp.StringOf("conversation.businessLastRead")
Local $sLastUpdatedAt = $oJResp.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}"
}
]
}
