Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcV_Type
LOCAL lcActiveSwitchboardIntegrationId
LOCAL lcName
LOCAL lcIntegrationId
LOCAL lcIntegrationType
LOCAL lcPendingSwitchboardIntegrationId
LOCAL lcPendingSwitchboardIntegrationName
LOCAL lcPendingSwitchboardIntegrationIntegrationId
LOCAL lcPendingSwitchboardIntegrationIntegrationType
LOCAL lnIsDefault
LOCAL lcDisplayName
LOCAL lcDescription
LOCAL lcIconUrl
LOCAL lcLang
LOCAL lcBusinessLastRead
LOCAL lcLastUpdatedAt
* 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": "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"
* }
* }
loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("type","personal")
loJson.UpdateString("participants[0].userId","42589ad070d43be9b00ff7e5")
loJson.UpdateBool("participants[0].subscribeSDKClient",0)
loJson.UpdateString("participants[1].userId","42589ad070d43be9b00ff7e5")
loJson.UpdateBool("participants[1].subscribeSDKClient",0)
loJson.UpdateString("displayName","nost")
loJson.UpdateString("description","Conversation between Rogers and Carl.")
loJson.UpdateString("iconUrl","https://www.gravatar.com/image.jpg")
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)
* {
* "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
lcId = loJResp.StringOf("conversation.id")
lcV_Type = loJResp.StringOf("conversation.type")
lcActiveSwitchboardIntegrationId = loJResp.StringOf("conversation.activeSwitchboardIntegration.id")
lcName = loJResp.StringOf("conversation.activeSwitchboardIntegration.name")
lcIntegrationId = loJResp.StringOf("conversation.activeSwitchboardIntegration.integrationId")
lcIntegrationType = loJResp.StringOf("conversation.activeSwitchboardIntegration.integrationType")
lcPendingSwitchboardIntegrationId = loJResp.StringOf("conversation.pendingSwitchboardIntegration.id")
lcPendingSwitchboardIntegrationName = loJResp.StringOf("conversation.pendingSwitchboardIntegration.name")
lcPendingSwitchboardIntegrationIntegrationId = loJResp.StringOf("conversation.pendingSwitchboardIntegration.integrationId")
lcPendingSwitchboardIntegrationIntegrationType = loJResp.StringOf("conversation.pendingSwitchboardIntegration.integrationType")
lnIsDefault = loJResp.BoolOf("conversation.isDefault")
lcDisplayName = loJResp.StringOf("conversation.displayName")
lcDescription = loJResp.StringOf("conversation.description")
lcIconUrl = loJResp.StringOf("conversation.iconUrl")
lcLang = loJResp.StringOf("conversation.metadata.lang")
lcBusinessLastRead = loJResp.StringOf("conversation.businessLastRead")
lcLastUpdatedAt = loJResp.StringOf("conversation.lastUpdatedAt")
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
