Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
additionalLabel: WideString;
communityNickname: WideString;
companyName: WideString;
displayName: WideString;
firstName: WideString;
isActive: Integer;
isInThisCommunity: Integer;
lastName: WideString;
motifColor: WideString;
motifLargeIconUrl: WideString;
motifMediumIconUrl: WideString;
motifSmallIconUrl: WideString;
motifSvgIconUrl: WideString;
mySubscription: WideString;
name: WideString;
outOfOfficeMessage: WideString;
photoFullEmailPhotoUrl: WideString;
photoLargePhotoUrl: WideString;
photoMediumPhotoUrl: WideString;
photoPhotoVersionId: WideString;
photoSmallPhotoUrl: WideString;
photoStandardEmailPhotoUrl: WideString;
photoUrl: WideString;
reputation: WideString;
title: WideString;
v_type: WideString;
userType: WideString;
IsRichText: WideString;
Text: WideString;
conversationId: WideString;
conversationUrl: WideString;
id: WideString;
AdditionalLabel: WideString;
CommunityNickname: WideString;
CompanyName: WideString;
DisplayName: WideString;
FirstName: WideString;
Id: WideString;
IsActive: Integer;
IsInThisCommunity: Integer;
LastName: WideString;
Color: WideString;
LargeIconUrl: WideString;
MediumIconUrl: WideString;
SmallIconUrl: WideString;
SvgIconUrl: WideString;
MySubscription: WideString;
Name: WideString;
Message: WideString;
FullEmailPhotoUrl: WideString;
LargePhotoUrl: WideString;
MediumPhotoUrl: WideString;
PhotoVersionId: WideString;
SmallPhotoUrl: WideString;
StandardEmailPhotoUrl: WideString;
v_Url: WideString;
Reputation: WideString;
Title: WideString;
v_Type: WideString;
senderUrl: WideString;
UserType: WideString;
sendingCommunity: WideString;
sentDate: WideString;
url: 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);
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
resp := http.QuickRequest('POST','message&recipients=<USER1_ID>,<USER2_ID>');
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)
// {
// "body": {
// "isRichText": null,
// "messageSegments": [
// ],
// "text": "This is a private message"
// },
// "conversationId": "03M...",
// "conversationUrl": "/services/data/v58.0/chatter/users/me/conversations/03M...",
// "id": "03J...",
// "recipients": [
// {
// "additionalLabel": null,
// "communityNickname": "automatedprocess",
// "companyName": "Salesforce",
// "displayName": "Automated Process",
// "firstName": "Automated",
// "id": "005...",
// "isActive": true,
// "isInThisCommunity": true,
// "lastName": "Process",
// "motif": {
// "color": "1B96FF",
// "largeIconUrl": "/img/icon/profile64.png",
// "mediumIconUrl": "/img/icon/profile32.png",
// "smallIconUrl": "/img/icon/profile16.png",
// "svgIconUrl": null
// },
// "mySubscription": null,
// "name": "Automated Process",
// "outOfOffice": {
// "message": ""
// },
// "photo": {
// "fullEmailPhotoUrl": "https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1",
// "largePhotoUrl": "https://<my_domain>/profilephoto/005/F",
// "mediumPhotoUrl": "https://<my_domain>/profilephoto/005/M",
// "photoVersionId": null,
// "smallPhotoUrl": "https://<my_domain>/profilephoto/005/T",
// "standardEmailPhotoUrl": "https://<my_domain>/img/userprofile/default_profile_45_v2.png?fromEmail=1",
// "url": "/services/data/v58.0/connect/user-profiles/005.../photo"
// },
// "reputation": null,
// "title": null,
// "type": "User",
// "url": "/services/data/v58.0/chatter/users/005...",
// "userType": "System"
// },
// {
// "additionalLabel": null,
// "communityNickname": "User1696423780773910041",
// "companyName": "Salesforce",
// "displayName": "Name",
// "firstName": "FirstName",
// "id": "005...",
// "isActive": true,
// "isInThisCommunity": true,
// "lastName": "Name",
// "motif": {
// "color": "1B96FF",
// "largeIconUrl": "/img/icon/profile64.png",
// "mediumIconUrl": "/img/icon/profile32.png",
// "smallIconUrl": "/img/icon/profile16.png",
// "svgIconUrl": null
// },
// "mySubscription": null,
// "name": "Name",
// "outOfOffice": {
// "message": ""
// },
// "photo": {
// "fullEmailPhotoUrl": "https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1",
// "largePhotoUrl": "https://<my_domain>/profilephoto/729.../F",
// "mediumPhotoUrl": "https://<my_domain>/profilephoto/729.../M",
// "photoVersionId": "729...",
// "smallPhotoUrl": "https://<my_domain>/profilephoto/729.../T",
// "standardEmailPhotoUrl": "https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1",
// "url": "/services/data/v58.0/connect/user-profiles/005.../photo"
// },
// "reputation": null,
// "title": null,
// "type": "User",
// "url": "/services/data/v58.0/chatter/users/005...",
// "userType": "Internal"
// }
// ],
// "sender": {
// "additionalLabel": null,
// "communityNickname": "User1696423780773910041",
// "companyName": "Salesforce",
// "displayName": "Name",
// "firstName": "Firstname",
// "id": "005...",
// "isActive": true,
// "isInThisCommunity": true,
// "lastName": "Name",
// "motif": {
// "color": "1B96FF",
// "largeIconUrl": "/img/icon/profile64.png",
// "mediumIconUrl": "/img/icon/profile32.png",
// "smallIconUrl": "/img/icon/profile16.png",
// "svgIconUrl": null
// },
// "mySubscription": null,
// "name": "Name",
// "outOfOffice": {
// "message": ""
// },
// "photo": {
// "fullEmailPhotoUrl": "https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1",
// "largePhotoUrl": "https://<my_domain>/profilephoto/729.../F",
// "mediumPhotoUrl": "https://<my_domain>/profilephoto/729.../M",
// "photoVersionId": "729...",
// "smallPhotoUrl": "https://<my_domain>/profilephoto/729.../T",
// "standardEmailPhotoUrl": "https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1",
// "url": "/services/data/v58.0/connect/user-profiles/005.../photo"
// },
// "reputation": null,
// "title": null,
// "type": "User",
// "url": "/services/data/v58.0/chatter/users/005...",
// "userType": "Internal"
// },
// "sendingCommunity": null,
// "sentDate": "<datetime>",
// "url": "/services/data/v58.0/chatter/users/me/messages/03J..."
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
IsRichText := jResp.StringOf('body.isRichText');
Text := jResp.StringOf('body.text');
conversationId := jResp.StringOf('conversationId');
conversationUrl := jResp.StringOf('conversationUrl');
id := jResp.StringOf('id');
AdditionalLabel := jResp.StringOf('sender.additionalLabel');
CommunityNickname := jResp.StringOf('sender.communityNickname');
CompanyName := jResp.StringOf('sender.companyName');
DisplayName := jResp.StringOf('sender.displayName');
FirstName := jResp.StringOf('sender.firstName');
Id := jResp.StringOf('sender.id');
IsActive := jResp.BoolOf('sender.isActive');
IsInThisCommunity := jResp.BoolOf('sender.isInThisCommunity');
LastName := jResp.StringOf('sender.lastName');
Color := jResp.StringOf('sender.motif.color');
LargeIconUrl := jResp.StringOf('sender.motif.largeIconUrl');
MediumIconUrl := jResp.StringOf('sender.motif.mediumIconUrl');
SmallIconUrl := jResp.StringOf('sender.motif.smallIconUrl');
SvgIconUrl := jResp.StringOf('sender.motif.svgIconUrl');
MySubscription := jResp.StringOf('sender.mySubscription');
Name := jResp.StringOf('sender.name');
Message := jResp.StringOf('sender.outOfOffice.message');
FullEmailPhotoUrl := jResp.StringOf('sender.photo.fullEmailPhotoUrl');
LargePhotoUrl := jResp.StringOf('sender.photo.largePhotoUrl');
MediumPhotoUrl := jResp.StringOf('sender.photo.mediumPhotoUrl');
PhotoVersionId := jResp.StringOf('sender.photo.photoVersionId');
SmallPhotoUrl := jResp.StringOf('sender.photo.smallPhotoUrl');
StandardEmailPhotoUrl := jResp.StringOf('sender.photo.standardEmailPhotoUrl');
v_Url := jResp.StringOf('sender.photo.url');
Reputation := jResp.StringOf('sender.reputation');
Title := jResp.StringOf('sender.title');
v_Type := jResp.StringOf('sender.type');
senderUrl := jResp.StringOf('sender.url');
UserType := jResp.StringOf('sender.userType');
sendingCommunity := jResp.StringOf('sendingCommunity');
sentDate := jResp.StringOf('sentDate');
url := jResp.StringOf('url');
i := 0;
count_i := jResp.SizeOfArray('body.messageSegments');
while i < count_i do
begin
jResp.I := i;
i := i + 1;
end;
i := 0;
count_i := jResp.SizeOfArray('recipients');
while i < count_i do
begin
jResp.I := i;
additionalLabel := jResp.StringOf('recipients[i].additionalLabel');
communityNickname := jResp.StringOf('recipients[i].communityNickname');
companyName := jResp.StringOf('recipients[i].companyName');
displayName := jResp.StringOf('recipients[i].displayName');
firstName := jResp.StringOf('recipients[i].firstName');
id := jResp.StringOf('recipients[i].id');
isActive := jResp.BoolOf('recipients[i].isActive');
isInThisCommunity := jResp.BoolOf('recipients[i].isInThisCommunity');
lastName := jResp.StringOf('recipients[i].lastName');
motifColor := jResp.StringOf('recipients[i].motif.color');
motifLargeIconUrl := jResp.StringOf('recipients[i].motif.largeIconUrl');
motifMediumIconUrl := jResp.StringOf('recipients[i].motif.mediumIconUrl');
motifSmallIconUrl := jResp.StringOf('recipients[i].motif.smallIconUrl');
motifSvgIconUrl := jResp.StringOf('recipients[i].motif.svgIconUrl');
mySubscription := jResp.StringOf('recipients[i].mySubscription');
name := jResp.StringOf('recipients[i].name');
outOfOfficeMessage := jResp.StringOf('recipients[i].outOfOffice.message');
photoFullEmailPhotoUrl := jResp.StringOf('recipients[i].photo.fullEmailPhotoUrl');
photoLargePhotoUrl := jResp.StringOf('recipients[i].photo.largePhotoUrl');
photoMediumPhotoUrl := jResp.StringOf('recipients[i].photo.mediumPhotoUrl');
photoPhotoVersionId := jResp.StringOf('recipients[i].photo.photoVersionId');
photoSmallPhotoUrl := jResp.StringOf('recipients[i].photo.smallPhotoUrl');
photoStandardEmailPhotoUrl := jResp.StringOf('recipients[i].photo.standardEmailPhotoUrl');
photoUrl := jResp.StringOf('recipients[i].photo.url');
reputation := jResp.StringOf('recipients[i].reputation');
title := jResp.StringOf('recipients[i].title');
v_type := jResp.StringOf('recipients[i].type');
url := jResp.StringOf('recipients[i].url');
userType := jResp.StringOf('recipients[i].userType');
i := i + 1;
end;
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/chatter/users/me/messages?text=This is a private message&recipients=<USER1_ID>,<USER2_ID>
Postman Collection Item JSON
{
"name": "User Messages, General",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
},
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/chatter/users/me/messages?text=This is a private message&recipients=<USER1_ID>,<USER2_ID>",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"chatter",
"users",
"me",
"messages"
],
"query": [
{
"key": "text",
"value": "This is a private message"
},
{
"key": "inReplyTo",
"value": "<MESSAGE_ID>",
"description": "ID of an existing message that identifies which conversation this message is part of. Specify either recipients or inReplyTo. Specify one or the other, not both.",
"disabled": true
},
{
"key": "recipients",
"value": "<USER1_ID>,<USER2_ID>",
"description": "Comma-separated list of User IDs"
}
]
},
"description": "Returns all the messages for all the private conversations for the context user. Also used to search across all messages and post a message.\nTo return all private conversations for the context user, see User Conversations, General.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_users_messages_general.htm"
},
"response": [
{
"name": "Successful User Messages, General",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/chatter/users/me/messages?text=This is a private message&recipients=0052o00000DKQasAAH",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"chatter",
"users",
"me",
"messages"
],
"query": [
{
"key": "text",
"value": "This is a private message"
},
{
"key": "inReplyTo",
"value": "<MESSAGE_ID>",
"description": "ID of an existing message that identifies which conversation this message is part of. Specify either recipients or inReplyTo. Specify one or the other, not both.",
"disabled": true
},
{
"key": "recipients",
"value": "0052o00000DKQasAAH",
"description": "Comma-separated list of User IDs"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 16:22:22 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"body\": {\n \"isRichText\": null,\n \"messageSegments\": [],\n \"text\": \"This is a private message\"\n },\n \"conversationId\": \"03M...\",\n \"conversationUrl\": \"/services/data/v58.0/chatter/users/me/conversations/03M...\",\n \"id\": \"03J...\",\n \"recipients\": [\n {\n \"additionalLabel\": null,\n \"communityNickname\": \"automatedprocess\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Automated Process\",\n \"firstName\": \"Automated\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Process\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Automated Process\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1\",\n \"largePhotoUrl\": \"https://<my_domain>/profilephoto/005/F\",\n \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/005/M\",\n \"photoVersionId\": null,\n \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/005/T\",\n \"standardEmailPhotoUrl\": \"https://<my_domain>/img/userprofile/default_profile_45_v2.png?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"System\"\n },\n {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"FirstName\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https://<my_domain>/profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n }\n ],\n \"sender\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https://<my_domain>/profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"sendingCommunity\": null,\n \"sentDate\": \"<datetime>\",\n \"url\": \"/services/data/v58.0/chatter/users/me/messages/03J...\"\n}"
}
]
}
