Zalo — Group chats
Create group — zalo.create_group
Create a GMF group chat with the OA and 1 to 99 members.
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| WRITE | medium | yes | no | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
group_name | string | yes | Group name. |
group_description | string | no | Group description. |
asset_id | string | yes | GMF quota asset_id from check_group_quota. |
member_user_ids | array of string | yes | Zalo user IDs, 1 to 99. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |
Get group — zalo.get_group
Get one group's info.
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| NONE | low | no | yes | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | GMF group ID. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |
List groups — zalo.list_groups
List the OA's groups.
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| NONE | low | no | yes | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
offset | integer | yes | Min 0. |
count | integer | yes | Min 1. Max 50. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |
Update group — zalo.update_group
Change a group's name or description.
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| WRITE | medium | yes | no | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | GMF group ID. |
group_name | string | no | Group name. |
group_description | string | no | Group description. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |
Update group asset — zalo.update_group_asset
Move a group to another GMF quota asset.
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| WRITE | medium | yes | no | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | GMF group ID. |
asset_id | string | yes | GMF quota asset_id from check_group_quota. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |
Invite group members — zalo.invite_group_members
Invite users to a group.
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| WRITE | medium | yes | no | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | GMF group ID. |
member_user_ids | array of string | yes | Zalo user IDs, 1 to 99. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |
List group members — zalo.list_group_members
List a group's members.
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| NONE | low | no | yes | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | GMF group ID. |
offset | integer | yes | Min 0. |
count | integer | yes | Min 1. Max 50. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |
List pending group invites — zalo.list_group_pending
List users waiting to join a group.
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| NONE | low | no | yes | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | GMF group ID. |
offset | integer | yes | Min 0. |
count | integer | yes | Min 1. Max 50. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |
Accept pending members — zalo.accept_group_pending
Accept users waiting to join a group.
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| WRITE | medium | yes | no | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | GMF group ID. |
member_user_ids | array of string | yes | Zalo user IDs, 1 to 99. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |
Reject pending members — zalo.reject_group_pending
Reject users waiting to join a group.
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| WRITE | medium | yes | no | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | GMF group ID. |
member_user_ids | array of string | yes | Zalo user IDs, 1 to 99. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |
Remove group members — zalo.remove_group_members
Remove members from a group.
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| WRITE | high | yes | no | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | GMF group ID. |
member_user_ids | array of string | yes | Zalo user IDs, 1 to 99. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |
Add group admins — zalo.add_group_admins
Make members deputy admins of a group.
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| WRITE | medium | yes | no | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | GMF group ID. |
member_user_ids | array of string | yes | Zalo user IDs, 1 to 99. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |
Remove group admins — zalo.remove_group_admins
Remove deputy admins from a group.
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| WRITE | medium | yes | no | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | GMF group ID. |
member_user_ids | array of string | yes | Zalo user IDs, 1 to 99. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |
Delete group — zalo.delete_group
Delete a group.
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| WRITE | high | yes | no | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | GMF group ID. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |
Get group conversation — zalo.get_group_conversation
Get a group's message history.
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| NONE | low | no | yes | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | GMF group ID. |
offset | integer | yes | Min 0. |
count | integer | yes | Min 1. Max 50. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |
List recent group chats — zalo.list_group_recent_chats
List groups with the most recent messages.
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| NONE | low | no | yes | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
offset | integer | yes | Min 0. |
count | integer | yes | Min 1. Max 50. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |
Send group message — zalo.send_group_message
Send a message to a group. message is Zalo's message object: {"text": "..."} (mention with [@user_id]) or an attachment (image, sticker, file).
| Side effect | Risk | Needs approval | Idempotent | Scopes |
|---|---|---|---|---|
| WRITE | medium | yes | no | — |
Input
| Field | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | GMF group ID. |
message | object | yes | Zalo group message object. |
Extra fields: ignored.
Output
| Field | Type | Description |
|---|---|---|
data | object | Zalo response data. |