Sign in

v1

latestOpenAPI 3.1.02026-07-24317911.4 MB
Messages

Get Messagesessions for Domain

get/domains/{domain}/messagesessions

Path parameters

domainstring required

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.

Example:example.com

Query parameters

limitnumber

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.

Response

userstring required

This is the main user extension for the user account.

domainstring required

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 (*).

messagesession-mutedstring required

This is whether or not the message session is muted or not. "yes" or "no"

messagesession-idstring required

This is the identifier for the session

messagesession-last-datetimestring nullable required

This is the last time the session had an inbound or outbound message

messagesession-start-datetimestring nullable required

This is the when the message session started

messagesession-last-senderstring nullable required

This shows the UID or the phonenumber of who was the last message sender

messagesession-last-statusstring nullable required

This is the last status of the messagesession. Will contain read/unread status

messagesession-last-email-reminder-datetimestring nullable required

This is when the last email reminder was sent out notifiying the user of a missed message

messagesession-reciever-hostnamestring required

This is the hostname of the last received message

messagesession-queue-terminationstring nullable required

This is which SMS queue the messagesession is assigned to

messagesession-queue-statusstring nullable required

This is the queue status of the messagesession

messagesession-queue-session-idstring nullable required

This is the queue session id placed on the messagesession

messagesession-agent-start-datetimestring nullable required

This is when the messagesession was started by the agent

messagesession-last-typestring required
messagesession-last-media-typestring nullable required

This is the last media type of the messagesession

messagesession-last-media-sizeinteger nullable required

This is the size of the last media of the messagesession

messagesession-typestring required

This is the type of messagesession

messagesession-namestring nullable

This is the name of the messagesession. Names can be assigned to group chats

messagesession-participantsstring nullable

This is a comma seperated list of participants within a group chat or group sms messagesession

Example response

[
  {
    "user": "1000",
    "domain": "example.com",
    "messagesession-last-type": "chat"
  }
]