Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_V_type
string ls_ClientId
string ls_Id
string ls_UserId
integer li_UnreadCount
string ls_UserExternalId
string ls_LastRead
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "username"
loo_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.
// {
// "userId": "42589ad070d43be9b00ff7e5",
// "subscribeSDKClient": false
// }
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_Json.UpdateString("userId","42589ad070d43be9b00ff7e5")
loo_Json.UpdateBool("subscribeSDKClient",0)
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Resp = loo_Http.PostJson3("https://domain.com/","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "participant": {
// "id": "c93bb9c14dde8ffb94564eae",
// "userId": "42589ad070d43be9b00ff7e5",
// "unreadCount": 0,
// "clientAssociations": [
// {
// "type": "telegram",
// "clientId": "42589ad070d43be9b00ff7e5"
// },
// {
// "type": "telegram",
// "clientId": "42589ad070d43be9b00ff7e5"
// }
// ],
// "userExternalId": "your-own-id",
// "lastRead": "2019-01-14T18:55:12.515Z"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Id = loo_JResp.StringOf("participant.id")
ls_UserId = loo_JResp.StringOf("participant.userId")
li_UnreadCount = loo_JResp.IntOf("participant.unreadCount")
ls_UserExternalId = loo_JResp.StringOf("participant.userExternalId")
ls_LastRead = loo_JResp.StringOf("participant.lastRead")
i = 0
li_Count_i = loo_JResp.SizeOfArray("participant.clientAssociations")
do while i < li_Count_i
loo_JResp.I = i
ls_V_type = loo_JResp.StringOf("participant.clientAssociations[i].type")
ls_ClientId = loo_JResp.StringOf("participant.clientAssociations[i].clientId")
i = i + 1
loop
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X POST
-u 'username:password'
-H "Content-Type: application/json"
-d '{
"userId": "42589ad070d43be9b00ff7e5",
"subscribeSDKClient": false
}'
https://domain.com/
Postman Collection Item JSON
{
"name": "Join Conversation",
"_postman_id": "185b1369-9a43-41a4-a274-81fa30f2a53b",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"userId\": \"42589ad070d43be9b00ff7e5\",\n \"subscribeSDKClient\": false\n}"
},
"url": "{{url}}/v2/apps/{{appId}}/conversations/{{conversationId}}/join",
"description": "Adds a user to a conversation using either their userId or userExternalId. The endpoint only\nsupports adding a participant to a sdkGroup conversation.\n"
},
"response": [
{
"id": "019219b1-cf37-47f5-856f-f8bcace7ac4d",
"name": "Too many participants",
"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 \"userId\": \"42589ad070d43be9b00ff7e5\",\n \"subscribeSDKClient\": false\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/conversations/:conversationId/join",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"conversations",
":conversationId",
"join"
],
"variable": [
{
"key": "appId"
},
{
"key": "conversationId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"id": "30b353f8-bbca-47db-b21e-97218a2d50f0",
"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 \"userId\": \"42589ad070d43be9b00ff7e5\",\n \"subscribeSDKClient\": false\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/conversations/:conversationId/join",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"conversations",
":conversationId",
"join"
],
"variable": [
{
"key": "appId"
},
{
"key": "conversationId"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"participant\": {\n \"id\": \"c93bb9c14dde8ffb94564eae\",\n \"userId\": \"42589ad070d43be9b00ff7e5\",\n \"unreadCount\": 0,\n \"clientAssociations\": [\n {\n \"type\": \"telegram\",\n \"clientId\": \"42589ad070d43be9b00ff7e5\"\n },\n {\n \"type\": \"telegram\",\n \"clientId\": \"42589ad070d43be9b00ff7e5\"\n }\n ],\n \"userExternalId\": \"your-own-id\",\n \"lastRead\": \"2019-01-14T18:55:12.515Z\"\n }\n}"
},
{
"id": "a12e66e5-6748-4f9a-87a3-a5cefad55a7a",
"name": "Conversation 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 \"userId\": \"42589ad070d43be9b00ff7e5\",\n \"subscribeSDKClient\": false\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/conversations/:conversationId/join",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"conversations",
":conversationId",
"join"
],
"variable": [
{
"key": "appId"
},
{
"key": "conversationId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
