Comhtháthú API Meta & Instagram
Tagairt chun aip Instagram a thógáil ar ** Ardán ChatHub SMSBAT**: fíordheimhniú, Comhráite Instagram Direct, tráchtanna ar phoist agus Reels, freagraí Scéalta, cuacha gréasáin agus vótaíocht.
Foinsí
Cumascann an leathanach seo sonraíocht inmheánach Meta Comments API leis an OpenAPI beo
sainmhínithe ag https://chatapi.smsbat.com/swagger/v1/swagger.json agus
https://restapi.smsbat.com/swagger/v1/swagger.json. I gcás nach n-aontaíonn an bheirt, an
Glaoitear difríocht amach inlíne agus liostaítear faoi Ceisteanna oscailte.
1. URLanna bonn
| Cuspóir | URL |
|---|---|
| Chat API + Meta API | https://chatapi.smsbat.com |
| Chomhéadain Swagger / OpenAPI | https://chatapi.smsbat.com/index.html · …/swagger/v1/swagger.json |
| REST API (eagraíochtaí, URLanna aisghlao) | https://restapi.smsbat.com |
| REST API Swagger | https://restapi.smsbat.com/swagger/v1/swagger.json |
| Painéal gréasáin an oibreora | https://chat.smsbat.com |
2. Fíordheimhniú
Braitheann scéim an údaráis ** ar an ngrúpa críochphointe**. Is é an chúis is coitianta le 401 iad a mheascadh.
| Grúpa | Ceanntásc |
|---|---|
chatapi.smsbat.com/api/meta/* (postálacha, tuairimí) | X-Authorization-Key: <organization token> |
chatapi.smsbat.com/api/chat/*, /api/company/*, /api/operator/* | Authorization: Bearer <JWT> |
restapi.smsbat.com/* | X-Authorization-Key · Authorization: Bearer · Bunús |
Eisítear an comhartha eagraíochta do X-Authorization-Key sa phainéal faoi Próifíl.
Tagann JWTanna cuideachta agus oibreora ó /api/company/get-token agus /api/operator/get-token.
Éagothroime
Dearbhaíonn doiciméad chatapi OpenAPI scéim slándála aonair — Bearer — agus cuireann sé i bhfeidhm í
domhanda. Ní dhearbhaítear X-Authorization-Key ann ar chor ar bith, cé go bhfuil an Meta inmheánach
Tuairimí sonraíocht API ainmnithe do /api/meta/*. Is dóichí go láimhseáiltear é ag
earraí lár nach léirítear i Swagger. Deimhnigh go heimpíreach sula seoltar tú.
2.1 Comhartha cuideachta
POST https://chatapi.smsbat.com/api/company/get-token
Content-Type: application/json
{ "login": "company_login", "password": "company_password" }
Filleann 200 OK teaghrán chomhartha lom.
2.2 Eagraíochtaí
GET https://chatapi.smsbat.com/api/company/organization
Authorization: Bearer <company_token>
[ { "id": 24, "name": "My Instagram Store" } ]
2.3 Oibreoirí in eagraíocht
GET https://chatapi.smsbat.com/api/operator?organizationId=24
Authorization: Bearer <company_token>
[
{
"id": 21,
"name": "Jane Doe",
"status": 0,
"organization": { "id": 24, "name": "My Instagram Store" }
}
]
Stádas oibreora: 0 Gníomhach, 1 Neamhghníomhach, 2 Scriosta.
2.4 Cuir leis / sioncrónaigh oibreoirí
POST https://chatapi.smsbat.com/api/operator/synchronize
Authorization: Bearer <company_token>
Content-Type: application/json
[ { "organizationId": 24, "name": "John Operator" } ]
200 OK → [ { "id": 21, "status": 0, "name": "John Operator" } ]
2.5 Oibreoir JWT
POST https://chatapi.smsbat.com/api/operator/get-token
Authorization: Bearer <company_token>
Content-Type: application/json
{ "id": 21, "expiresAt": "2026-12-31T23:59:59.000Z" }
Tugann 200 OK an JWT ar ais mar theaghrán.
2.6 Bailíochtaigh comhartha oibreora
POST https://chatapi.smsbat.com/api/operator/validate-token
Authorization: Bearer <company_token>
Content-Type: application/json
"eyJhbGciOi..."
{
"isValid": true,
"operatorId": 21,
"clientId": 0,
"expiresAt": "2026-12-31T23:59:59.000Z",
"error": null
}
Nuair atá sé neamhbhailí: { "isValid": false, "error": "Invalid token" }.
2.7 Leabaigh an painéal comhrá oibreora
<script type="module" id="operator-chat-panel-script"
src="https://widget.smsbat.com/operator-chat-panel/widget-script.js"
token="YOUR_OPERATOR_JWT_TOKEN"></script>
3. Nasc domhain isteach sa phainéal comhrá
Is féidir le córas seachtrach (CRM, ERP, suíomh Gréasáin) comhrá ar leith a oscailt i
https://chat.smsbat.com/. Tá an t-oibreoir údaraithe ag JWT a ritheadh mar pharaiméadar fiosrúcháin.
https://chat.smsbat.com/?chat_raw_id=<chat_id>&token=<jwt>
https://chat.smsbat.com/?phone=<phone>&token=<jwt>
https://chat.smsbat.com/?from=<bm_id>&phone=<phone>&token=<jwt>
https://chat.smsbat.com/?source=7&from=<bm_id>&phone=<phone>&token=<jwt>
| Paraiméadar | Cur Síos |
|---|---|
chat_raw_id | ID Comhrá |
phone | Uimhir theileafóin i bhformáid idirnáisiúnta |
from | Aitheantóir cuntas branda/gnó (bm_id) |
source | Foinse comhrá — 7 le haghaidh Instagram, féach §8.1 |
token | Oibreoir bailí, neamhchaite JWT le rochtain ar chomhráite |
Cuireann JWT neamhbhailí an cuairteoir i dtír ar scáileán logáil isteach an phainéil oibreora.
4. Instagram Comhráite díreach
4.1 Liostaigh comhráite
GET https://chatapi.smsbat.com/api/chat/chats?source=7&page=1&per_page=20
Authorization: Bearer <token>
Note
Tá leathanach leathanach anseo per_page (cás nathair). Faoi /api/meta/* agus an vótaíocht
críochphointe is é perPage (camelCase). Ní clóscríobh é seo - úsáideann an API an dá cheann.
Paraiméadair iarratais, gach roghnach:
| Paraiméadar | Cineál | Cur Síos |
|---|---|---|
source | ChatSource | Cuireann 7 srian ar thorthaí do Instagram |
entityId | int | Aitheantas cuntais ghnó. Curtha i bhfeidhm mar aon le source |
instagram_user_id | int | Aitheantas úsáideora Instagram i ChatHub |
facebook_user_id | int | Aitheantas úsáideora Facebook i ChatHub |
page / per_page | int | Leathanaigh, réamhshocrú 1 / 20 |
status | ChatStatus[] | Stádas comhrá, in-athdhéanta |
search | string | Cuardach téacs saor (ainm, guthán, …) |
organizationId | int | Aitheantas Eagraíochta |
operatorId | int[] | Scag oibreoirí sannta |
date | string[] | Dhá theorainn: ?date=…&date=… |
isChain | bool | Fill comhráite mar shlabhraí, ag iompar teachtaireachtaí ó chomhráití roimhe seo |
isUnread, starMark, isOperator, isAIAgent | bool | Scagairí breise |
phone, email, contactId, clientId, tagIds, rate, sortedBy | — | Scagairí eile |
Filleann 200 OK GetChatsResponse:
{
"total": 1,
"newMessagesCount": 2,
"items": [
{
"id": 1867,
"theme": null,
"messSource": 7,
"chatStatus": 1,
"countUnread": 2,
"metaUserId": "1585775752382460",
"instaAccount": { "id": 12, "name": "my_instagram_shop", "photo": "https://..." },
"instagramUser": { "id": 123, "name": "marianna_cat", "photo": "https://..." },
"operator": { "id": 21, "name": "Jane", "photo": "https://..." },
"client": { "id": 55, "name": "Marianna", "photo": null },
"textLastMess": "Hello! Is this product available?",
"timeLastMess": "2026-08-13T10:15:00Z",
"authorLastMessage": 1,
"messageStatus": 6,
"isMedia": false,
"phone": null,
"organizationId": 1,
"createdAt": "2026-08-13T10:14:00Z",
"isStarred": false,
"isBlocked": false,
"tags": []
}
]
}
Na réimsí atá tábhachtach d’aip Instagram:
| Réimse | Brí |
|---|---|
instaAccount | An cuntas gnó Instagram (an siopa). Is é id an luach scagaire entityId; name an t-ainm cuntais ó Meta |
instagramUser | An custaiméir. Is é name láimhseáil Instagram, is é id an luach scagaire instagram_user_id |
metaUserId | Aitheantas scóipithe an chustaiméara ar thaobh Meta (teaghrán) |
messSource | 7 le haghaidh Instagram |
phone | De ghnáth null le haghaidh Instagram - ná húsáid mar eochair |
iompraíonn ChatDTO freisin olxUser, promUser, waba, rozetkaUser, facebookAccount,
facebookUser, viberAccount, tgBot, tgUser, viberBot, viberBotUser, widget,
media, isConnectedAI, isPromo, rate, rateComment, closedBy, draft, lang,
starMark, contactId, contactName, block, isInStopList, stopList,
isSmsFallbackEnabled agus taggedMessages.
4.2 Teachtaireachtaí comhrá
GET https://chatapi.smsbat.com/api/chat/chats/1867/messages?isChain=false
Authorization: Bearer <token>
Filleann 200 OK sraith ChatMessageDTO:
[
{
"id": 9928,
"chatId": 1867,
"message": "Hi! Do you have size M in stock?",
"messageTranslation": null,
"phone": null,
"author": 1,
"source": 7,
"media": null,
"replyTo": null,
"status": 6,
"date": "2026-08-13T10:14:00Z",
"operator": null,
"client": { "id": 123, "name": "marianna_cat", "photo": "https://..." },
"messageType": 0,
"isInternal": false,
"isBroadcast": false,
"starMark": false,
"referralGuid": null,
"postId": null,
"isConnectedAI": false,
"organizationId": 1,
"countUnreadMessages": 0
}
]
Tá postId daonra nuair a bhaineann an teachtaireacht le postáil Instagram nó Scéal - cuir ar aghaidh é
díreach ar ais mar id / postId chuig an Meta API. Is media é ChatMediaDTO:
{ name, format, type, uri, raw, length, isUploaded }.
4.3 Seol teachtaireacht (JSON)
POST https://chatapi.smsbat.com/api/chat/1867/message
Authorization: Bearer <token>
Content-Type: application/json
Corp - SendChatMessageDTO:
{
"textMessage": "Hello! Yes, size M is available.",
"author": 0,
"isInternal": false,
"replyToMessageId": 9928,
"appGuid": "550e8400-e29b-41d4-a716-446655440000",
"media": {
"name": "item.jpg",
"format": "image/jpeg",
"dataBase64": "/9j/4AAQSkZJRg...",
"type": 1
}
}
| Réimse | Cineál | Cur Síos |
|---|---|---|
textMessage | string? | Téacs teachtaireachta. D’fhéadfadh sé a bheith folamh nuair atá media i láthair |
author | AuthorMessage? | oibreoir 0, cliant 1 |
isInternal | bool? | Marcálann true nóta inmheánach nach seachadtar chuig an gcustaiméir |
replyToMessageId | int? | Aitheantas na teachtaireachta atá á freagairt |
appGuid | uuid? | TREOIR Atreoraithe |
media | MediaDTO? | { name, format, dataBase64, thumbnail, duration, type } |
200 OK → { "id": 9930, "messageStatus": 0 }
Is féidir GUID atreoraithe a chur ar aghaidh freisin sa chonair:
POST /api/chat/{chatId}/{referralGuid}/message (mar an gcéanna …/message/v1, …/message/v2).
4.4 Seol comhad nó físeán (ilpháirteach, v2)
POST https://chatapi.smsbat.com/api/chat/1867/message/v2
Authorization: Bearer <token>
Content-Type: multipart/form-data
Is iad PascalCase le nodaireacht poncanna iad ainmneacha réimse foirmeacha
textMessage agus media.file ní thugtar aird orthu go ciúin. Bain úsáid as na hainmneacha cruinne thíos.
| Réimse foirm | Cineál | Cur Síos |
|---|---|---|
TextMessage | string | Téacs na teachtaireachta |
Author | int | oibreoir 0, cliant 1 |
IsInternal | bool | Nóta inmheánach |
ReplyToMessageId | int | Teachtaireacht á freagairt |
AppGuid | uuid | TREOIR Atreoraithe |
Media.File | binary | An comhad féin |
Media.Name | string | Ainm comhaid |
Media.Format | string | Cineál MIME (video/mp4, image/png, application/pdf) |
Media.Type | MediaType | Féach §8.5 |
Media.DataBase64 | string | Rogha eile seachas Media.File |
Media.Thumbnail | string | Fráma réamhamharc físe Base64 |
Media.Duration | double | Fad físeáin i soicindí |
curl -X POST "https://chatapi.smsbat.com/api/chat/1867/message/v2" \
-H "Authorization: Bearer <token>" \
-F "TextMessage=Here is the price list" \
-F "Author=0" \
-F "Media.Type=2" \
-F "Media.File=@./price.pdf"
200 OK → { "id": 9931, "messageStatus": 0 }
4.5 Athraigh an stádas comhrá
PUT https://chatapi.smsbat.com/api/chat/status
Authorization: Bearer <token>
Content-Type: application/json
{ "id": 1867, "status": 4 }
200 OK macalla an réad nuashonraithe.
4.6 Nuashonraigh stádais na dteachtaireachtaí
PUT https://chatapi.smsbat.com/api/chat/messages/status
Authorization: Bearer <token>
Content-Type: application/json
{ "status": 3, "messageIds": [9928, 9929] }
4.7 Scrios comhrá
DELETE https://chatapi.smsbat.com/api/chat/chats/1867
Authorization: Bearer <token>
5. Poist, Ríl agus Scéalta
Bunchonair: https://chatapi.smsbat.com/api/meta
Údar: X-Authorization-Key: <organization token>
5.1 Liostaigh postálacha, Reels agus Scéalta
GET https://chatapi.smsbat.com/api/meta/posts?platform=instagram&mediaType=story&page=1&perPage=20
X-Authorization-Key: <token>
| Paraiméadar | Cineál | Ag Teastáil | Cur Síos |
|---|---|---|---|
page | int | níl | Leathanach, réamhshocraithe 1 |
perPage | int | níl | Míreanna in aghaidh an leathanaigh, réamhshocraithe 20 |
id | int | níl | Scag le haitheantas poist inmheánach |
platform | string | níl | instagram nó facebook |
mediaType | string | níl | post, reel nó story. Gach cineál nuair a fágtar ar lár é |
# Every post
curl -H "X-Authorization-Key: <token>" \
"https://chatapi.smsbat.com/api/meta/posts?page=1&perPage=10"
# Instagram only
curl -H "X-Authorization-Key: <token>" \
"https://chatapi.smsbat.com/api/meta/posts?platform=instagram"
# A single post by ID
curl -H "X-Authorization-Key: <token>" \
"https://chatapi.smsbat.com/api/meta/posts?id=42"
# Instagram Stories only
curl -H "X-Authorization-Key: <token>" \
"https://chatapi.smsbat.com/api/meta/posts?platform=instagram&mediaType=story"
200 OK:
{
"total": 42,
"items": [
{
"id": 42,
"metaId": "18113450675314072",
"text": "Check out our new collection!",
"imageUrl": "https://dashboard.smsbat.com/api/meta/post/media/7d124c36-1711-4aa8-b21d-f6dbf8f347ef",
"platform": "instagram",
"mediaType": "story",
"createdAt": "2026-07-22T09:35:30Z",
"story": {
"id": 42,
"metaId": "18113450675314072",
"url": "https://dashboard.smsbat.com/api/meta/post/media/7d124c36-1711-4aa8-b21d-f6dbf8f347ef"
}
}
]
}
Eagartacht - ainm réimse an chuntair
Sainmhíníonn scéimre Swagger MetaCommentPostListItemDtoPaginationDTO total. Tá an
doiciméid sonraíochta inmheánacha totalCount. Gintear Swagger ón gcód, mar sin
Is é total an fhírinne is dóichí. Parsáil total ?? totalCount go dtí go mbeidh sé seo socraithe.
| Réimse | Cur Síos |
|---|---|
id | Aitheantas an phoist inmheánaigh |
metaId | Post seachtrach / Reel / Story ID in Meta |
text | Fotheideal |
imageUrl | URL seachfhreastalaí arna n-eochrú ag an MetaPost.Guid neamhsheicheamhach, nó null |
platform | facebook nó instagram |
mediaType | post, reel nó story |
createdAt | Dáta cruthaithe (dáta an ardáin, nó dáta an bhunachair shonraí) |
story | I láthair ** amháin** le haghaidh mediaType: "story" |
story.id | ID Scéal Inmheánach; comhionann le post.id |
story.metaId | Aitheantas an scéil sheachtraigh i Meta |
story.url | URL seachfhreastalaí cobhsaí de na meáin Scéal stóráilte; null mura bhféadfaí na meáin a shábháil |
Déantar freastal ar na meáin phoist ar dhá bhealach: GET /api/meta/post/media/{id:int} le haghaidh siar
comhoiriúnacht agus GET /api/meta/post/media/{guid:guid}. Freagraí API nua agus aisghlaonna
giniúint an fhoirm GUID i gcónaí.
5.2 Liostaigh tráchtanna
GET https://chatapi.smsbat.com/api/meta/comments?platform=instagram&postId=42&page=1&perPage=20
X-Authorization-Key: <token>
| Paraiméadar | Cineál | Ag Teastáil | Cur Síos |
|---|---|---|---|
page | int | níl | Leathanach, réamhshocraithe 1 |
perPage | int | níl | Míreanna in aghaidh an leathanaigh, réamhshocraithe 20 |
postId | int | níl | Scag le haitheantas poist |
parentCommentId | int | níl | Tráchtanna linbh (freagraí) ar nóta tugtha |
platform | string | níl | facebook nó instagram |
200 OK:
{
"total": 100,
"items": [
{
"id": 5,
"metaId": "179000000000005",
"text": "What is the price?",
"createdAt": "2026-04-15T10:30:00Z",
"platform": "instagram",
"replyStatus": null,
"author": {
"type": "meta_user",
"name": "John Doe",
"metaUserId": "1585775752382460"
},
"post": {
"id": 1,
"metaId": "18113450675314072",
"text": null,
"imageUrl": "https://dashboard.smsbat.com/api/meta/post/media/7d124c36-…",
"createdAt": "2026-07-22T09:35:30Z",
"mediaType": "story",
"story": {
"id": 1,
"metaId": "18113450675314072",
"url": "https://dashboard.smsbat.com/api/meta/post/media/7d124c36-…"
}
},
"mediaUrl": "https://chatapi.smsbat.com/api/meta/comment/media/5",
"replyTo": {
"id": 3,
"metaId": "179000000000003",
"text": "Parent comment..."
}
}
]
}
| Réimse | Cur Síos |
|---|---|
id | Aitheantas tráchta inmheánach |
metaId | Aitheantas seachtrach i Meta. null le haghaidh freagra atá ar feitheamh uainn go dtí go seolfar é |
text | Téacs tráchta |
createdAt | Dáta cruthaithe |
platform | facebook nó instagram |
replyStatus | null le haghaidh nóta tráchta úsáideora isteach; "pending" / "sent" / "failure" dár bhfreagra |
author.type | "meta_user" úsáideoir seachtrach, "owner" úinéir an leathanaigh |
author.name | Ainm an údair |
author.metaUserId | Aitheantas úsáideora scóipe i Meta; null le haghaidh "owner" |
post | The post, Reel or Story belongs to |
post.mediaType | post, reel nó story |
post.story | Tagairt scéil { id, metaId, url }, Scéalta amháin |
mediaUrl | Meáin atá ceangailte leis an nóta tráchta, nó null |
replyTo | Trácht tuismitheora { id, metaId, text }; null ag an mbarrleibhéal |
Éagothroime — cineál `author.type`
Déanann an tsonraíocht inmheánach na teaghráin "meta_user" / "owner" a dhoiciméadú. Cineálacha swagger
MetaCommentAuthorType mar ** slánuimhir** le enum [0, 1]. A JsonStringEnumConverter
mhíneodh sé an bhearna, ach níl sé sin deimhnithe i gcoinne freagra fíor. Scríobh a
parsálaí a ghlacann an dá.
5.3 Freagair nóta tráchta
Scoir freagra le seachadadh.
curl -X POST \
-H "X-Authorization-Key: <token>" \
-H "Content-Type: application/json" \
-d '{"text": "Thanks for the feedback!"}' \
"https://chatapi.smsbat.com/api/meta/comments/5/reply"
Comhlacht iarratais: { "text": "Reply text" }
Seolann 202 Accepted an réad nóta tráchta — cruth céanna le GET /api/meta/comments — le
replyStatus: "pending" agus metaId: null. Tagann an toradh seachadta níos déanaí mar a
source: 13 aisghlao (§6.4).
Éagothroime - cód freagartha
Dearbhaíonn Swagger 200 gan aon chorp; dearbhaíonn an tsonraíocht inmheánach 202 Accepted
leis an trácht mar an comhlacht. Is dócha nach bhfuil ProducesResponseType ag an rialaitheoir
tréith, rud a fhágann Swagger ar a réamhshocrú. Glac le haon 2xx agus ná bí ag brath ar chorp.
6. Dubhóga
Seolann SMSBAT POST iarratais le application/json chuig do URL agus táthar ag súil le HTTP 200 ar ais.
Réimsí neamhnithe ar lár ina n-iomláine
Ní chuirtear réimse arb é a luach null sraitheach isteach sa chorp aisghlao ar chor ar bith. Le haghaidh a
teachtaireacht nár tháinig ó Facebook nó Instagram níl ann ach eochair MetaUserId.
Déan “as láthair” agus null a chóireáil mar an rud céanna.
6.1 Cláraigh URL aisghlao
curl -X POST 'https://restapi.smsbat.com/organizations/callback_urls' \
-H 'X-Authorization-Key: <token>' \
-H 'Content-Type: application/json' \
-d '{
"url": "https://your-server.com/webhook",
"source": 12,
"headerName": "X-Webhook-Secret",
"headerValue": "your-secret",
"channelType": 7,
"channelEntityId": 12
}'
| Réimse | Cineál | Cur Síos |
|---|---|---|
url | string | Do chríochphointe |
source | SendingSourceCallback | Cineál imeachta, féach §8.2 |
headerName / headerValue | string | Ceanntásc údaráis treallach a cheanglaímid leis an iarratas (roghnach) |
channelType | ChatSource | Cainéal. 7 le haghaidh Instagram. Roghnach |
channelEntityId | int | Cuntas gnó ar leith. Éilíonn channelType |
Sin channelType faigheann an URL imeachtaí ó gach cainéal.
Tip
Teastaíonn clúdach iomlán na dtuairimí ** dhá chlárú**: source: 12 le haghaidh tuairimí nua agus
source: 13 le haghaidh stádas freagartha. Le haghaidh freagraí Díreacha agus Scéalta cuir source: 3
(agus 11 más mian leat gach teachtaireacht comhrá).
Oibríochtaí fágtha:
GET https://restapi.smsbat.com/organizations/callback_urls?source=12
GET https://restapi.smsbat.com/organizations/callback_urls/{id}
PUT https://restapi.smsbat.com/organizations/callback_urls/{id}
DELETE https://restapi.smsbat.com/organizations/callback_urls/{id}
Filleann GET:
[
{
"id": 101,
"url": "https://your-server.com/webhook",
"source": 12,
"headerName": "X-Webhook-Secret",
"headerValue": "your-secret",
"createdAt": "2026-08-13T09:00:00Z",
"channelType": 7,
"channelEntityId": 12
}
]
6.2 Teachtaireacht nua agus freagra Scéal Instagram (source: 3, 11)
Tagann freagra úsáideora ar Instagram Story mar ghnáth-theachtaireacht sna aisghlaonna seo,
le bloc breise barrleibhéil Story:
{
"ChatId": 123,
"MessageId": 456,
"MessageText": "😍",
"Username": "Jane Smith",
"UserId": 789,
"MetaUserId": "1585775752382460",
"ShopId": 12,
"ShopName": "instagram shop name",
"Author": 0,
"type_messenger": 7,
"Story": {
"Id": 42,
"MetaId": "18113450675314072",
"Url": "https://dashboard.smsbat.com/api/meta/post/media/7d124c36-1711-4aa8-b21d-f6dbf8f347ef"
}
}
| Réimse | Cur Síos |
|---|---|
ChatId / MessageId | Aitheantóirí comhrá agus teachtaireachtaí |
Author | 0 úsáideoir, 1 oibreoir |
Username | Ainm nó láimhseáil taispeána Instagram / Facebook |
UserId | Aitheantas úsáideora uimhriúil inmheánach i SMSBAT |
MetaUserId | Aitheantas scóipe an chomhpháirtí comhrá i Meta. Ar theachtaireacht oibreoir amach aithníonn sé seo fós úsáideoir Meta an chomhrá, ní an t-oibreoir |
ShopId | Aitheantas inmheánach an chuntais ghnó Instagram / Facebook |
ShopName | Ainm an chuntais ghnó mar a fuarthas ó Meta ag am nasctha |
MessageText | Téacs na teachtaireachta |
MessageMedia | URL meán nuair is meán an teachtaireacht |
type_messenger | Foinse, 7 le haghaidh Instagram |
operator_name | Ainm oibreora nuair Author = 1 |
Story | I láthair ** amháin** ar fhreagra Scéal isteach |
Story.Id | ID Scéal Inmheánach (MetaPost) — inúsáidte go díreach mar id / postId san API Meta |
Story.MetaId | Aitheantas an scéil sheachtraigh i Meta |
Story.Url | URL seachfhreastalaí cobhsaí de na meáin Story stóráilte. In easnamh nuair nach bhféadfaí na meáin a shábháil — tá an bloc Story agus an teachtaireacht fós seachadta |
Tá `Author` inbhéartaithe i gcoibhneas leis an Chat API
In ChatMessageDTO.author, ciallaíonn 0 oibreoir agus ciallaíonn 1 cliant. Sa aisghlaoch seo tá
an bealach eile bhabhta: Is é 0 an t-úsáideoir, is é 1 an t-oibreoir. Ná roinn an mhapáil.
6.3 Nóta tráchta nua (source: 12)
Tineann sé nuair a thráchtann úsáideoir Meta ar phost Facebook nó ar phost Instagram / Ríl.
Note
Instagram Ní sheachadtar freagraí scéalta trí source: 12. Sroicheann siad mar is gnách
teachtaireachtaí isteach ar source: 3 agus/nó 11 le bloc Story — féach §6.2.
{
"type": "new_comment",
"platform": "instagram",
"comment": {
"id": 10,
"metaId": "179000000000010",
"parentCommentId": 5,
"parentMetaId": "179000000000005",
"parentCommentText": "The user's previous comment",
"text": "Great product!",
"createdAt": "2026-04-16T12:00:00Z",
"author": {
"type": "meta_user",
"name": "Jane Smith",
"metaUserId": "1585775752382460"
}
},
"post": {
"id": 1,
"metaId": "123456789012345",
"text": "Post description...",
"imageUrl": "https://dashboard.smsbat.com/api/meta/post/media/7d124c36-…",
"createdAt": "2026-04-10T12:00:00Z",
"mediaType": "post"
}
}
6.4 Stádas freagartha nóta tráchta (source: 13)
Tinte tar éis dúinn iarracht a dhéanamh freagra a thabhairt, cibé an n-éiríonn leis nó má theipeann air.
{
"type": "comment_status",
"platform": "instagram",
"comment": {
"id": 15,
"metaId": "179000000000015",
"parentCommentId": 10,
"parentMetaId": "179000000000010",
"parentCommentText": "Great product!",
"text": "Thanks for the feedback!",
"createdAt": "2026-04-16T12:05:00Z",
"updatedAt": "2026-04-16T12:05:03Z",
"replyStatus": "sent",
"author": {
"type": "owner",
"name": "Support Agent"
}
},
"post": {
"id": 1,
"metaId": "179999999999999",
"text": "Reel description...",
"imageUrl": "https://dashboard.smsbat.com/api/meta/post/media/7d124c36-…",
"createdAt": "2026-07-22T09:35:30Z",
"mediaType": "reel"
}
}
6.5 Réimsí glaoite tráchta comhroinnte
Roinneann an dá ghlaoch tráchta cruth coirp amháin agus ní hionann iad ach faoi type.
| Réimse | Cur Síos |
|---|---|
type | "new_comment" nó "comment_status" |
platform | "facebook" nó "instagram" |
comment.id | Aitheantas tráchta inmheánach |
comment.metaId | Aitheantas seachtrach i Meta; null le haghaidh freagra ar feitheamh sula seolfar é |
comment.parentCommentId | Aitheantas tráchta tuismitheora. In easnamh le haghaidh nóta barrleibhéil |
comment.parentMetaId | Aitheantas tráchta tuismitheora sheachtraigh. As láthair ag an ardleibhéal |
comment.parentCommentText | Téacs tuairimí tuismitheora. As láthair ag an ardleibhéal |
comment.text | Téacs tráchta |
comment.createdAt | Dáta cruthaithe |
comment.updatedAt | Nuashonrú is déanaí. As láthair murar cuireadh an nóta tráchta in eagar |
comment.replyStatus | "pending" / "sent" / "failure". ** As láthair** le haghaidh nóta tráchta úsáideora isteach |
comment.author.type | "meta_user" nó "owner" |
comment.author.name | Ainm an údair |
comment.author.metaUserId | Aitheantas an údair scóipe i Meta. As láthair le haghaidh "owner" |
comment.mediaUrl | Meáin trácht. As láthair nuair nach bhfuil aon cheann |
post.id | Aitheantas an phoist inmheánaigh |
post.metaId | Post seachtrach / Reel / Story ID in Meta |
post.text | Téacs postála |
post.imageUrl | Post URL íomhá, nó null |
post.createdAt | Dáta iarchruthaithe |
post.mediaType | I nglaoch siar tráchta, ní raibh ach post nó reel |
6.6 Comhrá nua (source: 7)
{ "ChatId": 12345, "Phone": "+380501234567", "chat.Source": 7 }
6.7 Athruithe ar stádas na teachtaireachta agus an chomhrá (source: 6 / 5)
{ "name": "changed_message_status", "id": 9928, "status": 6 }
{ "name": "changed_chat_status", "id": 1867, "status": 4 }
6.8 Cuireadh an teachtaireacht in eagar nó scriosta (source: 9)
{ "messageId": 9930, "text": "Updated message text" }
{ "messageId": 9931, "delete": true }
6.9 Táscaire clóscríofa (source: 8)
{ "chat_id": 1867, "event": "start_typing", "operator_name": "Iryna" }
{ "chat_id": 1867, "event": "end_typing" }
7. Vótaíocht imeachtaí
I gcás timpeallachtaí nach féidir glacadh le HTTP isteach.
7.1 Faigh imeachtaí
GET https://chatapi.smsbat.com/api/chat/callback-events?page=1&perPage=20
Authorization: Bearer <token>
| Paraiméadar | Cur Síos |
|---|---|
organizationId | Roghnach. Tógtha as an comhartha nuair a fágadh ar lár |
page / perPage | Leathanaigh, mainneachtainí 1 / 20 |
{
"page": 1,
"perPage": 20,
"total": 947,
"items": [
{
"ChatId": 1867,
"MessageId": 9928,
"MessageText": "Hello there!",
"MessageMedia": null,
"Phone": null,
"Username": "marianna_cat",
"UserId": 123,
"ShopId": 12,
"ShopName": "instagram shop name",
"Author": 1,
"type_messenger": 7,
"message_date": "2026-08-13T12:27:39.724Z",
"timestamp": "2026-08-13T12:27:39.736Z",
"event_guid": "ff60129e-c6e4-4876-9d90-badb430c0606",
"organization_id": 1,
"callback_type": "3"
}
]
}
Iompraíonn gach imeacht event_guid, timestamp, organization_id agus callback_type — a
teaghrán a mheaitseálann na luachanna source in §8.2. Meaitseálann na réimsí atá fágtha leis an gcomhfhreagras
gréasán in §6.
7.2 Tabhair aitheantas d’imeachtaí próiseáilte
POST https://chatapi.smsbat.com/api/chat/callback-events/processed
Authorization: Bearer <token>
Content-Type: application/json
[ "ff60129e-c6e4-4876-9d90-badb430c0606" ]
200 OK → { "deleted": 1 }
Ní áirítear imeachtaí a baineadh cheana féin i dtreo deleted. Is leatsa ordú agus trialacha
freagracht taobh.
7.3 Lúb molta
- Pobalbhreith
GET /api/chat/callback-eventsar sceideal. - Próiseáil na himeachtaí i do sheirbhís.
- Seol an liosta
event_guidpróiseáilte chuig/callback-events/processed. - Déan arís.
8. Tagairt Enum
8.1 ChatSource — cainéal (0–9)
| Cód | Cainéal |
|---|---|
| 0 | Viber |
| 1 | ViberBot |
| 2 | TelegramBot |
| 3 | |
| 4 | Giuirléid |
| 5 | Rozetka |
| 6 | |
| 7 | |
| 8 | Prom |
| 9 | Olx |
8.2 SendingSourceCallback — cineál teagmhais aisghlao (0–13)
| Cód | Imeacht |
|---|---|
| 3 | Chat — teachtaireacht chomhrá nua, lena n-áirítear freagraí Scéalta |
| 5 | Stádas comhrá athraithe |
| 6 | Athraíodh stádas na teachtaireachta |
| 7 | Comhrá nua cruthaithe |
| 8 | Táscaire clóscríofa |
| 9 | Nuashonraíodh nó scriostar an teachtaireacht |
| 11 | AnyChatMessage — aon teachtaireacht chomhrá |
| 12 | MetaNewComment — trácht nua Instagram / Facebook |
| 13 | MetaCommentStatus — stádas seachadta ár bhfreagra tráchta |
Cuimsíonn an enum 0–13; níl na luachanna atá fágtha ag teastáil le haghaidh comhtháthú Instagram.
8.3 ChatStatus (0–4)
0 Nua, 1 Oscailte, 2 Ag Feitheamh, 3 OnPause, 4 Dúnta
8.4 MessageStatus (0–11)
| Cód | Ainm |
|---|---|
| 0 | NUA |
| 1 | RATHA |
| 2 | Diúltaíodh |
| 3 | LÉIGH |
| 4 | AN AIRE |
| 5 | Próiseáil |
| 6 | SEACHADTA |
| 7 | BLOCKED_BY_USER |
| 8 | USER_NOT_FOUND |
Cuimsíonn an enum 0–11. Tá luachanna 9, 10 agus 11 san API ach níl siad doiciméadaithe fós —
caitheamh leo mar UNKNOWN.
8.5 MediaType (1–10)
1 Grianghraf, 2 Comhad, 3 Fuaim, 4 Físeán, 5 Greamán, 6 Greamán Beoite,
7 StickerVideo, 8 Beochan, 9 Guth, 10 Nóta Físe
8.6 AuthorMessage — údar san API Chat (0–4)
0 Oibreoir, 1 Cliant, 2 Bot, 3 ViberAccount
Cuimsíonn an enum 0–4; tá luach 4 gan doiciméadú. Úsáideann na aisghlaonna “teachtaireachta nua” an
mapáil os coinne — féach §6.2.
8.7 ChatMessageType (0–2)
0 Téacs, 1 Grianghraf, 2 Comhad
8.8 Nóta tráchta replyStatus
null nóta tráchta úsáideora isteach, "pending" tá ár bhfreagra scuaine, "sent" seachadta,
"failure" theip ar an seachadadh.
Ceisteanna oscailte
Trí phointe nach n-aontaíonn an tsonraíocht inmheánach agus an Swagger cód-ghinte. Aon socraíonn iarratas le comhartha fíor iad go léir; go dtí sin, scríobh an cliant go cosantach.
| # | Ceist | Sonraíocht | Fáinleog | Conas a sheiceáil |
|---|---|---|---|---|
| 1 | Ceanntásc údaraithe le haghaidh /api/meta/* | X-Authorization-Key | amháin Bearer dearbhaithe | curl -i -H "X-Authorization-Key: <token>" ".../api/meta/posts?perPage=1" — bí ag súil le 200, ní 401 |
| 2 | Réimse cuntair i bhfreagraí Meta | totalCount | total | Iarratas céanna - léigh an eochair fhréamh JSON |
| 3 | cineál author.type agus cód stádais reply | "meta_user" / "owner", 202 le corp | int [0,1], 200 gan corp | curl -i .../api/meta/comments?perPage=1 móide freagra tástála |
Treoir eatramhach:
- cuntar — léigh
total ?? totalCount; author.type— glac le téad agus le slánuimhir araon (0↔meta_user,1↔owner, mapáil le deimhniú);reply— bain úsáid as aon2xxmar rath, ní gá aon chomhlacht, tóg an stádas deiridh ón aisghlaosource: 13.
Nótaí forfheidhmithe
- Tá difríocht idir an t-údar in aghaidh an ghrúpa críochphointe — úsáideann
/api/meta/*X-Authorization-Key, comhráite agus úsáideann oibreoiríBearer, glacannrestapiceachtar. - Déantar an leathanach a litriú ar dhá bhealach —
per_pagear/api/chat/chats,perPagear/api/meta/*agus/api/chat/callback-events. multipart/form-datais iad na réimsí PascalCase le nodaireacht poncanna (Media.File,Media.Type).- Tá réimsí neamhnithe fágtha ar lár ó aisghlaonna — ciallaíonn eochair as láthair
null. phoneis gnáchnullar Instagram. Sainaithin an custaiméir faoiinstagramUser.id/metaUserIdagus an siopa faoiinstaAccount.id(luach an scagaireentityId).- Is féidir
Story.Idó aisghlao a chur ar ais díreach marid/postIdchuig an Meta API. - Seiceáil
expiresAtJWT an oibreora sula n-úsáideann tú é i nasc domhain nó sa ghiuirléid.