From 8eab255ff76b6a04f894995e0999a7d9ce173ff9 Mon Sep 17 00:00:00 2001 From: haoxiuwen Date: Fri, 9 Aug 2024 10:07:57 +0800 Subject: [PATCH] modify chat doc --- .../Message Receipts/agora_chat_message_receipt_android.md | 1 + .../Message Receipts/agora_chat_message_receipt_flutter.md | 1 + .../Message Receipts/agora_chat_message_receipt_ios.md | 1 + .../Messages/Message Receipts/agora_chat_message_receipt_rn.md | 1 + .../Message Receipts/agora_chat_message_receipt_unity.md | 3 ++- .../Message Receipts/agora_chat_message_receipt_web.md | 1 + .../Message Receipts/agora_chat_message_receipt_windows.md | 1 + .../Push/agora_chat_restful_send_push_notification.md | 2 ++ 8 files changed, 10 insertions(+), 1 deletion(-) diff --git a/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_android.md b/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_android.md index 7a19a3b8deb..d97af94b3b8 100644 --- a/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_android.md +++ b/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_android.md @@ -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 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.
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. | diff --git a/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_flutter.md b/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_flutter.md index 3e409ab36b4..06d5fe5dcbd 100644 --- a/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_flutter.md +++ b/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_flutter.md @@ -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 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.
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. | diff --git a/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_ios.md b/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_ios.md index 237ccb5c686..eb1f8262467 100644 --- a/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_ios.md +++ b/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_ios.md @@ -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 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.
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. | diff --git a/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_rn.md b/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_rn.md index 1c318b4e38f..a40c2fc399b 100644 --- a/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_rn.md +++ b/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_rn.md @@ -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 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.
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. | diff --git a/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_unity.md b/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_unity.md index 12315a04a33..0b60749f9c0 100644 --- a/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_unity.md +++ b/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_unity.md @@ -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.
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. | diff --git a/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_web.md b/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_web.md index 074e0ba5903..d43e4b2f8eb 100644 --- a/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_web.md +++ b/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_web.md @@ -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 support@agora.io 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.
You can contact [support@agora.io](mailto:support@agora.io) 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.| diff --git a/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_windows.md b/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_windows.md index c0c05e2e426..04110bb978e 100644 --- a/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_windows.md +++ b/en-US/markdown/agora-chat/Develop/Messages/Message Receipts/agora_chat_message_receipt_windows.md @@ -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.
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. | diff --git a/en-US/markdown/agora-chat/RESTful API Reference/Push/agora_chat_restful_send_push_notification.md b/en-US/markdown/agora-chat/RESTful API Reference/Push/agora_chat_restful_send_push_notification.md index 52cfe7e522e..a7b618d9168 100644 --- a/en-US/markdown/agora-chat/RESTful API Reference/Push/agora_chat_restful_send_push_notification.md +++ b/en-US/markdown/agora-chat/RESTful API Reference/Push/agora_chat_restful_send_push_notification.md @@ -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:
- `SUCCESS`: The push succeeds.
- `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.
- `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).