Back to Collection Items
#import <CkoHttp.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
CkoHttpResponse *resp = [[CkoHttpResponse alloc] init];
success = [http HttpNoBody: @"POST" url: @"message&recipients=<USER1_ID>,<USER2_ID>" response: resp];
if (success == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// 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
NSString *additionalLabel = 0;
NSString *communityNickname = 0;
NSString *companyName = 0;
NSString *displayName = 0;
NSString *firstName = 0;
BOOL isActive;
BOOL isInThisCommunity;
NSString *lastName = 0;
NSString *motifColor = 0;
NSString *motifLargeIconUrl = 0;
NSString *motifMediumIconUrl = 0;
NSString *motifSmallIconUrl = 0;
NSString *motifSvgIconUrl = 0;
NSString *mySubscription = 0;
NSString *name = 0;
NSString *outOfOfficeMessage = 0;
NSString *photoFullEmailPhotoUrl = 0;
NSString *photoLargePhotoUrl = 0;
NSString *photoMediumPhotoUrl = 0;
NSString *photoPhotoVersionId = 0;
NSString *photoSmallPhotoUrl = 0;
NSString *photoStandardEmailPhotoUrl = 0;
NSString *photoUrl = 0;
NSString *reputation = 0;
NSString *title = 0;
NSString *v_type = 0;
NSString *userType = 0;
NSString *IsRichText = [jResp StringOf: @"body.isRichText"];
NSString *Text = [jResp StringOf: @"body.text"];
NSString *conversationId = [jResp StringOf: @"conversationId"];
NSString *conversationUrl = [jResp StringOf: @"conversationUrl"];
NSString *id = [jResp StringOf: @"id"];
NSString *AdditionalLabel = [jResp StringOf: @"sender.additionalLabel"];
NSString *CommunityNickname = [jResp StringOf: @"sender.communityNickname"];
NSString *CompanyName = [jResp StringOf: @"sender.companyName"];
NSString *DisplayName = [jResp StringOf: @"sender.displayName"];
NSString *FirstName = [jResp StringOf: @"sender.firstName"];
NSString *Id = [jResp StringOf: @"sender.id"];
BOOL IsActive = [jResp BoolOf: @"sender.isActive"];
BOOL IsInThisCommunity = [jResp BoolOf: @"sender.isInThisCommunity"];
NSString *LastName = [jResp StringOf: @"sender.lastName"];
NSString *Color = [jResp StringOf: @"sender.motif.color"];
NSString *LargeIconUrl = [jResp StringOf: @"sender.motif.largeIconUrl"];
NSString *MediumIconUrl = [jResp StringOf: @"sender.motif.mediumIconUrl"];
NSString *SmallIconUrl = [jResp StringOf: @"sender.motif.smallIconUrl"];
NSString *SvgIconUrl = [jResp StringOf: @"sender.motif.svgIconUrl"];
NSString *MySubscription = [jResp StringOf: @"sender.mySubscription"];
NSString *Name = [jResp StringOf: @"sender.name"];
NSString *Message = [jResp StringOf: @"sender.outOfOffice.message"];
NSString *FullEmailPhotoUrl = [jResp StringOf: @"sender.photo.fullEmailPhotoUrl"];
NSString *LargePhotoUrl = [jResp StringOf: @"sender.photo.largePhotoUrl"];
NSString *MediumPhotoUrl = [jResp StringOf: @"sender.photo.mediumPhotoUrl"];
NSString *PhotoVersionId = [jResp StringOf: @"sender.photo.photoVersionId"];
NSString *SmallPhotoUrl = [jResp StringOf: @"sender.photo.smallPhotoUrl"];
NSString *StandardEmailPhotoUrl = [jResp StringOf: @"sender.photo.standardEmailPhotoUrl"];
NSString *v_Url = [jResp StringOf: @"sender.photo.url"];
NSString *Reputation = [jResp StringOf: @"sender.reputation"];
NSString *Title = [jResp StringOf: @"sender.title"];
NSString *v_Type = [jResp StringOf: @"sender.type"];
NSString *senderUrl = [jResp StringOf: @"sender.url"];
NSString *UserType = [jResp StringOf: @"sender.userType"];
NSString *sendingCommunity = [jResp StringOf: @"sendingCommunity"];
NSString *sentDate = [jResp StringOf: @"sentDate"];
NSString *url = [jResp StringOf: @"url"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"body.messageSegments"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
i = i + 1;
}
i = 0;
count_i = [[jResp SizeOfArray: @"recipients"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: 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;
}
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}"
}
]
}
