Chilkat Online Tools

delphiAx / Sunshine Conversations API / Post Message

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
id: WideString;
received: WideString;
v_Type: WideString;
DisplayName: WideString;
AvatarUrl: WideString;
contentType: WideString;
Text: WideString;
Lang: WideString;
sourceType: WideString;
i: Integer;
count_i: Integer;

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

http := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
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"
//   }
// }

json := TChilkatJsonObject.Create(Self);
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');

resp := http.PostJson3('https://domain.com/','application/json',json.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

// 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;
count_i := jResp.SizeOfArray('messages');
while i < count_i do
  begin
    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;

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