Баримт бичиг / API лавлах
Зурвас
Хөтөлбөр ба түншүүдийн хоорондох зурвас.
GET/v1/workspaces/{workspaceId}/message-attachments/{fileId}
Download a scanned attachment of a message of this workspace.
Шаардлагатай API түлхүүрийн хамрах хүрээ: messages.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
fileId | path | string | тийм | |
Хариу: 200
GET/v1/workspaces/{workspaceId}/message-threads
The inbox: threads by last activity (R10, R16).
Шаардлагатай API түлхүүрийн хамрах хүрээ: messages.read
Параметр (5)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
unread | query | boolean | | Only threads with unread messages. |
search | query | string | | Partner name or email. |
page | query | integer (int32) | | |
pageSize | query | integer (int32) | | |
Хариу: 200 ThreadDto[]
PATCH/v1/workspaces/{workspaceId}/message-threads/{partnerId}
Block or mute a thread (R50).
Шаардлагатай API түлхүүрийн хамрах хүрээ: messages.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
partnerId | path | string | тийм | |
Хүсэлтийн бие (PatchThread)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
blocked | boolean | | Block the partner from writing (R50); does not ban the partner. |
mutedUntil | string (date-time) | | Mute notification email for members until then; null unmutes. |
Хариу: 200 ThreadDto
POST/v1/workspaces/{workspaceId}/message-threads/{partnerId}/read
Mark the partner's messages read for the whole program (R12).
Шаардлагатай API түлхүүрийн хамрах хүрээ: messages.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
partnerId | path | string | тийм | |
Хүсэлтийн бие (ReadBody)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
uptoMessageId | string | | |
Хариу: 200 ReadResult
GET/v1/workspaces/{workspaceId}/messages
Messages, newest first (R10). startingAfter pages to older messages.
Шаардлагатай API түлхүүрийн хамрах хүрээ: messages.read
Параметр (8)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
partnerId | query | string | | |
tenantId | query | string | | The partner id in the merchant's system; `partnerId` wins when both are sent. |
sourceType | query | string | | `partner` or `program`. |
unread | query | boolean | | True is unread, false is read; without `sourceType` it implies partner-sent messages. |
pageSize | query | integer (int32) | | |
startingAfter | query | string | | |
endingBefore | query | string | | |
Хариу: 200 MessageDto[]
POST/v1/workspaces/{workspaceId}/messages
Send a message as the program (R9, R14, R22). Attachments are dashboard-only in v1.
Шаардлагатай API түлхүүрийн хамрах хүрээ: messages.write
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (SendMessage)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
text | string | тийм | 1 to 2,000 characters. |
partnerId | string | | |
tenantId | string | | |
attachmentIds | string[] | | Dashboard only: ids from `uploadMessageAttachment` (at most 5). |
Хариу: 201 MessageDto