Skip to content

Commit

Permalink
modify chat doc
Browse files Browse the repository at this point in the history
  • Loading branch information
haoxiuwen committed Aug 9, 2024
1 parent 808830f commit 8eab255
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ The following table shows the restrictions of this feature:
| Feature Restriction| Default | Description |
| :--------- | :----- | :------- |
| Enabling the function | Disabled | To use this feature, contact [email protected] to enable it. |
| Permission | Group owner and administrators | By default, only the group owner and administrators can request read receipts when sending a message. <br/>You can contact [[email protected]](mailto:[email protected]) to grant the permission to regular group members.|
| Number of days before read receipts cannot be returned after the message is sent | 3 days | The server no longer records the group members that read the message three days after it is sent, nor sends the read receipts. |
| Chat group size | 500 members | This feature is available only to groups with up to 500 members. In other words, each message in a group can have up to 500 read receipts. If the upper limit is exceeded, the latest read receipt record will overwrite the earliest one. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ The following table shows the restrictions of this feature:
| Feature Restriction| Default | Description |
| :--------- | :----- | :------- |
| Enabling the function | Disabled | To use this feature, contact [email protected] to enable it. |
| Permission | Group owner and administrators | By default, only the group owner and administrators can request read receipts when sending a message. <br/>You can contact [[email protected]](mailto:[email protected]) to grant the permission to regular group members.|
| Number of days before read receipts cannot be returned after the message is sent | 3 days | The server no longer records the group members that read the message three days after it is sent, nor sends the read receipts. |
| Chat group size | 500 members | This feature is available only to groups with up to 500 members. In other words, each message in a group can have up to 500 read receipts. If the upper limit is exceeded, the latest read receipt record will overwrite the earliest one. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ The following table shows the restrictions of this feature:
| Feature Restriction| Default | Description |
| :--------- | :----- | :------- |
| Enabling the function | Disabled | To use this feature, contact [email protected] to enable it. |
| Permission | Group owner and administrators | By default, only the group owner and administrators can request read receipts when sending a message. <br/>You can contact [[email protected]](mailto:[email protected]) to grant the permission to regular group members.|
| Number of days before read receipts cannot be returned after the message is sent | 3 days | The server no longer records the group members that read the message three days after it is sent, nor sends the read receipts. |
| Chat group size | 500 members | This feature is available only to groups with up to 500 members. In other words, each message in a group can have up to 500 read receipts. If the upper limit is exceeded, the latest read receipt record will overwrite the earliest one. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,7 @@ The following table shows the restrictions of this feature:

| Feature Restriction| Default | Description |
| :--------- | :----- | :------- |
| Enabling the function | Disabled | To use this feature, contact [email protected] to enable it. |
| Permission | Group owner and administrators | By default, only the group owner and administrators can request read receipts when sending a message. <br/>You can contact [[email protected]](mailto:support@agora.io) to grant the permission to regular group members.|
| Number of days before read receipts cannot be returned after the message is sent | 3 days | The server no longer records the group members that read the message three days after it is sent, nor sends the read receipts. |
| Chat group size | 500 members | This feature is available only to groups with up to 500 members. In other words, each message in a group can have up to 500 read receipts. If the upper limit is exceeded, the latest read receipt record will overwrite the earliest one. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,8 @@ For a group chat, group members can determine whether to require message read re
The following table shows the restrictions of this feature:

| Feature Restriction| Default | Description |
| :--------- | :----- | :------- |
| :--------- | :----- | :------- |
| Enabling the function | Disabled | To use this feature, contact support@agora.io to enable it. |
| Permission | Group owner and administrators | By default, only the group owner and administrators can request read receipts when sending a message. <br/>You can contact [support@agora.io](mailto:support@agora.io) to grant the permission to regular group members.|
| Number of days before read receipts cannot be returned after the message is sent | 3 days | The server no longer records the group members that read the message three days after it is sent, nor sends the read receipts. |
| Chat group size | 500 members | This feature is available only to groups with up to 500 members. In other words, each message in a group can have up to 500 read receipts. If the upper limit is exceeded, the latest read receipt record will overwrite the earliest one. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ For a group chat, group members can determine whether to require message read re

| Feature Restriction| Default | Description | Error |
| :--------- | :----- | :------- | :------- |
| Enabling the function | Disabled | To use this feature, contact [email protected] to enable it. | The error 503 "group ack not open" is returned if you fail to enable this feature before using it. |
| Permission | Group owner and administrators | By default, only the group owner and administrators can request read receipts when sending a message. <br/>You can contact [[email protected]](mailto:[email protected]) to grant the permission to regular group members.| The error "group ack msg permission denied" is returned if regular group members without the permission request read receipts when sending a message. |
| Number of days before read receipts cannot be returned after the message is sent | 3 days | The server no longer records the group members that read the message three days after it is sent, nor sends the read receipts. | The error "group ack msg not found" is returned if read receipts are sent three days after the message is sent. |
| Chat group size | 500 members | This feature is available only to groups with up to 500 members. In other words, each message in a group can have up to 500 read receipts. | If the upper limit is exceeded, no error is returned, but the latest read receipt record will overwrite the earliest one.|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@ The following table shows the restrictions of this feature:

| Feature Restriction| Default | Description |
| :--------- | :----- | :------- |
| Enabling the function | Disabled | To use this feature, contact support@agora.io to enable it. |
| Permission | Group owner and administrators | By default, only the group owner and administrators can request read receipts when sending a message. <br/>You can contact [support@agora.io](mailto:support@agora.io) to grant the permission to regular group members.|
| Number of days before read receipts cannot be returned after the message is sent | 3 days | The server no longer records the group members that read the message three days after it is sent, nor sends the read receipts. |
| Chat group size | 500 members | This feature is available only to groups with up to 500 members. In other words, each message in a group can have up to 500 read receipts. If the upper limit is exceeded, the latest read receipt record will overwrite the earliest one. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ If the returned HTTP status code is `200`, the request succeeds, and the respons
| :---------------- | :----- | :------------------------- |
| `data` | Object | The push result. The server determines the push status based on the push result. |
| `data.pushStatus` | String | The push status: <br/> - `SUCCESS`: The push succeeds.<br/> - `FAIL`: The push fails due to an error that is not caused by the server, like `bad device token`, indicating that the mobile device delivers an incorrect device token to the server and the server does not accept it.<br/> - `ERROR`: The push exception occurs due to a server error, for example, connection timeout or read or write timeout.|
| `data.data` | Object | The push result data returned by the push service used by the push notification recipient. |
| `data.desc` | String | The description for the push failure. |

For other fields and detailed descriptions, see [Common parameters](#param).

Expand Down

0 comments on commit 8eab255

Please sign in to comment.