Chilkat Online Tools

Ruby / Sunshine Conversations API / Create Client

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.

# {
#   "matchCriteria": {
#     "type": "mailgun",
#     "integrationId": "582dedf230e788746891281a",
#     "primary": true,
#     "address": "steveb@channel5.com",
#     "subject": "New message from {appName}"
#   },
#   "confirmation": {
#     "type": "immediate",
#     "message": {
#       "author": {
#         "type": "business",
#         "displayName": "Steve",
#         "avatarUrl": "https://www.gravatar.com/image.jpg"
#       },
#       "content": {
#         "type": "text",
#         "text": "Hello!"
#       },
#       "metadata": {
#         "lang": "en-ca"
#       }
#     }
#   },
#   "target": {
#     "conversationId": "029c31f25a21b47effd7be90"
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("matchCriteria.type","mailgun")
json.UpdateString("matchCriteria.integrationId","582dedf230e788746891281a")
json.UpdateBool("matchCriteria.primary",true)
json.UpdateString("matchCriteria.address","steveb@channel5.com")
json.UpdateString("matchCriteria.subject","New message from {appName}")
json.UpdateString("confirmation.type","immediate")
json.UpdateString("confirmation.message.author.type","business")
json.UpdateString("confirmation.message.author.displayName","Steve")
json.UpdateString("confirmation.message.author.avatarUrl","https://www.gravatar.com/image.jpg")
json.UpdateString("confirmation.message.content.type","text")
json.UpdateString("confirmation.message.content.text","Hello!")
json.UpdateString("confirmation.message.metadata.lang","en-ca")
json.UpdateString("target.conversationId","029c31f25a21b47effd7be90")

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

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId/clients","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

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "client": {
#     "id": "5c9a34160c89726709136733",
#     "type": "telegram",
#     "status": "active",
#     "integrationId": "582dedf230e788746891281a",
#     "externalId": "your-own-id",
#     "lastSeen": "2020-08-20T16:13:07.462Z",
#     "linkedAt": "2020-06-23T14:33:47.492Z",
#     "displayName": "Steve",
#     "avatarUrl": "http://AKMiIDqXoOMCR.yuTZ,HeliL7IBkYuXRbpDPiRbgkrM.MhjHjbX2QqdToaIYNnnWYb8",
#     "info": {},
#     "raw": {}
#   }
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Id = jResp.stringOf("client.id")
v_Type = jResp.stringOf("client.type")
Status = jResp.stringOf("client.status")
IntegrationId = jResp.stringOf("client.integrationId")
ExternalId = jResp.stringOf("client.externalId")
LastSeen = jResp.stringOf("client.lastSeen")
LinkedAt = jResp.stringOf("client.linkedAt")
DisplayName = jResp.stringOf("client.displayName")
AvatarUrl = jResp.stringOf("client.avatarUrl")

Curl Command

curl -X POST
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "matchCriteria": {
        "type": "mailgun",
        "integrationId": "582dedf230e788746891281a",
        "primary": true,
        "address": "steveb@channel5.com",
        "subject": "New message from {appName}"
    },
    "confirmation": {
        "type": "immediate",
        "message": {
            "author": {
                "type": "business",
                "displayName": "Steve",
                "avatarUrl": "https://www.gravatar.com/image.jpg"
            },
            "content": {
                "type": "text",
                "text": "Hello!"
            },
            "metadata": {
                "lang": "en-ca"
            }
        }
    },
    "target": {
        "conversationId": "029c31f25a21b47effd7be90"
    }
}'
https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId/clients

Postman Collection Item JSON

{
  "name": "Create Client",
  "_postman_id": "e51d89dc-e2b1-4839-9eed-67dc8387cdaf",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"matchCriteria\": {\n        \"type\": \"mailgun\",\n        \"integrationId\": \"582dedf230e788746891281a\",\n        \"primary\": true,\n        \"address\": \"steveb@channel5.com\",\n        \"subject\": \"New message from {appName}\"\n    },\n    \"confirmation\": {\n        \"type\": \"immediate\",\n        \"message\": {\n            \"author\": {\n                \"type\": \"business\",\n                \"displayName\": \"Steve\",\n                \"avatarUrl\": \"https://www.gravatar.com/image.jpg\"\n            },\n            \"content\": {\n                \"type\": \"text\",\n                \"text\": \"Hello!\"\n            },\n            \"metadata\": {\n                \"lang\": \"en-ca\"\n            }\n        }\n    },\n    \"target\": {\n        \"conversationId\": \"029c31f25a21b47effd7be90\"\n    }\n}"
    },
    "url": {
      "raw": "{{url}}/v2/apps/{{appId}}/users/:userIdOrExternalId/clients",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "users",
        ":userIdOrExternalId",
        "clients"
      ],
      "variable": [
        {
          "key": "userIdOrExternalId"
        }
      ]
    },
    "description": "Create a client and link it to a channel specified by the matchCriteria.type."
  },
  "response": [
    {
      "id": "74e580bd-67c5-486e-a95e-0e37794255b3",
      "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    \"matchCriteria\": {\n        \"type\": \"mailgun\",\n        \"integrationId\": \"582dedf230e788746891281a\",\n        \"primary\": true,\n        \"address\": \"steveb@channel5.com\",\n        \"subject\": \"New message from {appName}\"\n    },\n    \"confirmation\": {\n        \"type\": \"immediate\",\n        \"message\": {\n            \"author\": {\n                \"type\": \"business\",\n                \"displayName\": \"Steve\",\n                \"avatarUrl\": \"https://www.gravatar.com/image.jpg\"\n            },\n            \"content\": {\n                \"type\": \"text\",\n                \"text\": \"Hello!\"\n            },\n            \"metadata\": {\n                \"lang\": \"en-ca\"\n            }\n        }\n    },\n    \"target\": {\n        \"conversationId\": \"029c31f25a21b47effd7be90\"\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/users/:userIdOrExternalId/clients",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "users",
            ":userIdOrExternalId",
            "clients"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "userIdOrExternalId"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"client\": {\n  \"id\": \"5c9a34160c89726709136733\",\n  \"type\": \"telegram\",\n  \"status\": \"active\",\n  \"integrationId\": \"582dedf230e788746891281a\",\n  \"externalId\": \"your-own-id\",\n  \"lastSeen\": \"2020-08-20T16:13:07.462Z\",\n  \"linkedAt\": \"2020-06-23T14:33:47.492Z\",\n  \"displayName\": \"Steve\",\n  \"avatarUrl\": \"http://AKMiIDqXoOMCR.yuTZ,HeliL7IBkYuXRbpDPiRbgkrM.MhjHjbX2QqdToaIYNnnWYb8\",\n  \"info\": {},\n  \"raw\": {}\n }\n}"
    }
  ]
}