Chatinbox Chatv3 API
The Chatv3 API from Chatinbox — 17 operation(s) for chatv3.
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-chatv3-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 Chatv3 API
version: '1.0'
x-refined-note:
- x-source differs across the merged source definitions and was not carried
description: 'Operations tagged Chatv3 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: Chatv3
paths:
/api/chatsv3/getcompanychannels:
get:
tags:
- Chatv3
parameters:
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chatsv3 getcompanychannels
x-summary-source: derived
operationId: getApiChatsv3Getcompanychannels
x-operation-id-source: derived
/api/chatsv3/chatcount:
post:
tags:
- Chatv3
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ChatCountFilter'
application/json:
schema:
$ref: '#/components/schemas/ChatCountFilter'
text/json:
schema:
$ref: '#/components/schemas/ChatCountFilter'
application/*+json:
schema:
$ref: '#/components/schemas/ChatCountFilter'
responses:
'200':
description: Success
summary: Create api chatsv3 chatcount
x-summary-source: derived
operationId: postApiChatsv3Chatcount
x-operation-id-source: derived
/api/chatsv3:
post:
tags:
- Chatv3
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ChatFilter'
application/json:
schema:
$ref: '#/components/schemas/ChatFilter'
text/json:
schema:
$ref: '#/components/schemas/ChatFilter'
application/*+json:
schema:
$ref: '#/components/schemas/ChatFilter'
responses:
'200':
description: Success
summary: Create api chatsv3
x-summary-source: derived
operationId: postApiChatsv3
x-operation-id-source: derived
/api/chatsv3basic:
post:
tags:
- Chatv3
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ChatFilter'
application/json:
schema:
$ref: '#/components/schemas/ChatFilter'
text/json:
schema:
$ref: '#/components/schemas/ChatFilter'
application/*+json:
schema:
$ref: '#/components/schemas/ChatFilter'
responses:
'200':
description: Success
summary: Create api chatsv3basic
x-summary-source: derived
operationId: postApiChatsv3basic
x-operation-id-source: derived
/api/chatsv3/getchatviewbyid:
post:
tags:
- Chatv3
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ChatViewFilter'
application/json:
schema:
$ref: '#/components/schemas/ChatViewFilter'
text/json:
schema:
$ref: '#/components/schemas/ChatViewFilter'
application/*+json:
schema:
$ref: '#/components/schemas/ChatViewFilter'
responses:
'200':
description: Success
summary: Create api chatsv3 getchatviewbyid
x-summary-source: derived
operationId: postApiChatsv3Getchatviewbyid
x-operation-id-source: derived
/api/chatsv3/updatecustomerv3:
post:
tags:
- Chatv3
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/Customerv3VM'
application/json:
schema:
$ref: '#/components/schemas/Customerv3VM'
text/json:
schema:
$ref: '#/components/schemas/Customerv3VM'
application/*+json:
schema:
$ref: '#/components/schemas/Customerv3VM'
responses:
'200':
description: Success
summary: Create api chatsv3 updatecustomerv3
x-summary-source: derived
operationId: postApiChatsv3Updatecustomerv3
x-operation-id-source: derived
/api/chatsv3/getchatbyid:
post:
tags:
- Chatv3
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
type: object
additionalProperties: false
application/json:
schema:
type: object
additionalProperties: false
text/json:
schema:
type: object
additionalProperties: false
application/*+json:
schema:
type: object
additionalProperties: false
responses:
'200':
description: Success
summary: Create api chatsv3 getchatbyid
x-summary-source: derived
operationId: postApiChatsv3Getchatbyid
x-operation-id-source: derived
/api/chatsv3/start-chat:
post:
tags:
- Chatv3
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/Chatv3VM'
application/json:
schema:
$ref: '#/components/schemas/Chatv3VM'
text/json:
schema:
$ref: '#/components/schemas/Chatv3VM'
application/*+json:
schema:
$ref: '#/components/schemas/Chatv3VM'
responses:
'200':
description: Success
summary: Create api chatsv3 start chat
x-summary-source: derived
operationId: postApiChatsv3StartChat
x-operation-id-source: derived
/api/chatsv3/start-chat-v3:
post:
tags:
- Chatv3
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ChartStartControlVM'
application/json:
schema:
$ref: '#/components/schemas/ChartStartControlVM'
text/json:
schema:
$ref: '#/components/schemas/ChartStartControlVM'
application/*+json:
schema:
$ref: '#/components/schemas/ChartStartControlVM'
responses:
'200':
description: Success
summary: Create api chatsv3 start chat v3
x-summary-source: derived
operationId: postApiChatsv3StartChatV3
x-operation-id-source: derived
/api/chatsv3/chat-channel-count:
get:
tags:
- Chatv3
parameters:
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chatsv3 chat channel count
x-summary-source: derived
operationId: getApiChatsv3ChatChannelCount
x-operation-id-source: derived
/api/chatsv3/find-chat-with-zoho-source:
post:
tags:
- Chatv3
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/FindChatWithZohoSourceVM'
application/json:
schema:
$ref: '#/components/schemas/FindChatWithZohoSourceVM'
text/json:
schema:
$ref: '#/components/schemas/FindChatWithZohoSourceVM'
application/*+json:
schema:
$ref: '#/components/schemas/FindChatWithZohoSourceVM'
responses:
'200':
description: Success
summary: Create api chatsv3 find chat with zoho source
x-summary-source: derived
operationId: postApiChatsv3FindChatWithZohoSource
x-operation-id-source: derived
/api/chatsv3/find-chat-by-phonenumber/{id}:
get:
tags:
- Chatv3
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api chatsv3 find chat by phonenumber by id
x-summary-source: derived
operationId: getApiChatsv3FindChatByPhonenumberById
x-operation-id-source: derived
/api/chatsv3/find-chat-by-id/{id}:
get:
tags:
- Chatv3
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 chatsv3 find chat by id by id
x-summary-source: derived
operationId: getApiChatsv3FindChatByIdById
x-operation-id-source: derived
/api/chatsv3/getgroups/{id}:
get:
tags:
- Chatv3
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 chatsv3 getgroups by id
x-summary-source: derived
operationId: getApiChatsv3GetgroupsById
x-operation-id-source: derived
/api/chatsv3/block-phone-number:
post:
tags:
- Chatv3
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/BlockPhoneNumberVM'
application/json:
schema:
$ref: '#/components/schemas/BlockPhoneNumberVM'
text/json:
schema:
$ref: '#/components/schemas/BlockPhoneNumberVM'
application/*+json:
schema:
$ref: '#/components/schemas/BlockPhoneNumberVM'
responses:
'200':
description: Success
summary: Create api chatsv3 block phone number
x-summary-source: derived
operationId: postApiChatsv3BlockPhoneNumber
x-operation-id-source: derived
/api/chatsv3/unblock-phone-number:
post:
tags:
- Chatv3
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/BlockPhoneNumberVM'
application/json:
schema:
$ref: '#/components/schemas/BlockPhoneNumberVM'
text/json:
schema:
$ref: '#/components/schemas/BlockPhoneNumberVM'
application/*+json:
schema:
$ref: '#/components/schemas/BlockPhoneNumberVM'
responses:
'200':
description: Success
summary: Create api chatsv3 unblock phone number
x-summary-source: derived
operationId: postApiChatsv3UnblockPhoneNumber
x-operation-id-source: derived
/api/chatsv3/get-all-chat-messages/{id}:
get:
tags:
- Chatv3
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 chatsv3 get all chat messages by id
x-summary-source: derived
operationId: getApiChatsv3GetAllChatMessagesById
x-operation-id-source: derived
components:
schemas:
FindChatWithZohoSourceVM:
type: object
properties:
phoneNumber:
type:
- string
- 'null'
channelID:
type: integer
format: int32
additionalProperties: false
ChatCountFilter:
type: object
properties:
chatGeneralFilterType:
$ref: '#/components/schemas/ChatGeneralFilterType'
channelID:
type: integer
format: int32
featureFilter:
type: integer
format: int32
userFilter:
type:
- integer
- 'null'
format: int32
savedFilterId:
type:
- integer
- 'null'
format: int32
additionalProperties: false
Customerv3VM:
type: object
properties:
id:
type: integer
format: int32
name:
type:
- string
- 'null'
dataListID:
type: integer
format: int32
pushName:
type:
- string
- 'null'
note:
type:
- string
- 'null'
features:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/FeatureVM'
phoneNumber:
type:
- string
- 'null'
phoneNumbers:
type:
- array
- 'null'
items:
type: string
phoneNumberEnc:
type:
- string
- 'null'
phoneNumbersEnc:
type:
- array
- 'null'
items:
type: string
email:
type:
- string
- 'null'
chatID:
type: integer
format: int32
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'
callMeLaters:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CallMeLaterVM'
notCompletedCallMeLaters:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CallMeLaterVM'
isCompletedCallMeLaters:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CallMeLaterVM'
customerAccountID:
type:
- string
- 'null'
notes:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/NoteVM'
chats:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CustomerChatVM'
selections:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CustomerSelectedFeatureVM'
textValues:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CustomerTextValueVM'
additionalProperties: false
ChatGeneralFilterType:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
type: integer
format: int32
NoteVM:
type: object
properties:
id:
type: integer
format: int32
chatID:
type: integer
format: int32
noteContent:
type:
- string
- 'null'
creatingUserID:
type: integer
format: int32
creatingUserName:
type:
- string
- 'null'
customerID:
type: integer
format: int32
createDate:
type: string
format: date-time
isSystemNote:
type: boolean
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
ChatViewFilter:
type: object
properties:
chatID:
type: integer
format: int32
skip:
type: integer
format: int32
take:
type: integer
format: int32
searchText:
type:
- string
- 'null'
additionalProperties: false
CustomerSelectedFeatureVM:
type: object
properties:
featureID:
type: integer
format: int32
featureName:
type:
- string
- 'null'
rgbCode:
type:
- string
- 'null'
featureGroupID:
type: integer
format: int32
featureGroupName:
type:
- string
- 'null'
flagMinutes:
type:
- integer
- 'null'
format: int32
minutesSinceSelected:
type: integer
format: int32
sortOrder:
type: integer
format: int32
additionalProperties: false
CustomerTextValueVM:
type: object
properties:
featureGroupID:
type: integer
format: int32
featureGroupName:
type:
- string
- 'null'
textValue:
type:
- string
- 'null'
additionalProperties: false
InstanceType:
enum:
- 1
- 2
- 3
- 4
- 5
- 6
type: integer
format: int32
ChartStartControlVM:
type: object
properties:
phoneNumber:
type:
- string
- 'null'
instanceId:
type: integer
format: int32
instanceType:
$ref: '#/components/schemas/InstanceType'
controlUserID:
type: integer
format: int32
additionalProperties: false
Chatv3VM:
type: object
properties:
id:
type: integer
format: int32
customerId:
type: integer
format: int32
instancePhoneNumber:
type:
- string
- 'null'
instanceChatId:
type:
- string
- 'null'
instanceChatIdEnc:
type:
- string
- 'null'
ownerUserId:
type: integer
format: int32
servingUserId:
type:
- integer
- 'null'
format: int32
instanceId:
type:
- integer
- 'null'
format: int32
customerPhoneNumber:
type:
- string
- 'null'
customerPhoneNumberEnc:
type:
- string
- 'null'
lastMessageText:
type:
- string
- 'null'
lastMessageTime:
type: string
format: date-time
unViewedCount:
type:
- integer
- 'null'
format: int32
image:
type:
- string
- 'null'
startedByCustomer:
type:
- string
- 'null'
lastMessageId:
type:
- integer
- 'null'
format: int32
name:
type:
- string
- 'null'
surName:
type:
- string
- 'null'
ownerUserName:
type:
- string
- 'null'
operationStatus:
type:
- boolean
- 'null'
ownerUserFullName:
type:
- string
- 'null'
ownerUserIconText:
type:
- string
- 'null'
featuresString:
type:
- string
- 'null'
messageType:
type:
- integer
- 'null'
format: int32
transferred:
type:
- boolean
- 'null'
fromMe:
type:
- boolean
- 'null'
messageStatus:
type:
- integer
- 'null'
format: int32
hasOfflineMessage:
type:
- boolean
- 'null'
systemMessageType:
type:
- integer
- 'null'
format: int32
systemNotificationType:
type:
- integer
- 'null'
format: int32
waitCallMeLater:
type:
- boolean
- 'null'
customerFeatures:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/FeatureVM'
favoriteStatus:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/FavoriteStatusItemVM'
accountName:
type:
- string
- 'null'
instanceType:
type: integer
format: int32
customerAccountID:
type:
- string
- 'null'
isGroup:
type: boolean
instanceAccountID:
type:
- string
- 'null'
pushName:
type:
- string
- 'null'
additionalProperties: false
FavoriteStatusItemVM:
type: object
properties:
featureId:
type: integer
format: int32
name:
type:
- string
- 'null'
rgbCode:
type:
- string
- 'null'
additionalProperties: false
ChatListFilterType:
enum:
- 1
- 2
- 3
- 4
type: integer
format: int32
CallReasonVM:
type: object
properties:
id:
type: integer
format: int32
name:
type:
- string
- 'null'
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
BlockPhoneNumberVM:
type: object
properties:
phoneNumber:
type:
- string
- 'null'
instanceId:
type:
- string
- 'null'
chatId:
type: integer
format: int32
userId:
type: integer
format: int32
additionalProperties: false
ChatFilter:
type: object
properties:
channelID:
type: integer
format: int32
userID:
type: integer
format: int32
skip:
type: integer
format: int32
take:
type: integer
format: int32
ascDesc:
type: boolean
featureFilter:
type:
- string
- 'null'
searchText:
type:
- string
- 'null'
chatListFilterType:
$ref: '#/components/schemas/ChatListFilterType'
chatGeneralFilterType:
$ref: '#/components/schemas/ChatGeneralFilterType'
isSuperAdmin:
type: boolean
userFilter:
type:
- integer
- 'null'
format: int32
gmt:
type: integer
format: int32
filterMinute:
type: integer
format: int32
searchAreaType:
type:
- string
- 'null'
savedFilterId:
type:
- integer
- 'null'
format: int32
additionalProperties: false
CustomerChatVM:
type: object
properties:
id:
type: integer
format: int32
channelID:
type: integer
format: int32
customerPhoneNumber:
type:
- string
- 'null'
customerPhoneNumberEnc:
type:
- string
- 'null'
customerAccountID:
type:
- string
- 'null'
instanceType:
type: integer
format: int32
ownerUserID:
type: integer
format: int32
visible:
type: boolean
manageable:
type: boolean
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