Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "username"
CkHttp_put_Password $http "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"
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "author.type" "business"
CkJsonObject_UpdateString $json "author.displayName" "Steve"
CkJsonObject_UpdateString $json "author.avatarUrl" "https://www.gravatar.com/image.jpg"
CkJsonObject_UpdateString $json "content.type" "text"
CkJsonObject_UpdateString $json "content.text" "Hello!"
CkJsonObject_UpdateString $json "metadata.lang" "en-ca"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "messages"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "messages[i].id"]
set received [CkJsonObject_stringOf $jResp "messages[i].received"]
set v_Type [CkJsonObject_stringOf $jResp "messages[i].author.type"]
set DisplayName [CkJsonObject_stringOf $jResp "messages[i].author.displayName"]
set AvatarUrl [CkJsonObject_stringOf $jResp "messages[i].author.avatarUrl"]
set contentType [CkJsonObject_stringOf $jResp "messages[i].content.type"]
set Text [CkJsonObject_stringOf $jResp "messages[i].content.text"]
set Lang [CkJsonObject_stringOf $jResp "messages[i].metadata.lang"]
set sourceType [CkJsonObject_stringOf $jResp "messages[i].source.type"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
