Shyft Customer > Chats > ChatMessages API
The Customer > Chats > ChatMessages API from Shyft — 3 operation(s) for customer > chats > chatmessages.
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/shyft-customer-chats-chatmessages-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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: Shyft Customer Customer > Chats > ChatMessages API
description: Welcome to the Shyft Customer App API.
version: 1.0.0
servers:
- url: http://{{host}}
- url: http://{{local-host}}
- url: http://{{sp3-host}}
- url: http://test-service.myshyft.com
- url: http://localhost:4001
- url: http://localhost:3000
- url: http://{{local-host}}api
- url: https://test-unfurl.myshyft.com
tags:
- name: Customer > Chats > ChatMessages
paths:
/api/customer/user_role/chat_sessions/{chat_session_id}/chat_messages:
get:
tags:
- Customer > Chats > ChatMessages
summary: get chat messages
description: 'Description
- - -
- Get all visiable chat message with given session ID
- Not showing message before quited
- Still showing archived messages
Params
- - -
Param | Values | R |Description
--- | --- | --- | ---
Headers
- - -
Header | Values | R |Description
--- | --- | --- | ---
Input
- - -
Attribute | Values | R |Description
--- | --- | --- | ---'
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: chat_session_id
in: path
schema:
type: string
required: true
responses:
'200':
description: OK
headers:
X-Frame-Options:
schema:
type: string
example: SAMEORIGIN
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-LS-License:
schema:
type: string
example: All Rights Reserved © Coffee Enterprise
X-LS-Application:
schema:
type: string
example: Coffee Mobile
X-Request-Method:
schema:
type: string
example: '{{x_method}}'
Content-Type:
schema:
type: string
example: application/json; charset=utf-8
ETag:
schema:
type: string
example: W/"ee7dc9088c241c39a750254a2a087b8a"
Cache-Control:
schema:
type: string
example: max-age=0, private, must-revalidate
Set-Cookie:
schema:
type: string
example: _shyft_api_server_session=ZURQL3RyV0pFSFlJbENWZ3lnM2U2MmRwMzRZS0hrQVdndHhLMUYydVB6WlY3T0ZDWWMrVmdLb09tUHQ1R2dva0ZhVFRHdE5aL0NHelJ0dkZkS0RrN3c9PS0tNERYZllUSGx3TUV2K2NIYXBTVkZWQT09--66fd3d65939cc5858deb79b37e6c74edf2e0ae90; path=/; HttpOnly
X-Rack-Dev-Mark-Env:
schema:
type: string
example: Bin%27s+Local+Server
X-Request-Id:
schema:
type: string
example: e562c764-8d7f-406a-baf0-8e3efbdd2086
X-Runtime:
schema:
type: number
example: '0.217722'
Vary:
schema:
type: string
example: Origin
Connection:
schema:
type: string
example: close
Server:
schema:
type: string
example: thin 1.5.1 codename Straight Razor
content:
application/json:
schema:
type: object
example:
chat_messages:
- _associations_removed: true
_parent_object_id: null
id: 12199
message: hello world3
sender_id: 9568
session_id: 3033
message_type: message_default
attachment: null
created_at: '2018-11-03T00:30:12.794Z'
- _associations_removed: true
_parent_object_id: null
id: 12200
message: hello world3
sender_id: 9568
session_id: 3033
message_type: message_default
attachment: null
created_at: '2018-11-03T00:30:27.043Z'
- _associations_removed: true
_parent_object_id: null
id: 12201
message: hello world3
sender_id: 9568
session_id: 3033
message_type: message_default
attachment: null
created_at: '2018-11-03T00:30:50.691Z'
- _associations_removed: true
_parent_object_id: null
id: 12202
message: hello world3
sender_id: 9568
session_id: 3033
message_type: message_default
attachment: null
created_at: '2018-11-03T03:42:38.805Z'
- _associations_removed: true
_parent_object_id: null
id: 12203
message: hello world3
sender_id: 9568
session_id: 3033
message_type: message_default
attachment: null
created_at: '2018-11-03T03:43:48.382Z'
operationId: getApiCustomerUserRoleChatSessionsByChatSessionIdChatMessages
x-operation-id-source: derived
post:
tags:
- Customer > Chats > ChatMessages
summary: create a chat message
description: 'Description
- - -
- Ceate a chat message with given chat session
- Send a image with format: [IMG]url[/IMG] #TODO: Upgrade it
Params
- - -
Param | Values | R |Description
--- | --- | --- | ---
Headers
- - -
Header | Values | R |Description
--- | --- | --- | ---
Input
- - -
Attribute | Values | R |Description
--- | --- | --- | ---
message | | | |'
requestBody:
content:
'*/*':
schema:
type: string
example: '"\t{\n\t \"chat_message\": { \n\t\t \"message\": \"hello world3\",\n\t \"attached_files_blob_ids\": [10]\n\t }\n\t}\n\t\n\t"'
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: chat_session_id
in: path
schema:
type: string
required: true
responses:
'201':
description: Created
headers:
X-Frame-Options:
schema:
type: string
example: SAMEORIGIN
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Download-Options:
schema:
type: string
example: noopen
X-Permitted-Cross-Domain-Policies:
schema:
type: string
example: none
Referrer-Policy:
schema:
type: string
example: strict-origin-when-cross-origin
X-LS-License:
schema:
type: string
example: All Rights Reserved © Coffee Enterprise
X-LS-Application:
schema:
type: string
example: Coffee Mobile
X-Request-Method:
schema:
type: string
example: none
Content-Type:
schema:
type: string
example: application/json; charset=utf-8
ETag:
schema:
type: string
example: W/"0d01c8c29b9001a8d2354606bef0c3bb"
Cache-Control:
schema:
type: string
example: max-age=0, private, must-revalidate
Set-Cookie:
schema:
type: string
example: _shyft_api_server_session=OGMrOERTWGdDcThBbnZNV2RJVllCenIrNFpkQjNTYjNoNzlVNXd1VjJxcVdZaUhuc244MEJMMWx0WmsxWEtMRERSQ1QzY2dQa3hXQmM4MHYveGkrQkE9PS0tY0lUMlo0bERENGEvZ1lVU2QwTEF3Zz09--83bf74af0bcc9619b330d509483e5757847778af; path=/; HttpOnly
X-Rack-Dev-Mark-Env:
schema:
type: string
example: BinLocalServer
X-Request-Id:
schema:
type: string
example: d8dea119-cf25-4077-a660-513358e16de1
X-Runtime:
schema:
type: number
example: '1.014101'
Vary:
schema:
type: string
example: Origin
Transfer-Encoding:
schema:
type: string
example: chunked
content:
application/json:
schema:
type: object
examples:
example-0:
summary: create a chat message - with attachment
value:
chat_message:
_parent_object_id: null
id: 15602
message: hello world3
sender_id: 11284
session_id: 3459
message_type: message_default
attachment: null
created_at: '2020-06-07T03:53:35.330Z'
attached_files_blobs:
- _parent_object_id: 15602
id: 10
content_type: application/pdf
service_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/EKHkMzkgvhiKqvMrXpvnmqmL?sp=r&sv=2016-05-31&se=2020-06-07T03%3A58%3A35Z&rscd=inline%3B+filename%3D%22sample.pdf%22%3B+filename*%3DUTF-8%27%27sample.pdf&rsct=application%2Fpdf&sr=b&sig=dXIDsblCK%2FOSUJLX4zwmeJOuCL0q8mliWJQMHqFG5MM%3D
preview_service_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/variants/foA5wLoV6SPQSdzgm4WB4WB3/a0ec96f9aeb9d604b7135a8679668c2926c2f2937213c3559f3a7ce8423393d2?sp=r&sv=2016-05-31&se=2020-06-07T03%3A58%3A35Z&rscd=inline%3B+filename%3D%22sample.png%22%3B+filename*%3DUTF-8%27%27sample.png&rsct=image%2Fpng&sr=b&sig=6EKa89l6SLnDs1XxR%2Fd2Lc7j07LGWY6UwaFBOfCugfY%3D
filename: sample.pdf
byte_size: 3028
blob_url: http://service.myshyft.devel:4001/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBEdz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--9d9d01b6d69c58f6115489b2dfc343ff646b7fd8/sample.pdf
preview_blob_url: http://service.myshyft.devel:4001/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--e9aa240e9546913e2fbd8d3c557d9e763661b4c1/sample.png
example-1:
summary: create chat message
value:
chat_message:
_parent_object_id: null
id: 12203
message: hello world3
sender_id: 9568
session_id: 3033
message_type: message_default
attachment: null
created_at: '2018-11-03T03:43:48.382Z'
operationId: postApiCustomerUserRoleChatSessionsByChatSessionIdChatMessages
x-operation-id-source: derived
/api/customer/user_role/chat_sessions/{chat_session_id}/chat_messages/{chat_message_id}:
get:
tags:
- Customer > Chats > ChatMessages
summary: get a chat message
description: 'Description
- - -
- Get all visiable chat message with given session ID
- Not showing message before quited
- Still showing archived messages
Params
- - -
Param | Values | R |Description
--- | --- | --- | ---
Headers
- - -
Header | Values | R |Description
--- | --- | --- | ---
Input
- - -
Attribute | Values | R |Description
--- | --- | --- | ---'
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: chat_session_id
in: path
schema:
type: string
required: true
- name: chat_message_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: getApiCustomerUserRoleChatSessionsByChatSessionIdChatMessagesByChatMessageId
x-operation-id-source: derived
/api/customer/user_role/chat_sessions/{chat_session_id}/chat_messages/14830:
delete:
tags:
- Customer > Chats > ChatMessages
summary: delete a chat message
description: 'Description
- - -
- Ceate a chat message with given chat session
- Send a image with format: [IMG]url[/IMG] #TODO: Upgrade it
Params
- - -
Param | Values | R |Description
--- | --- | --- | ---
Headers
- - -
Header | Values | R |Description
--- | --- | --- | ---
Input
- - -
Attribute | Values | R |Description
--- | --- | --- | ---
message | | | |'
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: chat_session_id
in: path
schema:
type: string
required: true
responses:
'204':
description: No Content
headers:
X-Frame-Options:
schema:
type: string
example: SAMEORIGIN
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Download-Options:
schema:
type: string
example: noopen
X-Permitted-Cross-Domain-Policies:
schema:
type: string
example: none
Referrer-Policy:
schema:
type: string
example: strict-origin-when-cross-origin
X-LS-License:
schema:
type: string
example: All Rights Reserved © Coffee Enterprise
X-LS-Application:
schema:
type: string
example: Coffee Mobile
X-Request-Method:
schema:
type: string
example: none
Cache-Control:
schema:
type: string
example: no-cache
Set-Cookie:
schema:
type: string
example: _shyft_api_server_session=UVlWWTRKQzQrYjRVYjBYOXFDbTZXWDlHcGhOY2E0eUhMcmV3Wm91eElHVWZ1OHYxMXZXeTJ5dEVLQ3pXNzZ1dUhaNlN5eVFQaFZyQkNDWU9GU3R5akE9PS0tN3hjcDYwdDc4NFZLZElJbVd4d0d3UT09--0207036d223d818dfd13d4f9c98fa6d08966a42e; path=/; secure; HttpOnly
X-Request-Id:
schema:
type: string
example: d4d5e59c-e08d-4127-9b97-aa81ccca6192
X-Runtime:
schema:
type: number
example: '0.074516'
Vary:
schema:
type: string
example: Origin
Strict-Transport-Security:
schema:
type: string
example: max-age=31536000;
content:
text/plain:
schema:
type: string
example: null
operationId: deleteApiCustomerUserRoleChatSessionsByChatSessionIdChatMessages14830
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
noauthAuth:
type: http
scheme: noauth