Chilkat Online Tools

VB.NET / Sunshine Conversations API / Post Message

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

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"
'   }
' }

Dim json As New Chilkat.JsonObject
json.UpdateString("author.type","business")
json.UpdateString("author.displayName","Steve")
json.UpdateString("author.avatarUrl","https://www.gravatar.com/image.jpg")
json.UpdateString("content.type","text")
json.UpdateString("content.text","Hello!")
json.UpdateString("metadata.lang","en-ca")

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

Dim resp As Chilkat.HttpResponse = http.PostJson3("https://domain.com/","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("Failed.")

    Exit Sub
End If



' 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



Dim id As String
Dim received As String
Dim v_Type As String
Dim DisplayName As String
Dim AvatarUrl As String
Dim contentType As String
Dim Text As String
Dim Lang As String
Dim sourceType As String

Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("messages")
While i < count_i
    jResp.I = i
    id = jResp.StringOf("messages[i].id")
    received = jResp.StringOf("messages[i].received")
    v_Type = jResp.StringOf("messages[i].author.type")
    DisplayName = jResp.StringOf("messages[i].author.displayName")
    AvatarUrl = jResp.StringOf("messages[i].author.avatarUrl")
    contentType = jResp.StringOf("messages[i].content.type")
    Text = jResp.StringOf("messages[i].content.text")
    Lang = jResp.StringOf("messages[i].metadata.lang")
    sourceType = jResp.StringOf("messages[i].source.type")
    i = i + 1
End While

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