Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcReceived
LOCAL lcV_Type
LOCAL lcDisplayName
LOCAL lcAvatarUrl
LOCAL lcContentType
LOCAL lcText
LOCAL lcLang
LOCAL lcSourceType
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.BasicAuth = 1
loHttp.Login = "username"
loHttp.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"
* }
* }
loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("author.type","business")
loJson.UpdateString("author.displayName","Steve")
loJson.UpdateString("author.avatarUrl","https://www.gravatar.com/image.jpg")
loJson.UpdateString("content.type","text")
loJson.UpdateString("content.text","Hello!")
loJson.UpdateString("metadata.lang","en-ca")
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.PostJson3("https://domain.com/","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
i = 0
lnCount_i = loJResp.SizeOfArray("messages")
DO WHILE i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("messages[i].id")
lcReceived = loJResp.StringOf("messages[i].received")
lcV_Type = loJResp.StringOf("messages[i].author.type")
lcDisplayName = loJResp.StringOf("messages[i].author.displayName")
lcAvatarUrl = loJResp.StringOf("messages[i].author.avatarUrl")
lcContentType = loJResp.StringOf("messages[i].content.type")
lcText = loJResp.StringOf("messages[i].content.text")
lcLang = loJResp.StringOf("messages[i].metadata.lang")
lcSourceType = loJResp.StringOf("messages[i].source.type")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
