Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequest(http,"POST","message&recipients=<USER1_ID>,<USER2_ID>")
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
additionalLabel.s
communityNickname.s
companyName.s
displayName.s
firstName.s
isActive.i
isInThisCommunity.i
lastName.s
motifColor.s
motifLargeIconUrl.s
motifMediumIconUrl.s
motifSmallIconUrl.s
motifSvgIconUrl.s
mySubscription.s
name.s
outOfOfficeMessage.s
photoFullEmailPhotoUrl.s
photoLargePhotoUrl.s
photoMediumPhotoUrl.s
photoPhotoVersionId.s
photoSmallPhotoUrl.s
photoStandardEmailPhotoUrl.s
photoUrl.s
reputation.s
title.s
v_type.s
userType.s
IsRichText.s = CkJsonObject::ckStringOf(jResp,"body.isRichText")
Text.s = CkJsonObject::ckStringOf(jResp,"body.text")
conversationId.s = CkJsonObject::ckStringOf(jResp,"conversationId")
conversationUrl.s = CkJsonObject::ckStringOf(jResp,"conversationUrl")
id.s = CkJsonObject::ckStringOf(jResp,"id")
AdditionalLabel.s = CkJsonObject::ckStringOf(jResp,"sender.additionalLabel")
CommunityNickname.s = CkJsonObject::ckStringOf(jResp,"sender.communityNickname")
CompanyName.s = CkJsonObject::ckStringOf(jResp,"sender.companyName")
DisplayName.s = CkJsonObject::ckStringOf(jResp,"sender.displayName")
FirstName.s = CkJsonObject::ckStringOf(jResp,"sender.firstName")
Id.s = CkJsonObject::ckStringOf(jResp,"sender.id")
IsActive.i = CkJsonObject::ckBoolOf(jResp,"sender.isActive")
IsInThisCommunity.i = CkJsonObject::ckBoolOf(jResp,"sender.isInThisCommunity")
LastName.s = CkJsonObject::ckStringOf(jResp,"sender.lastName")
Color.s = CkJsonObject::ckStringOf(jResp,"sender.motif.color")
LargeIconUrl.s = CkJsonObject::ckStringOf(jResp,"sender.motif.largeIconUrl")
MediumIconUrl.s = CkJsonObject::ckStringOf(jResp,"sender.motif.mediumIconUrl")
SmallIconUrl.s = CkJsonObject::ckStringOf(jResp,"sender.motif.smallIconUrl")
SvgIconUrl.s = CkJsonObject::ckStringOf(jResp,"sender.motif.svgIconUrl")
MySubscription.s = CkJsonObject::ckStringOf(jResp,"sender.mySubscription")
Name.s = CkJsonObject::ckStringOf(jResp,"sender.name")
Message.s = CkJsonObject::ckStringOf(jResp,"sender.outOfOffice.message")
FullEmailPhotoUrl.s = CkJsonObject::ckStringOf(jResp,"sender.photo.fullEmailPhotoUrl")
LargePhotoUrl.s = CkJsonObject::ckStringOf(jResp,"sender.photo.largePhotoUrl")
MediumPhotoUrl.s = CkJsonObject::ckStringOf(jResp,"sender.photo.mediumPhotoUrl")
PhotoVersionId.s = CkJsonObject::ckStringOf(jResp,"sender.photo.photoVersionId")
SmallPhotoUrl.s = CkJsonObject::ckStringOf(jResp,"sender.photo.smallPhotoUrl")
StandardEmailPhotoUrl.s = CkJsonObject::ckStringOf(jResp,"sender.photo.standardEmailPhotoUrl")
v_Url.s = CkJsonObject::ckStringOf(jResp,"sender.photo.url")
Reputation.s = CkJsonObject::ckStringOf(jResp,"sender.reputation")
Title.s = CkJsonObject::ckStringOf(jResp,"sender.title")
v_Type.s = CkJsonObject::ckStringOf(jResp,"sender.type")
senderUrl.s = CkJsonObject::ckStringOf(jResp,"sender.url")
UserType.s = CkJsonObject::ckStringOf(jResp,"sender.userType")
sendingCommunity.s = CkJsonObject::ckStringOf(jResp,"sendingCommunity")
sentDate.s = CkJsonObject::ckStringOf(jResp,"sentDate")
url.s = CkJsonObject::ckStringOf(jResp,"url")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"body.messageSegments")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"recipients")
While i < count_i
CkJsonObject::setCkI(jResp, i)
additionalLabel = CkJsonObject::ckStringOf(jResp,"recipients[i].additionalLabel")
communityNickname = CkJsonObject::ckStringOf(jResp,"recipients[i].communityNickname")
companyName = CkJsonObject::ckStringOf(jResp,"recipients[i].companyName")
displayName = CkJsonObject::ckStringOf(jResp,"recipients[i].displayName")
firstName = CkJsonObject::ckStringOf(jResp,"recipients[i].firstName")
id = CkJsonObject::ckStringOf(jResp,"recipients[i].id")
isActive = CkJsonObject::ckBoolOf(jResp,"recipients[i].isActive")
isInThisCommunity = CkJsonObject::ckBoolOf(jResp,"recipients[i].isInThisCommunity")
lastName = CkJsonObject::ckStringOf(jResp,"recipients[i].lastName")
motifColor = CkJsonObject::ckStringOf(jResp,"recipients[i].motif.color")
motifLargeIconUrl = CkJsonObject::ckStringOf(jResp,"recipients[i].motif.largeIconUrl")
motifMediumIconUrl = CkJsonObject::ckStringOf(jResp,"recipients[i].motif.mediumIconUrl")
motifSmallIconUrl = CkJsonObject::ckStringOf(jResp,"recipients[i].motif.smallIconUrl")
motifSvgIconUrl = CkJsonObject::ckStringOf(jResp,"recipients[i].motif.svgIconUrl")
mySubscription = CkJsonObject::ckStringOf(jResp,"recipients[i].mySubscription")
name = CkJsonObject::ckStringOf(jResp,"recipients[i].name")
outOfOfficeMessage = CkJsonObject::ckStringOf(jResp,"recipients[i].outOfOffice.message")
photoFullEmailPhotoUrl = CkJsonObject::ckStringOf(jResp,"recipients[i].photo.fullEmailPhotoUrl")
photoLargePhotoUrl = CkJsonObject::ckStringOf(jResp,"recipients[i].photo.largePhotoUrl")
photoMediumPhotoUrl = CkJsonObject::ckStringOf(jResp,"recipients[i].photo.mediumPhotoUrl")
photoPhotoVersionId = CkJsonObject::ckStringOf(jResp,"recipients[i].photo.photoVersionId")
photoSmallPhotoUrl = CkJsonObject::ckStringOf(jResp,"recipients[i].photo.smallPhotoUrl")
photoStandardEmailPhotoUrl = CkJsonObject::ckStringOf(jResp,"recipients[i].photo.standardEmailPhotoUrl")
photoUrl = CkJsonObject::ckStringOf(jResp,"recipients[i].photo.url")
reputation = CkJsonObject::ckStringOf(jResp,"recipients[i].reputation")
title = CkJsonObject::ckStringOf(jResp,"recipients[i].title")
v_type = CkJsonObject::ckStringOf(jResp,"recipients[i].type")
url = CkJsonObject::ckStringOf(jResp,"recipients[i].url")
userType = CkJsonObject::ckStringOf(jResp,"recipients[i].userType")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
