---
updatedAt: 2025-09-09T23:55:56.000Z
agentTools:
  projectIndex: https://docs.ns-api.com/llms.txt
---

# Get Messagesessions for User

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "NetSapiens API v2",
    "description": "",
    "version": "1.0.0"
  },
  "tags": [
    {
      "name": "Messages"
    }
  ],
  "paths": {
    "/domains/{domain}/users/{user}/messagesessions": {
      "get": {
        "summary": "Get Messagesessions for User",
        "deprecated": false,
        "description": "",
        "operationId": "GetMessageSessionsForUser",
        "tags": [
          "Messages"
        ],
        "parameters": [
          {
            "name": "domain",
            "in": "path",
            "description": "",
            "required": true,
            "example": "sampleDomain",
            "schema": {
              "$ref": "#/components/schemas/DomainNamePath"
            }
          },
          {
            "name": "user",
            "in": "path",
            "description": "",
            "required": true,
            "example": "sampleUser",
            "schema": {
              "$ref": "#/components/schemas/UserNamePath"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "",
            "required": false,
            "example": 10,
            "schema": {
              "$ref": "#/components/schemas/Limit"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Messagesession"
                  }
                },
                "example": [
                  {
                    "user": "2500",
                    "domain": "portal",
                    "messagesession-id": "173ff396f3580f30dfef32be9838e836",
                    "messagesession-remote": 17145550353,
                    "messagesession-sms-number": 18585550626,
                    "messagesession-last-timestamp": "2023-10-05 17:35:15",
                    "messagesession-start-timestamp": "2023-06-12 20:48:43",
                    "messagesession-last-message": "hi from eng0 wp",
                    "messagesession-last-sender": "2500@portal",
                    "messagesession-last-status": "read",
                    "messagesession-muted": "no",
                    "messagesession-last-email-reminder-timestamp": "2023-06-13 18:53:16",
                    "messagesession-reciever-hostname": "eng0-san.netsapiens.com",
                    "messagesession-queue-termination": null,
                    "messagesession-queue-status": null,
                    "messagesession-queue-session-id": null,
                    "messagesession-agent-start-timestamp": null,
                    "messagesession-last-type": "sms",
                    "messagesession-last-media-type": "image/png",
                    "messagesession-last-media-size": 5596,
                    "messagesession-type": "",
                    "messagesession-name": "",
                    "messagesession-participants": ""
                  },
                  {
                    "user": "2500",
                    "domain": "portal",
                    "messagesession-id": "c3529b7ce79a86018d006462fa70fcea",
                    "messagesession-remote": "1123@portal,1004@portal",
                    "messagesession-sms-number": "",
                    "messagesession-last-timestamp": "2023-10-10 18:24:40",
                    "messagesession-start-timestamp": null,
                    "messagesession-last-message": 941173465,
                    "messagesession-last-sender": "1004@portal",
                    "messagesession-last-status": "read",
                    "messagesession-muted": "no",
                    "messagesession-last-email-reminder-timestamp": "2023-10-09 21:09:57",
                    "messagesession-reciever-hostname": "eng2-phx.netsapiens.com",
                    "messagesession-queue-termination": null,
                    "messagesession-queue-status": null,
                    "messagesession-queue-session-id": null,
                    "messagesession-agent-start-timestamp": null,
                    "messagesession-last-type": "chat-vid",
                    "messagesession-last-media-type": "",
                    "messagesession-last-media-size": 0,
                    "messagesession-type": "group-chat",
                    "messagesession-name": "",
                    "messagesession-participants": "1123@portal,2500@portal,1004@portal"
                  },
                  {
                    "user": "2500",
                    "domain": "portal",
                    "messagesession-id": "b0569814b84556c7ebca00be47d7f534",
                    "messagesession-remote": "1123@portal",
                    "messagesession-sms-number": "",
                    "messagesession-last-timestamp": "2023-10-04 18:32:27",
                    "messagesession-start-timestamp": null,
                    "messagesession-last-message": "hi peter",
                    "messagesession-last-sender": "2500@portal",
                    "messagesession-last-status": "read",
                    "messagesession-muted": "no",
                    "messagesession-last-email-reminder-timestamp": null,
                    "messagesession-reciever-hostname": "eng2-phx.netsapiens.com",
                    "messagesession-queue-termination": null,
                    "messagesession-queue-status": null,
                    "messagesession-queue-session-id": null,
                    "messagesession-agent-start-timestamp": null,
                    "messagesession-last-type": "chat",
                    "messagesession-last-media-type": "",
                    "messagesession-last-media-size": 0,
                    "messagesession-type": "",
                    "messagesession-name": "",
                    "messagesession-participants": null
                  }
                ]
              }
            },
            "headers": {},
            "x-apidog-name": "OK"
          }
        },
        "security": [
          {
            "bearer": []
          }
        ],
        "x-apidog-folder": "Messages",
        "x-apidog-status": "released",
        "x-run-in-apidog": "https://apidog.com/web/project/374090/apis/api-4684061-run"
      }
    }
  },
  "components": {
    "schemas": {
      "Messagesession": {
        "type": "object",
        "properties": {
          "user": {
            "$ref": "#/components/schemas/UserName"
          },
          "domain": {
            "$ref": "#/components/schemas/DomainName"
          },
          "messagesession-remote": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "This is the UserID (ie, 1234@portal) or the phonenumber of the recipient(s) of the messages. If more than one, will be comma seperated"
          },
          "messagesession-muted": {
            "type": "string",
            "description": "This is whether or not the message session is muted or not. \"yes\" or \"no\""
          },
          "messagesession-id": {
            "type": "string",
            "description": "This is the identifier for the session"
          },
          "messagesession-sms-number": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ],
            "description": "This is the SMS number used to send outbound. Will be null if not an SMS message session"
          },
          "messagesession-last-datetime": {
            "type": [
              "string",
              "null"
            ],
            "description": "This is the last time the session had an inbound or outbound message"
          },
          "messagesession-start-datetime": {
            "type": [
              "string",
              "null"
            ],
            "description": "This is the when the message session started"
          },
          "messagesession-last-message": {
            "anyOf": [
              {
                "type": "string",
                "readOnly": true
              },
              {
                "type": "integer",
                "readOnly": true
              },
              {
                "type": "null"
              }
            ],
            "description": "This is the last message in the messagesession"
          },
          "messagesession-last-sender": {
            "type": [
              "string",
              "null"
            ],
            "description": "This shows the UID or the phonenumber of who was the last message sender",
            "readOnly": true
          },
          "messagesession-last-status": {
            "type": [
              "string",
              "null"
            ],
            "description": "This is the last status of the messagesession. Will contain read/unread status",
            "readOnly": true
          },
          "messagesession-last-email-reminder-datetime": {
            "type": [
              "string",
              "null"
            ],
            "description": "This is when the last email reminder was sent out notifiying the user of a missed message",
            "readOnly": true
          },
          "messagesession-reciever-hostname": {
            "type": "string",
            "description": "This is the hostname of the last received message",
            "readOnly": true
          },
          "messagesession-queue-termination": {
            "type": [
              "string",
              "null"
            ],
            "description": "This is which SMS queue the messagesession is assigned to",
            "readOnly": true
          },
          "messagesession-queue-status": {
            "type": [
              "string",
              "null"
            ],
            "description": "This is the queue status of the messagesession",
            "readOnly": true
          },
          "messagesession-queue-session-id": {
            "type": [
              "string",
              "null"
            ],
            "description": "This is the queue session id placed on the messagesession",
            "readOnly": true
          },
          "messagesession-agent-start-datetime": {
            "type": [
              "string",
              "null"
            ],
            "description": "This is when the messagesession was started by the agent",
            "readOnly": true
          },
          "messagesession-last-type": {
            "description": "This is the last message type of the messagesession",
            "anyOf": [
              {
                "$ref": "#/components/schemas/MessageType"
              },
              {
                "type": "null"
              }
            ]
          },
          "messagesession-last-media-type": {
            "type": [
              "string",
              "null"
            ],
            "description": "This is the last media type of the messagesession"
          },
          "messagesession-last-media-size": {
            "type": [
              "integer",
              "null"
            ],
            "description": "This is the size of the last media of the messagesession"
          },
          "messagesession-type": {
            "type": "string",
            "description": "This is the type of messagesession"
          },
          "messagesession-name": {
            "type": [
              "string",
              "null"
            ],
            "description": "This is the name of the messagesession. Names can be assigned to group chats"
          },
          "messagesession-participants": {
            "type": [
              "string",
              "null"
            ],
            "description": "This is a comma seperated list of participants within a group chat or group sms messagesession"
          }
        },
        "required": [
          "user",
          "domain",
          "messagesession-remote",
          "messagesession-muted",
          "messagesession-id",
          "messagesession-sms-number",
          "messagesession-last-datetime",
          "messagesession-start-datetime",
          "messagesession-last-message",
          "messagesession-last-sender",
          "messagesession-last-status",
          "messagesession-last-email-reminder-datetime",
          "messagesession-reciever-hostname",
          "messagesession-queue-termination",
          "messagesession-queue-status",
          "messagesession-queue-session-id",
          "messagesession-agent-start-datetime",
          "messagesession-last-type",
          "messagesession-last-media-type",
          "messagesession-last-media-size",
          "messagesession-type"
        ],
        "x-apidog-orders": [
          "user",
          "domain",
          "messagesession-remote",
          "messagesession-muted",
          "messagesession-id",
          "messagesession-sms-number",
          "messagesession-last-datetime",
          "messagesession-start-datetime",
          "messagesession-last-message",
          "messagesession-last-sender",
          "messagesession-last-status",
          "messagesession-last-email-reminder-datetime",
          "messagesession-reciever-hostname",
          "messagesession-queue-termination",
          "messagesession-queue-status",
          "messagesession-queue-session-id",
          "messagesession-agent-start-datetime",
          "messagesession-last-type",
          "messagesession-last-media-type",
          "messagesession-last-media-size",
          "messagesession-type",
          "messagesession-name",
          "messagesession-participants"
        ],
        "x-apidog-ignore-properties": [],
        "x-apidog-folder": "Schemas"
      },
      "DomainName": {
        "type": "string",
        "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (\\*). ",
        "pattern": "^[A-Za-z0-9._-]+|\\*",
        "maxLength": 64,
        "examples": [
          "example.com"
        ],
        "x-apidog-folder": "Enums"
      },
      "DomainNamePath": {
        "type": "string",
        "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to \"~\" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.  ",
        "pattern": "^[A-Za-z0-9._-]*|~|\\*+",
        "maxLength": 64,
        "examples": [
          "example.com",
          "myDomain",
          "test.12123"
        ],
        "default": "~",
        "x-apidog-folder": "Enums"
      },
      "UserName": {
        "type": "string",
        "examples": [
          "1000",
          "200"
        ],
        "description": "This is the main user extension for the user account. ",
        "x-apidog-folder": "Enums"
      },
      "UserNamePath": {
        "type": "string",
        "description": "This is the main user extension for the user account. ~ can be used to mean \"my account\" which will extract the user from the token/key used for authentication. ",
        "examples": [
          "1000",
          "200",
          "~"
        ],
        "minLength": 0,
        "maxLength": 16,
        "default": "~",
        "x-apidog-folder": "Enums"
      },
      "MessageType": {
        "type": "string",
        "examples": [
          "chat",
          "sms",
          "mms",
          "chat-media",
          "chat-video",
          "chat-participant-(status-changes)"
        ],
        "x-apidog-folder": "Enums"
      },
      "Limit": {
        "type": "number",
        "format": "int",
        "default": 100,
        "minimum": 1,
        "maximum": 1000,
        "description": "This is the limit of the number of objects that will be returned in the read/list API call. This can be used with pagination to help retrieve smaller chunks of data. Should be used in conjunction with Start.",
        "x-apidog-folder": "Enums"
      }
    },
    "securitySchemes": {
      "bearer": {
        "type": "http",
        "scheme": "bearer"
      },
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "servers": [
    {
      "url": "https://{server}/ns-api/v2",
      "description": "Dynamic Environment",
      "variables": {
        "server": {
          "default": "ns-api.com"
        }
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ]
}
```