Chatinbox Chat API
The Chat API from Chatinbox — 22 operation(s) for chat.
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/chatinbox-net:chatinbox-net-chat-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: Chatinbox Net Chat API
version: '1.0'
x-refined-note:
- x-source differs across the merged source definitions and was not carried
description: 'Operations tagged Chat across 2 of this provider''s published API definitions: chatinbox-net-openapi-original.json, chatinbox-net-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.chatinbox.net
description: Host serving the Swagger UI and this spec (spec has no servers[]; paths are relative to it)
security:
- Bearer: []
tags:
- name: Chat
paths:
/api/chats:
get:
tags:
- Chat
parameters:
- name: takeAll
in: query
schema:
type: boolean
default: false
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chats
x-summary-source: derived
operationId: getApiChats
x-operation-id-source: derived
post:
tags:
- Chat
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ChatVM'
application/json:
schema:
$ref: '#/components/schemas/ChatVM'
text/json:
schema:
$ref: '#/components/schemas/ChatVM'
application/*+json:
schema:
$ref: '#/components/schemas/ChatVM'
responses:
'200':
description: Success
summary: Create api chats
x-summary-source: derived
operationId: postApiChats
x-operation-id-source: derived
/api/chats/{id}:
get:
tags:
- Chat
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: pageNumber
in: query
schema:
type: integer
format: int32
default: 1
- name: pageSize
in: query
schema:
type: integer
format: int32
default: 2147483647
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chats by id
x-summary-source: derived
operationId: getApiChatsById
x-operation-id-source: derived
/api/chatsphonenumber/{id}:
get:
tags:
- Chat
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: pageNumber
in: query
schema:
type: integer
format: int32
default: 1
- name: pageSize
in: query
schema:
type: integer
format: int32
default: 2147483647
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chatsphonenumber by id
x-summary-source: derived
operationId: getApiChatsphonenumberById
x-operation-id-source: derived
/api/chats/start-chat:
post:
tags:
- Chat
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ChatVM'
application/json:
schema:
$ref: '#/components/schemas/ChatVM'
text/json:
schema:
$ref: '#/components/schemas/ChatVM'
application/*+json:
schema:
$ref: '#/components/schemas/ChatVM'
responses:
'200':
description: Success
summary: Create api chats start chat
x-summary-source: derived
operationId: postApiChatsStartChat
x-operation-id-source: derived
/api/chats/performance-report:
get:
tags:
- Chat
parameters:
- name: startDate
in: query
schema:
type: string
format: date-time
- name: endDate
in: query
schema:
type: string
format: date-time
- name: selectedInstanceStr
in: query
schema:
type: string
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chats performance report
x-summary-source: derived
operationId: getApiChatsPerformanceReport
x-operation-id-source: derived
/api/chats/performanceoperation-report:
get:
tags:
- Chat
parameters:
- name: startDate
in: query
schema:
type: string
format: date-time
- name: endDate
in: query
schema:
type: string
format: date-time
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chats performanceoperation report
x-summary-source: derived
operationId: getApiChatsPerformanceoperationReport
x-operation-id-source: derived
/api/chats/customer-report:
get:
tags:
- Chat
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/CustomerFilterVM'
application/json:
schema:
$ref: '#/components/schemas/CustomerFilterVM'
text/json:
schema:
$ref: '#/components/schemas/CustomerFilterVM'
application/*+json:
schema:
$ref: '#/components/schemas/CustomerFilterVM'
responses:
'200':
description: Success
summary: Get api chats customer report
x-summary-source: derived
operationId: getApiChatsCustomerReport
x-operation-id-source: derived
post:
tags:
- Chat
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/CustomerFilterVM'
application/json:
schema:
$ref: '#/components/schemas/CustomerFilterVM'
text/json:
schema:
$ref: '#/components/schemas/CustomerFilterVM'
application/*+json:
schema:
$ref: '#/components/schemas/CustomerFilterVM'
responses:
'200':
description: Success
summary: Create api chats customer report
x-summary-source: derived
operationId: postApiChatsCustomerReport
x-operation-id-source: derived
/api/chats/instanceperformance-report:
get:
tags:
- Chat
parameters:
- name: startDate
in: query
schema:
type: string
format: date-time
- name: endDate
in: query
schema:
type: string
format: date-time
- name: selectedInstanceStr
in: query
schema:
type: string
- name: includeunsuccesfulmessage
in: query
schema:
type: boolean
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chats instanceperformance report
x-summary-source: derived
operationId: getApiChatsInstanceperformanceReport
x-operation-id-source: derived
/api/chats/upload-file:
post:
tags:
- Chat
parameters:
- name: isRecordingFile
in: query
schema:
type: boolean
default: false
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Create api chats upload file
x-summary-source: derived
operationId: postApiChatsUploadFile
x-operation-id-source: derived
/api/chats/getimage:
get:
tags:
- Chat
parameters:
- name: id
in: query
schema:
type: string
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chats getimage
x-summary-source: derived
operationId: getApiChatsGetimage
x-operation-id-source: derived
/api/chats/users:
get:
tags:
- Chat
parameters:
- name: userId
in: query
schema:
type: integer
format: int32
- name: startDate
in: query
schema:
type: string
format: date-time
- name: endDate
in: query
schema:
type: string
format: date-time
- name: filterText
in: query
schema:
type: string
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chats users
x-summary-source: derived
operationId: getApiChatsUsers
x-operation-id-source: derived
/api/chats/userchats/{id}:
get:
tags:
- Chat
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: startDate
in: query
schema:
type: string
format: date-time
- name: endDate
in: query
schema:
type: string
format: date-time
- name: filterText
in: query
schema:
type: string
- name: chatId
in: query
schema:
type: integer
format: int32
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chats userchats by id
x-summary-source: derived
operationId: getApiChatsUserchatsById
x-operation-id-source: derived
/api/chats/userchatmessages/{id}:
get:
tags:
- Chat
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: startDate
in: query
schema:
type: string
format: date-time
- name: endDate
in: query
schema:
type: string
format: date-time
- name: filterText
in: query
schema:
type: string
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chats userchatmessages by id
x-summary-source: derived
operationId: getApiChatsUserchatmessagesById
x-operation-id-source: derived
/api/chats/fetchnextchunkchats:
post:
tags:
- Chat
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ChatFilterVM'
application/json:
schema:
$ref: '#/components/schemas/ChatFilterVM'
text/json:
schema:
$ref: '#/components/schemas/ChatFilterVM'
application/*+json:
schema:
$ref: '#/components/schemas/ChatFilterVM'
responses:
'200':
description: Success
summary: Create api chats fetchnextchunkchats
x-summary-source: derived
operationId: postApiChatsFetchnextchunkchats
x-operation-id-source: derived
/api/chatsv2:
post:
tags:
- Chat
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ChatFilterVM'
application/json:
schema:
$ref: '#/components/schemas/ChatFilterVM'
text/json:
schema:
$ref: '#/components/schemas/ChatFilterVM'
application/*+json:
schema:
$ref: '#/components/schemas/ChatFilterVM'
responses:
'200':
description: Success
summary: Create api chatsv2
x-summary-source: derived
operationId: postApiChatsv2
x-operation-id-source: derived
/api/chats/unreadchatscount:
get:
tags:
- Chat
parameters:
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chats unreadchatscount
x-summary-source: derived
operationId: getApiChatsUnreadchatscount
x-operation-id-source: derived
/api/chats/transferredchatscount:
get:
tags:
- Chat
parameters:
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chats transferredchatscount
x-summary-source: derived
operationId: getApiChatsTransferredchatscount
x-operation-id-source: derived
/api/chats/offlinechatscount:
get:
tags:
- Chat
parameters:
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chats offlinechatscount
x-summary-source: derived
operationId: getApiChatsOfflinechatscount
x-operation-id-source: derived
/api/getchatbyidv2/{id}:
get:
tags:
- Chat
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api getchatbyidv2 by id
x-summary-source: derived
operationId: getApiGetchatbyidv2ById
x-operation-id-source: derived
/api/chats/chatcountdetail:
get:
tags:
- Chat
parameters:
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chats chatcountdetail
x-summary-source: derived
operationId: getApiChatsChatcountdetail
x-operation-id-source: derived
/api/chats/getagenttodaychats:
get:
tags:
- Chat
parameters:
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chats getagenttodaychats
x-summary-source: derived
operationId: getApiChatsGetagenttodaychats
x-operation-id-source: derived
/api/chats/upload-library-file:
post:
tags:
- Chat
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: '#/components/schemas/LibraryItemFileVM'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LibraryItemFileVM'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/LibraryItemFileVM'
application/*+json:
schema:
type: array
items:
$ref: '#/components/schemas/LibraryItemFileVM'
responses:
'200':
description: Success
summary: Create api chats upload library file
x-summary-source: derived
operationId: postApiChatsUploadLibraryFile
x-operation-id-source: derived
components:
schemas:
CallReasonVM:
type: object
properties:
id:
type: integer
format: int32
name:
type:
- string
- 'null'
additionalProperties: false
FeatureVM:
type: object
properties:
id:
type: integer
format: int32
name:
type:
- string
- 'null'
featureType:
type: integer
format: int32
rgbCode:
type:
- string
- 'null'
featureGroupID:
type:
- integer
- 'null'
format: int32
dataStatus:
type: integer
format: int32
activeSelectionCount:
type: integer
format: int32
flagMinutes:
type:
- integer
- 'null'
format: int32
sortOrder:
type: integer
format: int32
additionalProperties: false
CustomerPhoneVM:
type: object
properties:
id:
type: integer
format: int32
customerID:
type: integer
format: int32
phone:
type:
- string
- 'null'
additionalProperties: false
ChatFilterVM:
type: object
properties:
userId:
type: integer
format: int32
takeAll:
type: boolean
skip:
type: integer
format: int32
take:
type: integer
format: int32
searchText:
type:
- string
- 'null'
featureFilter:
type:
- string
- 'null'
ascDesc:
type: boolean
chatFilterType:
$ref: '#/components/schemas/ChatFilterType'
userFilter:
type:
- integer
- 'null'
format: int32
searchAreaType:
$ref: '#/components/schemas/SearchAreaType'
channelID:
type: integer
format: int32
ownerUserID:
type: integer
format: int32
superAdmin:
type: boolean
additionalProperties: false
CustomerFilterVM:
type: object
properties:
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
selectedInstances:
type:
- array
- 'null'
items:
type: string
selectedUsers:
type:
- array
- 'null'
items:
type: integer
format: int32
additionalProperties: false
SearchAreaType:
enum:
- 0
- 1
- 2
type: integer
format: int32
ChatVM:
type: object
properties:
companyCode:
type:
- string
- 'null'
id:
type: integer
format: int32
instanceID:
type: integer
format: int32
instancePhoneNumber:
type:
- string
- 'null'
instanceChatID:
type:
- string
- 'null'
customerID:
type:
- integer
- 'null'
format: int32
customerPhoneNumber:
type:
- string
- 'null'
ownerUserID:
type:
- integer
- 'null'
format: int32
lastMessageTime:
type:
- string
- 'null'
format: date-time
lastMessageID:
type:
- integer
- 'null'
format: int32
lastMessageText:
type:
- string
- 'null'
lastMessageType:
type:
- integer
- 'null'
format: int32
lastMessageStatus:
type:
- integer
- 'null'
format: int32
lastMessageSystemMessageType:
type:
- integer
- 'null'
format: int32
lastMessageSystemNotificationType:
type:
- integer
- 'null'
format: int32
lastMessageFromMe:
type:
- boolean
- 'null'
hasOfflineMessage:
type:
- boolean
- 'null'
transferred:
type:
- boolean
- 'null'
startedByCustomer:
type:
- boolean
- 'null'
customerFullName:
type:
- string
- 'null'
customerName:
type:
- string
- 'null'
customerSurname:
type:
- string
- 'null'
customerNote:
type:
- string
- 'null'
customerEmail:
type:
- string
- 'null'
customerPushName:
type:
- string
- 'null'
unViewedCount:
type: integer
format: int32
image:
type:
- string
- 'null'
waitCallMeLater:
type: boolean
ownerUserName:
type:
- string
- 'null'
ownerUserFullName:
type:
- string
- 'null'
ownerUserIconText:
type:
- string
- 'null'
lastSendUserName:
type:
- string
- 'null'
lastSendUserFullName:
type:
- string
- 'null'
lastSendUserIconText:
type:
- string
- 'null'
customer:
$ref: '#/components/schemas/CustomerVM'
chatMessages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ChatMessageVM'
chatDynamicMessages:
type:
- object
- 'null'
additionalProperties: false
allCustomerFeatures:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/FeatureVM'
featuresString:
type:
- string
- 'null'
customerFeatures:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/FeatureVM'
servingUserID:
type: integer
format: int32
operationStatus:
type: boolean
additionalProperties: false
ChatMessageVM:
type: object
properties:
id:
type: integer
format: int32
chatID:
type: integer
format: int32
customerID:
type: integer
format: int32
userID:
type:
- integer
- 'null'
format: int32
fromMe:
type: boolean
instanceMessageID:
type:
- string
- 'null'
systemMessageID:
type:
- string
- 'null'
messageType:
type:
- integer
- 'null'
format: int32
body:
type:
- string
- 'null'
messageStatus:
type:
- integer
- 'null'
format: int32
sentTime:
type:
- string
- 'null'
format: date-time
deliveredTime:
type:
- string
- 'null'
format: date-time
viewedTime:
type:
- string
- 'null'
format: date-time
preview:
type:
- string
- 'null'
sendUserName:
type:
- string
- 'null'
sendUserFullName:
type:
- string
- 'null'
targetUserName:
type:
- string
- 'null'
targetUserFullName:
type:
- string
- 'null'
sendUserIconText:
type:
- string
- 'null'
matchingMessageRow:
type: boolean
locationLat:
type:
- string
- 'null'
locationLng:
type:
- string
- 'null'
caption:
type:
- string
- 'null'
systemMessageType:
type:
- integer
- 'null'
format: int32
systemNotificationType:
type:
- integer
- 'null'
format: int32
isForwarded:
type: boolean
hasQuotedMessage:
type: boolean
quotedMessageID:
type:
- string
- 'null'
chatMessageAttachments:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ChatMessageAttachmentVM'
additionalProperties: false
CallMeLaterVM:
type: object
properties:
id:
type: integer
format: int32
customerID:
type: integer
format: int32
chatID:
type:
- integer
- 'null'
format: int32
callReasonID:
type:
- integer
- 'null'
format: int32
callReasonName:
type:
- string
- 'null'
note:
type:
- string
- 'null'
relatedUserID:
type: integer
format: int32
relatedUserName:
type:
- string
- 'null'
relatedUserFullName:
type:
- string
- 'null'
relatedTime:
type:
- string
- 'null'
format: date-time
workGroupID:
type:
- integer
- 'null'
format: int32
isCompleted:
type: boolean
completedUserID:
type:
- integer
- 'null'
format: int32
completedUserName:
type:
- string
- 'null'
completedUserFullName:
type:
- string
- 'null'
completedTime:
type:
- string
- 'null'
format: date-time
createDate:
type:
- string
- 'null'
format: date-time
customerFullName:
type:
- string
- 'null'
callReason:
$ref: '#/components/schemas/CallReasonVM'
allCallReasons:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CallReasonVM'
additionalProperties: false
LibraryItemFileVM:
type: object
properties:
libraryID:
type: integer
format: int32
itemUrl:
type:
- string
- 'null'
id:
type: integer
format: int32
name:
type:
- string
- 'null'
libraryType:
$ref: '#/components/schemas/LibraryType'
additionalProperties: false
ChatFilterType:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
type: integer
format: int32
LibraryType:
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 9
- 10
type: integer
format: int32
CustomerVM:
type: object
properties:
id:
type: integer
format: int32
name:
type:
- string
- 'null'
surName:
type:
- string
- 'null'
pushName:
type:
- string
- 'null'
fullName:
type:
- string
- 'null'
note:
type:
- string
- 'null'
lastMessageID:
type:
- integer
- 'null'
format: int32
email:
type:
- string
- 'null'
chatId:
type: integer
format: int32
customerPhones:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CustomerPhoneVM'
customerFeatures:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/FeatureVM'
callMeLaters:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CallMeLaterVM'
cf1:
type:
- string
- 'null'
cf2:
type:
- string
- 'null'
cf3:
type:
- string
- 'null'
cf4:
type:
- string
- 'null'
cf5:
type:
- string
- 'null'
cf6:
type:
- string
- 'null'
cf7:
type:
- string
- 'null'
cf8:
type:
- string
- 'null'
cf9:
type:
- string
- 'null'
cf10:
type:
- string
- 'null'
dataListID:
type: integer
format: int32
additionalProperties: false
ChatMessageAttachmentVM:
type: object
properties:
id:
type: integer
format: int32
messageID:
type: integer
format: int32
fileGuid:
type: string
format: uuid
fileName:
type:
- string
- 'null'
fileExtension:
type:
- string
- 'null'
fileBinary:
type:
- string
- 'null'
format: byte
fileVirtualPath:
type:
- string
- 'null'
additionalProperties: false
securitySchemes:
Bearer:
type: apiKey
description: 'JWT Authorization header. Örnek: "Bearer {token}"'
name: Authorization
in: header
x-refined-from:
- chatinbox-net-openapi-original.json
- chatinbox-net-openapi.yml