Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/nice:nice-agentmessaging-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Nice Agent Messaging API
version: v1
description: 'Operations tagged AgentMessaging across 2 of this provider''s published API definitions: nice-admin-agentmessage.json, nice-admin-agentmessage-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: AgentMessaging
description: ': Agent Messages'
paths:
/communications/agent-messages:
get:
tags:
- AgentMessaging
summary: Returns a list of paginated Messages for a determined Agent
description: The Agent Messaging GET API is designed to obtain an Agent Message
operationId: get-agent-messages
parameters:
- $ref: '#/components/parameters/searchString'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/orderBy'
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
totalRecords:
type: integer
description: Total message records on Business Unit
businessUnitId:
type: integer
description: Id of the Business Unit
agentMessaging:
type: array
items:
type: object
properties:
messageGroupGuid:
type: string
description: GUID of the message
subject:
type: string
description: Subject of the message
startDate:
type: string
description: Date sent
target:
type: string
description: Target of the message
'400':
description: <p>InvalidParameters</p><p>Invalid Fields List</p>
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Error reason
error_description:
type: string
description: Error description
'401':
description: Unauthorized
'403':
description: <p>Invalid Permissions<p><p>Invalid SecurityUser</p>
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Error reason
error_description:
type: string
description: Error description
'500':
description: Internal server error
post:
tags:
- AgentMessaging
summary: Creates a new Agent Message
description: The Agent Messaging POST API is designed to create an Agent Message
operationId: post-agent-messages
requestBody:
content:
application/json:
schema:
type: object
required:
- expireMinutes
- message
- subject
- targetType
- validUntil
properties:
expireMinutes:
type: number
description: expire minutes for message
message:
type: string
maxLength: 1024
description: text of message
subject:
type: string
maxLength: 100
description: subject of message
targetIds:
type: array
description: target ids to message
items:
type: number
targetType:
type: string
description: target type of message, it can be agent, team, everyone or station
enum:
- agent
- team
- station
- everyone
validUntil:
type: string
description: valid until date of message, the date should be in ISO format
example: '2023-03-01T14:20:05.054Z'
required: true
description: Agent Message parameters to be created
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
messageGroupGuid:
type: string
description: new Message guid identifier
assignedTargetIds:
type: array
items:
type: integer
description: id of the target ids of message
invalidTargetIds:
type: array
items:
type: integer
description: id of the not valid target ids of message
'400':
description: <p>InvalidMessage</p><p>InvalidParameters</p><p>InvalidMessageSize</p><p>InvalidSubject</p><p>InvalidSubjectSize</p><p>InvalidTargetType</p><p>InvalidExpireMinutes</p><p>InvalidDateFormat</p><p>InvalidTargetTypeValue</p><p>InvalidExpireMinutesValue</p><p>InvalidTargetIds</p><p>InvalidTargetIdsDuplicated</p><p>InvalidTargetIdsValue</p><p>InvalidValidUntil</p><p>MessageExpired</p>
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Error reason
error_description:
type: string
description: Error description
'401':
description: Unauthorized
'403':
description: <p>Invalid Permissions<p><p>Invalid SecurityUser</p>
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Error reason
error_description:
type: string
description: Error description
'500':
description: Internal server error
delete:
tags:
- AgentMessaging
summary: Deletes Agent Messages in Batch according to group of guids
description: Agent Messages Batch Delete
operationId: delete-communications-agent-messages
requestBody:
content:
application/json:
schema:
type: object
properties:
groupMessageIds:
type: array
description: Message GUIDs to be deleted
items:
type: string
required: true
description: Goup of Message GUIDs to be deleted
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
deletedGroupMessageIds:
type: string
items:
type: integer
description: id of the deleted Message GUIDs
invalidGroupMessageIds:
type: string
items:
type: integer
description: id of the not valid or not found Message GUIDs
'400':
description: <p>InvalidParameters</p><p>DuplicatedGroupMessageIds</p><p>InvalidGroupMessageIdValue</p>
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: error reason
error_description:
type: string
description: Error description
'401':
description: Unauthorized
'403':
description: <p>Invalid Permissions<p><p>Invalid SecurityUser</p>
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Error reason
error_description:
type: string
description: Error description
'500':
description: Internal server error
/communications/agent-messages/{messageGroupId}:
get:
tags:
- AgentMessaging
summary: Returns a list of paginated agent group messages
description: The Agent Messaging GET API is designed to obtain an Agent Message by Group ID
operationId: get-agent-messages-id
parameters:
- name: messageGroupId
in: path
required: true
description: This parameter contains the messageGroupGuid for the agent message
schema:
type: string
- name: authContext
in: query
description: This parameter contains basic information for an authenticated user. Used to pass data common data to the API methods
schema:
type: string
required: false
- $ref: '#/components/parameters/searchString'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/orderBy'
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
messageGroupGuid:
type: string
description: GUID of the message
sentOn:
type: string
description: Date sent
expireDate:
type: string
description: Expire date
duration:
type: integer
description: Duration of message
subject:
type: string
description: Subject of message
message:
type: string
description: Text of the message
targetType:
type: string
description: Target type, E.g. Agent, Teams, Stations
totalRowCount:
type: integer
description: Total row count
hiddenAgents:
type: integer
description: Hidden agents, only for agents target
agents:
description: Agent target
allOf:
- $ref: '#/components/schemas/agents'
teams:
description: Teams target
allOf:
- $ref: '#/components/schemas/teams'
stations:
description: Stations target
allOf:
- $ref: '#/components/schemas/stations'
'400':
description: <p>Invalid Parameters</p><p>Invalid Group Message ID</p>
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Error reason
error_description:
type: string
description: Error description
'401':
description: Unauthorized
'403':
description: <p>Invalid Permissions<p><p>Invalid SecurityUser</p>
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Error reason
error_description:
type: string
description: Error description
'404':
description: Group MessageId Not Found
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Error reason
error_description:
type: string
description: Error description
'500':
description: Internal server error
delete:
tags:
- AgentMessaging
summary: Deletes an Agent Message by Group Message Guid
operationId: delete-agent-messages-id
parameters:
- name: messageGroupId
in: path
required: true
description: ID of the message Group Id to be deleted
schema:
type: string
responses:
'200':
description: Success
'400':
description: <p>InvalidParameters</p><p>InvalidGroupMessageId</p>
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Error reason
error_description:
type: string
description: Error description
'401':
description: Unauthorized
'403':
description: <p>Invalid Permissions<p><p>Invalid SecurityUser</p>
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Error reason
error_description:
type: string
description: Error description
'404':
description: Group MessageId Not Found
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: error reason
error_description:
type: string
description: Error description
'500':
description: Internal server error
components:
parameters:
skip:
name: skip
description: Number of records to skip in the results
in: query
schema:
type: integer
required: false
searchString:
name: searchString
description: Used to filter results to objects with the value in key fields
in: query
schema:
type: string
required: false
fields:
name: fields
description: Comma separated list of elements to return in response
in: query
schema:
type: string
required: false
orderBy:
name: orderBy
description: Values used to order results before paginating them. Can also specify "asc" or "desc" to specify direction for example "field1 asc,field2 desc,...". Default is asc
in: query
schema:
type: string
required: false
top:
name: top
description: Number of records to return in the results
in: query
schema:
type: integer
required: false
schemas:
stations:
type: array
description: Target stations
items:
type: object
properties:
stationId:
type: integer
description: Station ID
stationName:
type: string
description: Station name
phoneNumber:
type: string
description: Phone number
callerId:
type: string
description: Caller Id
status:
type: boolean
description: Status
profile:
type: integer
description: Profile
teams:
type: array
description: Target teams
items:
type: object
properties:
rowNumber:
type: integer
description: Row number
teamId:
type: integer
description: Team Id
teamName:
type: string
description: Team name
agents:
type: array
description: Target agents
items:
type: object
properties:
userId:
type: integer
description: User Id
firstName:
type: string
description: First name
lastName:
type: string
description: Last name
team:
type: string
description: Team
teamNumber:
type: integer
description: Team number
x-refined-from:
- nice-admin-agentmessage.json
- nice-admin-agentmessage-openapi.yml