Chilkat Online Tools

Swift3 / Sunshine Conversations API / Post Message

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.

    // {
    //   "author": {
    //     "type": "business",
    //     "displayName": "Steve",
    //     "avatarUrl": "https://www.gravatar.com/image.jpg"
    //   },
    //   "content": {
    //     "type": "text",
    //     "text": "Hello!"
    //   },
    //   "metadata": {
    //     "lang": "en-ca"
    //   }
    // }

    let json = CkoJsonObject()!
    json.update("author.type", value: "business")
    json.update("author.displayName", value: "Steve")
    json.update("author.avatarUrl", value: "https://www.gravatar.com/image.jpg")
    json.update("content.type", value: "text")
    json.update("content.text", value: "Hello!")
    json.update("metadata.lang", value: "en-ca")

    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)

    // {
    //   "messages": [
    //     {
    //       "id": "5f748c1a2b5315fc007e7977",
    //       "received": "2020-09-30T13:46:02.733Z",
    //       "author": {
    //         "type": "business",
    //         "displayName": "Steve",
    //         "avatarUrl": "https://www.gravatar.com/image.jpg"
    //       },
    //       "content": {
    //         "type": "text",
    //         "text": "Hello!"
    //       },
    //       "metadata": {
    //         "lang": "en-ca"
    //       },
    //       "source": {
    //         "type": "api:conversations"
    //       }
    //     }
    //   ]
    // }

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

    var id: String?
    var received: String?
    var v_Type: String?
    var DisplayName: String?
    var AvatarUrl: String?
    var contentType: String?
    var Text: String?
    var Lang: String?
    var sourceType: String?

    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "messages").intValue
    while i < count_i {
        jResp.i = i
        id = jResp.string(of: "messages[i].id")
        received = jResp.string(of: "messages[i].received")
        v_Type = jResp.string(of: "messages[i].author.type")
        DisplayName = jResp.string(of: "messages[i].author.displayName")
        AvatarUrl = jResp.string(of: "messages[i].author.avatarUrl")
        contentType = jResp.string(of: "messages[i].content.type")
        Text = jResp.string(of: "messages[i].content.text")
        Lang = jResp.string(of: "messages[i].metadata.lang")
        sourceType = jResp.string(of: "messages[i].source.type")
        i = i + 1
    }


}

Curl Command

curl -X POST
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "author": {
        "type": "business",
        "displayName": "Steve",
        "avatarUrl": "https://www.gravatar.com/image.jpg"
    },
    "content": {
        "type": "text",
        "text": "Hello!"
    },
    "metadata": {
        "lang": "en-ca"
    }
}'
https://domain.com/

Postman Collection Item JSON

{
  "name": "Post Message",
  "_postman_id": "28e280a8-5ef8-4ca0-90fc-788603ddd036",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\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}"
    },
    "url": "{{url}}/v2/apps/{{appId}}/conversations/{{conversationId}}/messages",
    "description": "Send a message in a particular conversation."
  },
  "response": [
    {
      "id": "f660acde-ae81-4787-b433-18bf650ddef6",
      "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    \"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}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/conversations/:conversationId/messages",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "conversations",
            ":conversationId",
            "messages"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "conversationId"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"messages\": [\n  {\n   \"id\": \"5f748c1a2b5315fc007e7977\",\n   \"received\": \"2020-09-30T13:46:02.733Z\",\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   \"source\": {\n    \"type\": \"api:conversations\"\n   }\n  }\n ]\n}"
    }
  ]
}