NetSapiens API v2
  1. Messages
NetSapiens API v2
  • TODO LIST
  • Version
    • Read API Version
      GET
  • Authentication
    • Access Token (Oauth - Username/Password)
      • Get Access Token From Refresh
      • Get Access Token From User/Pass
      • Get Access Token after MFA request
    • API Key (Machine 2 Machine)
      • Read API Key info on your API Key
      • Read API Keys under your account
      • Read Info on specific APIKey via Key ID
      • Create API Key
      • Update API Key
      • Revoke API Key
    • JWT (JSON Web Token)
      • Create JWT token From User/Pass
      • Create JWT token from Refresh JWT
      • Create JWT token after MFA request
      • Create JWT token For Delegated Access
      • Revoke JWT(s) by UID (user@domain)
      • Revoke JWT by JTI (JWT ID)
      • Revoke current JWT
      • Read Current JWT
  • Event Subscriptions
    • Read Event Subscriptions
      GET
    • Read Event Subscription By Id
      GET
    • Create a Event Subscription
      POST
    • Update an Event Subscription
      PUT
    • Delete a subscription
      DELETE
  • Resellers
    • Get Resellers
      GET
    • Create Reseller
      POST
    • Update Reseller
      PUT
    • Delete Reseller
      DELETE
    • Get Specific Reseller
      GET
  • Domains
    • Get Domains
    • Count Domains
    • Get Specific Domain
    • Get Specific Domain With Billing Summary
    • Get My Domain Info
    • Check if Domain Exists
    • Create a Domain
    • Update a Domain
    • Delete a Domain
  • Phone Numbers
    • destination-application mappings and parameter parsing
    • Use Cases
      • Send Phonenumber to Call Queue
      • Send Phonenumber to a User
      • Send Phonenumber to Offnet Number
      • Move phonenumber back to Available in Inventory
    • Count Phone Numbers for Domain
    • Get All Phone Numbers for System or Reseller
    • Get All Phone Numbers for Domain
    • Add Phone Number in Domain
    • Remove Phone Number from Domain
    • Update Phone Number in Domain
    • Get Specific Phone Number in Domain
  • Users
    • Get Users in Domain
    • Count users in Domain
    • Search for Users in Domain
    • Create User in Domain
    • Delete User in Domain
    • Update a User in Domain
    • Get Specific User in Domain
    • Get My User
  • Devices
    • Count Devices for User
    • Get Devices for User
    • Create Device for User
    • Update Device for User
    • Delete Device for User
    • Get Specifc Device
  • Phones/Macs
    • Supported Models and Servers
      • Get list of Supported/Provisionable Models
      • Get list of Supported/Provisionable by Vendor
      • Get details of Specific Model
      • Get list of Provisionable Server Profiles
      • Read Provisionable Server Details
    • Read Mac Addresses
    • Read Mac Addresses in Domain
    • Read Specific Mac Address
    • Add MAC address
    • Add MAC address for Domain
    • Update MAC address
    • Update MAC address in Domain
    • Remove MAC address
    • Remove MAC address in Domain
  • Sites
    • List Sites in Domain
    • Read Sites in Domain
    • Create Site in Domain
    • Update Site in Domain
    • Read Specific Site in Domain
  • Call Center
    • Callqueues
      • Read Call Queues in Domain
      • Create Call Queue in Domain
      • Update Call Queue in Domain
      • Delete Call Queue
      • Read Specific Call Queue
    • Agents
      • Read Agents in Call Queue
      • Read Agents in Domain
      • Read Specific Agent in Call Queue
      • Add Agent to Call Queue
      • Update Agent in Call Queue
      • Remove Agent from Call Queue
    • Agent Actions
      • Agent Login
      • Agent Logout
      • Agent Single Call
      • Agent Set Offline Status
    • QueuedCalls
      • Read Queued Calls
    • Statistics
      • Get Callqueue Statistics for a Specific Queue
      • Get Callqueue Statistics for all Queues Aggregated
      • Get Callqueue Statistics for all Queues by Queue
      • Get Agent Statistics for all Queues by Agent
      • Get Agent Statistics for Single Queues by Agent
      • Get Agent Statistics for Single Agent
  • Answer Rules
    • Read Answerrules for a User
    • Read Answerrules for my User
    • Read Specifc Timeframe Answerrule for User
    • Add a Answerrule for a User
    • Delete a Answerrule for a User
    • Update a Answerrule for a User
    • Reorder Answerrules for my User
  • Call Blocking
    • Read blocked numbers for a Domain
    • Read blocked numbers for a User
    • Add blocked numbers for a Domain
    • Add blocked numbers for a User
    • Delete blocked numbers for a Domain
    • Delete blocked numbers for a User
  • Auto Attendant
    • Create Auto Attendant
    • Read Auto Attendants
    • Read Specific Auto Attendant
    • Update Specific Auto Attendant
  • Media
    • Voicemail
      • Read Voicemail for User by Folder
      • Read Specific Voicemail for User
      • Move Voicemail to save folder
      • Forward Voicemail to another user
      • Delete Voicemail
    • Greetings
      • Read Greetings for User
      • Read Specific Greeting for User
      • Delete Specific Greeting for User
      • Create a new Greeting from TTS
      • Update Greeting with TTS script
      • Create a new Greeting from Upload (JSON + Base64 File)
      • Update Greeting from Upload (JSON + Base64 File)
      • Create a new Greeting from Upload (Multipart/Mixed Post)
      • Update Greeting from Upload (Multipart/Mixed Post)
    • Music on Hold
      • Domain
        • Read MOH for Domain
        • Create a new MOH for Domain from TTS
        • Update MOH for Domain from TTS
        • Create a new MOH for Domain from Upload (JSON + Base64 File)
        • Update MOH for Domain from Upload (JSON + Base64 File)
        • Create a new MOH for Domain from Upload (Multipart/Mixed Post)
        • Update MOH for Domain from Upload (Multipart/Mixed Post)
        • Delete MOH for Domain
      • User
        • Read MOH for User
        • Create a new MOH for Domain from TTS
        • Create a new MOH for User from Upload (JSON + Base64 File)
        • Update MOH for User from Upload (JSON + Base64 File)
        • Update MOH for Domain from TTS
        • Create a new MOH for User from Upload (Multipart/Mixed Post)
        • Update a MOH for User from Upload (Multipart/Mixed Post)
        • Delete MOH for User
    • Hold Messages
      • Domain
        • Read Hold Messages for Domain
        • Create a new Hold Messge for Domain from Upload (Multipart/Mixed Post)
        • Update Hold Messge for Domain from Upload (Multipart/Mixed Post)
        • Delete Hold Messge for Domain
      • User
        • Read Hold Messages for User
        • Create a new Hold Messge for User from Upload (Multipart/Mixed Post)
        • Update Hold Messge for User from Upload (Multipart/Mixed Post)
        • Delete Hold Messge for User
    • Text to Speech
      • Get Available Voices
      • Synthesize Voice (Text to Speech)
      • Synthesize Voice (Text to Speech) via GET
  • CDR (Call History)
    • Read CDRs
    • Read CDRs for Domain
    • Read CDRs for Specific User
    • Search CDRs for Domain
    • Read CDRs for Site in Domain
    • Count CDRs and SUM minutes
    • Count CDRs and SUM minutes for Domain
    • Count CDRs and SUM minutes for Specifc User
  • Transcriptions & Sentiment
    • Read Transcription for Specific Call
  • Call Traces & Cradle to Grave
    • Get Call Trace (SIPFlow) For Call
    • Get Cradle to Grave Info For Call
    • Get CSV of call trace For Call
  • Calls (live/active calls)
    • Read Active Calls In Domain
    • Count Active Calls In Domain
    • Read Active Calls for User
    • Read Specific Actice Call
    • Make a new Call
    • Disconnect Call
    • Transfer Peer Call
    • Transfer Call
    • Answer Call
    • Hold Active Call
    • Un-Hold Active Call
    • Reject Call
    • Report Active Calls
  • Contacts
    • Shared Contacts
      • Get Domain Contacts
      • Get Specific Domain Contact
      • Create Shared Contact
      • Update Shared Contact
      • Delete Shared Contact
    • Get Contacts for User
    • Get Specific Contact for User
    • Count Contacts for User
    • Create Contact
    • Update Contact
    • Delete Contact
    • Get My Contacts
  • Addresses
    • Get Addresses for Domain
    • Validate Address
    • Create Address for Domain
    • Update Address for Domain
    • Update Address for User
    • Update Address Endpoint
    • Create Address for User
    • Delete Address For User
    • Delete Address Endpoint
    • Delete Address For Domain
    • Create Address Endpoint
    • Get Address Endpoints for a Domain
    • Get Addresses Count for Domain
    • Get Addresses for User
    • Get Address Using Address ID
  • Voicemail Reminders
    • Get Voicemail Reminders for Specific User
    • Delete Voicemail Reminders for Specific User
    • Create Voicemail Reminder
    • Update Voicemail Reminders for Specific User
  • Dialrule
    • Read Dialrules in a Dialplan
    • Read Specific Dialrule in a Dialplan
    • Add a new dial rule into a dial plan
    • Update a dial rule by ID in a dial plan
    • Delete a dial rule by ID in a dial plan
  • Messages
    • Get Messagesessions for Domain
      GET
    • Start a new Message Session
      POST
    • Get Messagesessions for User
      GET
    • Get Messages for Messagesession
      GET
    • Send a message (Chat)
      POST
    • Send a message (Group Chat)
      POST
    • Send a message (Media Chat)
      POST
    • Send a message (SMS)
      POST
    • Send a message (Group SMS)
      POST
    • Send a message (MMS)
      POST
    • Update Messagesession (Participants)
      PUT
    • Update Messagesession (Session Name)
      PUT
    • Update Messagesession (Leave)
      PUT
    • Delete Messagesession
      DELETE
  • SMS Numbers
    • Get All SMS Numbers for System
    • Get SMS Numbers for Domain
    • Create SMS Number
    • Update SMS Number Copy
    • Delete an SMS Number
    • Get SMS Numbers for User
    • Count SMS Numbers for User
  • Recordings
    • Get Specific Recording by Callid for User
    • Get Specific Recording by Callid for Domain
  • Email
    • Send Email using Template
  • Connections
    • Get All Connections
    • Count All Conections
    • Get All Connections for a Domain
    • Get Specific Connection for a Domain
    • Delete a Specific Connection for a Domain
    • Create a Connection
    • Update a Connection
  • Routes
    • Read Routes
    • Count All Routes
    • Read Route Connections
    • Count All Route Connections
    • Create a Route
    • Create a Route Connection
    • Delete A Specific Route
    • Update A Specific Route
    • Update A Specific Route Connection
  • Meetings
    • Event Logs
      • Create a Meeting Log Event
      • Read Meeting Events
    • Iotum
      • Read Iotum Video Domain Resellers
      • Read Iotum Video Host
      • Read All Iotum Video Hosts in a Domain
      • Read Iotum Video Host Conferences
      • Read Iotum Video Host Contacts
      • Read Iotum Video Company
      • Read Iotum Video Company Products
      • Read Iotum Video Available Products
      • Create a Host
      • Create Host Contacts
      • Create Iotum Video Subscription
      • Update Domain's Iotum Company
      • Update Domain's Iotum Subscriptions
      • Update User's Iotum Host
      • Delete Iotum Video Subscription
      • Delete a Host
      • Create Iotum Video Company
      • Create a Ad-hoc Conference
      • Delete a Video Company
    • Create a Meeting with Id
    • Create a Meeting
    • Read Meeting
    • Count Domains Meetings
    • Count Meeting
    • Register Meeting
    • Update a Meeting
    • Delete a Meeting
    • Request a Meeting ID
    • Read Meetings for User
  • Backup & Restore
    • Manually Backup a Domain
    • Request a Full System backup
    • Read Available Restore Points
    • Restore a Specifc Domain Backup
  • Configs
    • Configurations
      • NS Configs
      • Read a Specific Configuration
      • Read all Configurations
      • Create a Configuration
      • Update a Configuration
      • Delete a Configuration
    • Configuration Definitions
      • Read all Configuration Definitions
      • Read a Specific Configuration Definition
      • Create a Configuration Definition
      • Update a Configuration Definition
      • Delete Configuration Definition
  • Images
    • Read Image
    • Create Image from Upload (Multipart/Mixed Post)
    • Create Image from Upload (JSON + Base64 File)
    • Delete an Image
    • Update Image from Upload (Multipart/Mixed Post)
    • Update Image from Upload (JSON + Base64 File)
  • Templates
    • Read Template
    • Create Template from Upload (Multipart/Mixed Post)
    • Create Template from Upload (JSON + Base64 File)
    • Delete a Template
    • Update Template from Upload (Multipart/Mixed Post)
    • Update Template from Upload (JSON + Base64 File)
  • Timeframes
    • Domain (Shared)
      • Always
        • Create Always Timeframe
      • Specific Dates
        • Create Specific Dates Timeframe
        • Create Additional Date Ranges within Specific Dates Timeframe
        • Replace All Date Ranges in Specific Dates Timeframe
        • Update Date Ranges within Specific Dates Timeframe
        • Delete Date Range within Specific Dates Timeframe
      • Days of Week
        • Create Days of Week Timeframe
        • Update Days of Week Timeframe
      • Holiday
        • Create Holidays Timeframe
        • Create Additional Holidays within Holiday Timeframe
        • Replace All Holidays in Holiday Timeframe
        • Update Holidays within Holiday Timeframe
        • Delete Holiday within Holiday Timeframe
      • Custom
        • Create Custom Timeframe
        • Create Additional Entries within Custom Timeframe
        • Replace All Entries in Custom Timeframe
        • Update Entries within Custom Timeframe
        • Delete Entry within Custom Timeframe
      • Read All Timeframes for Domain (Shared)
      • Read Specific Timeframe for Domain (Shared)
      • Delete Specific Timeframe for Domain (Shared)
      • Convert Timeframe to Another Type
    • User
      • Always
        • Create Always Timeframe
      • Specific Dates
        • Create Specific Dates Timeframe
        • Create Additional Date Ranges within Specific Dates Timeframe
        • Replace All Date Ranges in Specific Dates Timeframe
        • Update Date Ranges within Specific Dates Timeframe
        • Delete Date Range within Specific Dates Timeframe
      • Days of Week
        • Create Days of Week Timeframe
        • Update Days of Week Timeframe
      • Holiday
        • Create Holidays Timeframe
        • Create Additional Holidays within Holiday Timeframe
        • Update Holidays within Holiday Timeframe
        • Replace All Holidays in Holiday Timeframe
        • Delete Holiday within Holiday Timeframe
      • Custom
        • Create Custom Timeframe
        • Create Additional Entries within Custom Timeframe
        • Update Entries within Custom Timeframe
        • Replace All Entries in Custom Timeframe
        • Delete Entry within Custom Timeframe
      • Read All Timeframes for User
      • Read Specific Timeframe for User
      • Delete Specific Timeframe for User
      • Convert Timeframe to Another Type
    • Holiday Information
      • Read List of Supported Countries
      • Read List of Supported Regions
      • Read Holiday Information by Country
      • Read Holiday Information by Country and Region
  • Firebase
    • Read firebase service accounts
    • Add firebase service account
  • SSL Certificates
    • Read SSL certificates for CertManager
    • Read SSL certificate by Common Name
    • Create SSL certificate for CertManager
    • Update SSL certificate for CertManager
    • Delete SSL certificate for CertManager
  1. Messages

Get Messages for Messagesession

GET
/domains/{domain}/users/{user}/messagesessions/{messagesession}/messages
Last modified:2023-12-21 20:52:24
OperationId:GetMessagesForMessagesession

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
domain
string 
required
user
string 
required
messagesession
string 
required
Query Params
limit
integer 
optional
Example:
10

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//users//messagesessions//messages'

Responses

🟢200OK
application/json
Body
array of:
id
required
This is the ID of the message
Any of
timestamp
enum<string> 
required
This is when the message was recieved or sent
Allowed value:
YYYY-MM-DDTHH:MM:SS.ssZ
type
string 
required
This is the type of message. Can be chat, sms, mms, chat-media, chat-video, chat-participant-(statuschanges)
Examples:
chatsmsmmschat-mediachat-videochat-participant-(status-changes)
domain
string 
required
This is the domain of the message
<= 64 characters
Examples:
example.commyDomaintest.12123
Match pattern:
^[A-Za-z0-9._-]+|\*
direction
string 
required
This is the direction of the message. Either term for outbound or orig for inbound
Examples:
termorig
from-number
optional
This is the SMS number the message came from. Is not set for chat messages
Any of
from-user-id
string  | null 
required
This is the User ID the message came from. Not set for offnet numbers
from-video-attendee-id
string  | null 
required
This is the video attendee id the message came from if sent within a video call
from-user-agent
string  | null 
required
This is the HTTP USER AGENT the message came from
dialed
string  | null 
required
This is the number that this message is sent to. This can be comma seperated list of numbers if more than one in a group MMS session. Or null for chat sessions
text
string  | integer  | boolean  | array  | object  | number  | null 
required
This is the text sent in the message
terminating-user-id
string  | null 
required
This is the receiving User ID of the message
terminating-number
string  | null 
required
This is the number that this message is sent to. This can be comma seperated list of numbers if more than one in a group MMS session. Or null for chat sessions
status
string 
required
This is the status of the message
video-instance-id
string  | null 
optional
This is the video instance ID of the message if the message was sent from a video session.
media-type
string  | null 
required
This is the media type of the message if applicable
media-size
integer  | null 
required
This is the media size of the message if applicable
deleted-datetime
optional
This is the deleted timestamp of the message if the message was deleted by a host in a video meeting
Any of
This is the time stamp that the formated via RFC 3339
Allowed value:
YYYY-MM-DDTHH:MM:SS.ssZ
messagesession-reciever-hostname
string 
required
This is the receiver hostname for the message
messagesession-id
string 
required
This is the messagesession ID for this message
messagesession-participants
string  | null 
required
This is the comma seperated participants of the messagesession associated with this message
Examples
[
  {
    "id": 20202178326,
    "timestamp": "2023-07-31 23:52:35",
    "type": "chat",
    "domain": "portal",
    "direction": "",
    "dialed": "",
    "text": "whatu p",
    "status": "sending",
    "messagesession-reciever-hostname": "eng0-san.netsapiens.com",
    "from-number": "",
    "from-user-id": "2500@portal",
    "from-video-attendee-id": null,
    "from-user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KH",
    "terminating-user-id": "2503@portal",
    "terminating-number": "",
    "messagesession-id": "177b39bb06162ce930be0657f9286781",
    "video-instance-id": null,
    "media-type": "",
    "media-size": 0,
    "messagesession-participants": null,
    "deleted-timestamp": ""
  },
  {
    "id": 71086444177,
    "timestamp": "2023-07-31 23:51:20",
    "type": "chat",
    "domain": "portal",
    "direction": "",
    "dialed": "",
    "text": "jjjj",
    "status": "sending",
    "messagesession-reciever-hostname": "eng2-phx.netsapiens.com",
    "from-number": "",
    "from-user-id": "2500@portal",
    "from-video-attendee-id": null,
    "from-user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KH",
    "terminating-user-id": "2503@portal",
    "terminating-number": "",
    "messagesession-id": "177b39bb06162ce930be0657f9286781",
    "video-instance-id": null,
    "media-type": "",
    "media-size": 0,
    "messagesession-participants": null,
    "deleted-timestamp": ""
  },
  {
    "id": 97091760995,
    "timestamp": "2023-07-31 23:51:16",
    "type": "chat",
    "domain": "portal",
    "direction": "",
    "dialed": "",
    "text": "asdf",
    "status": "sending",
    "messagesession-reciever-hostname": "eng2-phx.netsapiens.com",
    "from-number": "",
    "from-user-id": "2500@portal",
    "from-video-attendee-id": null,
    "from-user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KH",
    "terminating-user-id": "2503@portal",
    "terminating-number": "",
    "messagesession-id": "177b39bb06162ce930be0657f9286781",
    "video-instance-id": null,
    "media-type": "",
    "media-size": 0,
    "messagesession-participants": null,
    "deleted-timestamp": ""
  },
  {
    "id": 41354275372,
    "timestamp": "2023-07-31 23:51:09",
    "type": "chat",
    "domain": "portal",
    "direction": "",
    "dialed": "",
    "text": "asdf",
    "status": "sending",
    "messagesession-reciever-hostname": "eng2-phx.netsapiens.com",
    "from-number": "",
    "from-user-id": "2500@portal",
    "from-video-attendee-id": null,
    "from-user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KH",
    "terminating-user-id": "2503@portal",
    "terminating-number": "",
    "messagesession-id": "177b39bb06162ce930be0657f9286781",
    "video-instance-id": null,
    "media-type": "",
    "media-size": 0,
    "messagesession-participants": null,
    "deleted-timestamp": ""
  },
  {
    "id": 67088400653,
    "timestamp": "2023-07-31 23:50:51",
    "type": "chat",
    "domain": "portal",
    "direction": "",
    "dialed": "",
    "text": "asdf",
    "status": "sending",
    "messagesession-reciever-hostname": "eng2-phx.netsapiens.com",
    "from-number": "",
    "from-user-id": "2500@portal",
    "from-video-attendee-id": null,
    "from-user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KH",
    "terminating-user-id": "2503@portal",
    "terminating-number": "",
    "messagesession-id": "177b39bb06162ce930be0657f9286781",
    "video-instance-id": null,
    "media-type": "",
    "media-size": 0,
    "messagesession-participants": null,
    "deleted-timestamp": ""
  }
]
🟠404Record not found
🟠400Bad Request
🟠401Authentication Required
Modified at 2023-12-21 20:52:24
Previous
Get Messagesessions for User
Next
Send a message (Chat)
Built with