Chilkat Online Tools

Android / Salesforce Platform APIs / User Messages, General

Back to Collection Items

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkHttp http = new CkHttp();
    boolean success;

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken("<access_token>");

    CkHttpResponse resp = http.QuickRequest("POST","message&recipients=<USER1_ID>,<USER2_ID>");
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    Log.i(TAG, "Response Body:");
    Log.i(TAG, jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
    if (respStatusCode >= 400) {
        Log.i(TAG, "Response Header:");
        Log.i(TAG, resp.header());
        Log.i(TAG, "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

    String additionalLabel;
    String communityNickname;
    String companyName;
    String displayName;
    String firstName;
    boolean isActive;
    boolean isInThisCommunity;
    String lastName;
    String motifColor;
    String motifLargeIconUrl;
    String motifMediumIconUrl;
    String motifSmallIconUrl;
    String motifSvgIconUrl;
    String mySubscription;
    String name;
    String outOfOfficeMessage;
    String photoFullEmailPhotoUrl;
    String photoLargePhotoUrl;
    String photoMediumPhotoUrl;
    String photoPhotoVersionId;
    String photoSmallPhotoUrl;
    String photoStandardEmailPhotoUrl;
    String photoUrl;
    String reputation;
    String title;
    String v_type;
    String userType;

    String IsRichText = jResp.stringOf("body.isRichText");
    String Text = jResp.stringOf("body.text");
    String conversationId = jResp.stringOf("conversationId");
    String conversationUrl = jResp.stringOf("conversationUrl");
    String id = jResp.stringOf("id");
    String AdditionalLabel = jResp.stringOf("sender.additionalLabel");
    String CommunityNickname = jResp.stringOf("sender.communityNickname");
    String CompanyName = jResp.stringOf("sender.companyName");
    String DisplayName = jResp.stringOf("sender.displayName");
    String FirstName = jResp.stringOf("sender.firstName");
    String Id = jResp.stringOf("sender.id");
    boolean IsActive = jResp.BoolOf("sender.isActive");
    boolean IsInThisCommunity = jResp.BoolOf("sender.isInThisCommunity");
    String LastName = jResp.stringOf("sender.lastName");
    String Color = jResp.stringOf("sender.motif.color");
    String LargeIconUrl = jResp.stringOf("sender.motif.largeIconUrl");
    String MediumIconUrl = jResp.stringOf("sender.motif.mediumIconUrl");
    String SmallIconUrl = jResp.stringOf("sender.motif.smallIconUrl");
    String SvgIconUrl = jResp.stringOf("sender.motif.svgIconUrl");
    String MySubscription = jResp.stringOf("sender.mySubscription");
    String Name = jResp.stringOf("sender.name");
    String Message = jResp.stringOf("sender.outOfOffice.message");
    String FullEmailPhotoUrl = jResp.stringOf("sender.photo.fullEmailPhotoUrl");
    String LargePhotoUrl = jResp.stringOf("sender.photo.largePhotoUrl");
    String MediumPhotoUrl = jResp.stringOf("sender.photo.mediumPhotoUrl");
    String PhotoVersionId = jResp.stringOf("sender.photo.photoVersionId");
    String SmallPhotoUrl = jResp.stringOf("sender.photo.smallPhotoUrl");
    String StandardEmailPhotoUrl = jResp.stringOf("sender.photo.standardEmailPhotoUrl");
    String v_Url = jResp.stringOf("sender.photo.url");
    String Reputation = jResp.stringOf("sender.reputation");
    String Title = jResp.stringOf("sender.title");
    String v_Type = jResp.stringOf("sender.type");
    String senderUrl = jResp.stringOf("sender.url");
    String UserType = jResp.stringOf("sender.userType");
    String sendingCommunity = jResp.stringOf("sendingCommunity");
    String sentDate = jResp.stringOf("sentDate");
    String url = jResp.stringOf("url");
    int i = 0;
    int count_i = jResp.SizeOfArray("body.messageSegments");
    while (i < count_i) {
        jResp.put_I(i);
        i = i + 1;
        }

    i = 0;
    count_i = jResp.SizeOfArray("recipients");
    while (i < count_i) {
        jResp.put_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;
        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

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