Chilkat Online Tools

Swift / Sunshine Conversations API / Join Conversation

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    http.BasicAuth = true
    http.Login = "username"
    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
    // }

    let json = CkoJsonObject()
    json.UpdateString("userId", value: "42589ad070d43be9b00ff7e5")
    json.UpdateBool("subscribeSDKClient", value: false)

    http.SetRequestHeader("Content-Type", value: "application/json")

    var resp: CkoHttpResponse? = http.PostJson3("https://domain.com/", contentType: "application/json", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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

    var v_type: String?
    var clientId: String?

    var Id: String? = jResp.StringOf("participant.id")
    var UserId: String? = jResp.StringOf("participant.userId")
    var UnreadCount: Int = jResp.IntOf("participant.unreadCount").intValue
    var UserExternalId: String? = jResp.StringOf("participant.userExternalId")
    var LastRead: String? = jResp.StringOf("participant.lastRead")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("participant.clientAssociations").intValue
    while i < count_i {
        jResp.I = i
        v_type = jResp.StringOf("participant.clientAssociations[i].type")
        clientId = jResp.StringOf("participant.clientAssociations[i].clientId")
        i = i + 1
    }


}

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