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]
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequest $http "POST" "message&recipients=<USER1_ID>,<USER2_ID>"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
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_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set IsRichText [CkJsonObject_stringOf $jResp "body.isRichText"]
set Text [CkJsonObject_stringOf $jResp "body.text"]
set conversationId [CkJsonObject_stringOf $jResp "conversationId"]
set conversationUrl [CkJsonObject_stringOf $jResp "conversationUrl"]
set id [CkJsonObject_stringOf $jResp "id"]
set AdditionalLabel [CkJsonObject_stringOf $jResp "sender.additionalLabel"]
set CommunityNickname [CkJsonObject_stringOf $jResp "sender.communityNickname"]
set CompanyName [CkJsonObject_stringOf $jResp "sender.companyName"]
set DisplayName [CkJsonObject_stringOf $jResp "sender.displayName"]
set FirstName [CkJsonObject_stringOf $jResp "sender.firstName"]
set Id [CkJsonObject_stringOf $jResp "sender.id"]
set IsActive [CkJsonObject_BoolOf $jResp "sender.isActive"]
set IsInThisCommunity [CkJsonObject_BoolOf $jResp "sender.isInThisCommunity"]
set LastName [CkJsonObject_stringOf $jResp "sender.lastName"]
set Color [CkJsonObject_stringOf $jResp "sender.motif.color"]
set LargeIconUrl [CkJsonObject_stringOf $jResp "sender.motif.largeIconUrl"]
set MediumIconUrl [CkJsonObject_stringOf $jResp "sender.motif.mediumIconUrl"]
set SmallIconUrl [CkJsonObject_stringOf $jResp "sender.motif.smallIconUrl"]
set SvgIconUrl [CkJsonObject_stringOf $jResp "sender.motif.svgIconUrl"]
set MySubscription [CkJsonObject_stringOf $jResp "sender.mySubscription"]
set Name [CkJsonObject_stringOf $jResp "sender.name"]
set Message [CkJsonObject_stringOf $jResp "sender.outOfOffice.message"]
set FullEmailPhotoUrl [CkJsonObject_stringOf $jResp "sender.photo.fullEmailPhotoUrl"]
set LargePhotoUrl [CkJsonObject_stringOf $jResp "sender.photo.largePhotoUrl"]
set MediumPhotoUrl [CkJsonObject_stringOf $jResp "sender.photo.mediumPhotoUrl"]
set PhotoVersionId [CkJsonObject_stringOf $jResp "sender.photo.photoVersionId"]
set SmallPhotoUrl [CkJsonObject_stringOf $jResp "sender.photo.smallPhotoUrl"]
set StandardEmailPhotoUrl [CkJsonObject_stringOf $jResp "sender.photo.standardEmailPhotoUrl"]
set v_Url [CkJsonObject_stringOf $jResp "sender.photo.url"]
set Reputation [CkJsonObject_stringOf $jResp "sender.reputation"]
set Title [CkJsonObject_stringOf $jResp "sender.title"]
set v_Type [CkJsonObject_stringOf $jResp "sender.type"]
set senderUrl [CkJsonObject_stringOf $jResp "sender.url"]
set UserType [CkJsonObject_stringOf $jResp "sender.userType"]
set sendingCommunity [CkJsonObject_stringOf $jResp "sendingCommunity"]
set sentDate [CkJsonObject_stringOf $jResp "sentDate"]
set url [CkJsonObject_stringOf $jResp "url"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "body.messageSegments"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "recipients"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set additionalLabel [CkJsonObject_stringOf $jResp "recipients[i].additionalLabel"]
set communityNickname [CkJsonObject_stringOf $jResp "recipients[i].communityNickname"]
set companyName [CkJsonObject_stringOf $jResp "recipients[i].companyName"]
set displayName [CkJsonObject_stringOf $jResp "recipients[i].displayName"]
set firstName [CkJsonObject_stringOf $jResp "recipients[i].firstName"]
set id [CkJsonObject_stringOf $jResp "recipients[i].id"]
set isActive [CkJsonObject_BoolOf $jResp "recipients[i].isActive"]
set isInThisCommunity [CkJsonObject_BoolOf $jResp "recipients[i].isInThisCommunity"]
set lastName [CkJsonObject_stringOf $jResp "recipients[i].lastName"]
set motifColor [CkJsonObject_stringOf $jResp "recipients[i].motif.color"]
set motifLargeIconUrl [CkJsonObject_stringOf $jResp "recipients[i].motif.largeIconUrl"]
set motifMediumIconUrl [CkJsonObject_stringOf $jResp "recipients[i].motif.mediumIconUrl"]
set motifSmallIconUrl [CkJsonObject_stringOf $jResp "recipients[i].motif.smallIconUrl"]
set motifSvgIconUrl [CkJsonObject_stringOf $jResp "recipients[i].motif.svgIconUrl"]
set mySubscription [CkJsonObject_stringOf $jResp "recipients[i].mySubscription"]
set name [CkJsonObject_stringOf $jResp "recipients[i].name"]
set outOfOfficeMessage [CkJsonObject_stringOf $jResp "recipients[i].outOfOffice.message"]
set photoFullEmailPhotoUrl [CkJsonObject_stringOf $jResp "recipients[i].photo.fullEmailPhotoUrl"]
set photoLargePhotoUrl [CkJsonObject_stringOf $jResp "recipients[i].photo.largePhotoUrl"]
set photoMediumPhotoUrl [CkJsonObject_stringOf $jResp "recipients[i].photo.mediumPhotoUrl"]
set photoPhotoVersionId [CkJsonObject_stringOf $jResp "recipients[i].photo.photoVersionId"]
set photoSmallPhotoUrl [CkJsonObject_stringOf $jResp "recipients[i].photo.smallPhotoUrl"]
set photoStandardEmailPhotoUrl [CkJsonObject_stringOf $jResp "recipients[i].photo.standardEmailPhotoUrl"]
set photoUrl [CkJsonObject_stringOf $jResp "recipients[i].photo.url"]
set reputation [CkJsonObject_stringOf $jResp "recipients[i].reputation"]
set title [CkJsonObject_stringOf $jResp "recipients[i].title"]
set v_type [CkJsonObject_stringOf $jResp "recipients[i].type"]
set url [CkJsonObject_stringOf $jResp "recipients[i].url"]
set userType [CkJsonObject_stringOf $jResp "recipients[i].userType"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
