Chilkat Online Tools

autoit / Sunshine Conversations API / Join Conversation

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.

; {
;   "userId": "42589ad070d43be9b00ff7e5",
;   "subscribeSDKClient": false
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("userId","42589ad070d43be9b00ff7e5")
$oJson.UpdateBool("subscribeSDKClient",False)

$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)

; {
;   "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

Local $sV_type
Local $sClientId

Local $sId = $oJResp.StringOf("participant.id")
Local $sUserId = $oJResp.StringOf("participant.userId")
Local $iUnreadCount = $oJResp.IntOf("participant.unreadCount")
Local $sUserExternalId = $oJResp.StringOf("participant.userExternalId")
Local $sLastRead = $oJResp.StringOf("participant.lastRead")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("participant.clientAssociations")
While $i < $iCount_i
    $oJResp.I = $i
    $sV_type = $oJResp.StringOf("participant.clientAssociations[i].type")
    $sClientId = $oJResp.StringOf("participant.clientAssociations[i].clientId")
    $i = $i + 1
Wend

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": ""
    }
  ]
}