Chilkat Online Tools

Ruby / Sunshine Conversations API / Post Activity

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("username")
http.put_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.

# {
#   "author": {
#     "type": "user",
#     "userId": "5963c0d619a30a2e00de36b8"
#   },
#   "type": "conversation:read"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("author.type","user")
json.UpdateString("author.userId","5963c0d619a30a2e00de36b8")
json.UpdateString("type","conversation:read")

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

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

Curl Command

curl -X POST
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "author": {
        "type": "user",
        "userId": "5963c0d619a30a2e00de36b8"
    },
    "type": "conversation:read"
}'
https://domain.com/

Postman Collection Item JSON

{
  "name": "Post Activity",
  "_postman_id": "5c795888-a93c-412f-9a6a-08f8f9363920",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"author\": {\n        \"type\": \"user\",\n        \"userId\": \"5963c0d619a30a2e00de36b8\"\n    },\n    \"type\": \"conversation:read\"\n}"
    },
    "url": "{{url}}/v2/apps/{{appId}}/conversations/{{conversationId}}/activity",
    "description": "Notify Sunshine Conversations of different conversation activities. Supported activity types are:\n* Typing activity\n* Conversation read event\n"
  },
  "response": [
    {
      "id": "0b684a54-f943-4b76-ac08-2dc014091c85",
      "name": "Ok",
      "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    \"author\": {\n        \"type\": \"user\",\n        \"userId\": \"5963c0d619a30a2e00de36b8\"\n    },\n    \"type\": \"conversation:read\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/conversations/:conversationId/activity",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "conversations",
            ":conversationId",
            "activity"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "conversationId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{}"
    }
  ]
}