@tencent-rtc/mcp 1.4.6 → 1.6.0-beta.1

package/resource/knowledge/push/config/unity.md

@@ -0,0 +1,209 @@
+Currently, the message push plugin in Unity only supports push to Android (including manufacturer channels) and iOS devices.
+
+> **Note:**
+>
+
+> Each vendor only supports the configuration of one certificate.
+>
+
+【iOS】
+
+Before integrating the message push plug-in, you must apply for an APNs Push Certificate from Apple and then upload the Push Certificate to the Chat console. Afterward, follow the quick integration procedure to complete the setup.
+
+## Operation Steps
+
+### Step 1: Apply for an APNs Certificate
+
+#### Enable Remote App Push
+1. Log in to the [Apple Developer Center](https://developer.apple.com/account/) website, click **Certificates, Identifiers & Profiles** or **Certificates, IDs & Profiles** in the sidebar, and enter the **Certificates, IDs & Profiles** page.
+
+2. Click **+** on the right of Identifiers.
+
+3. You can refer to the following procedure to create a new AppID, or add the `Push Notification``Service` to your original AppID.
+
+> **Note**
+>
+
+>  Note: The `Bundle ID` of your App cannot use wildcard `*`, otherwise the Remote Push Service will be unavailable.
+>
+
+4. Check **App IDs**, click **Continue** to proceed to the next step.
+
+5. Select **App**, click **Continue** to proceed to the next step.
+
+6. Configure `Bundle ID` and other info, then click **Continue** to proceed to the next step.
+
+7. Check **Push Notifications** and enable Remote Push Service.
+
+#### Generating a Certificate
+1. Select your AppID, choose **Configure**.
+
+2. In the **Apple Push Notification service SSL Certificates** window, you can see two `SSL Certificates`, respectively for remote push certificates in development environment (Development) and production environment (Production), as shown below:
+
+3.
+
+First select the development environment (Development) **Create Certificate**, the system will prompt you to provide a Certificate Signing Request (CSR).
+
+4. On your Mac, open **Keychain Access**, select **Keychain Access** > **Certificate Assistant** > **Request a Certificate From a Certificate Authority** (`Keychain Access - Certificate Assistant - Request a Certificate From a Certificate Authority`).
+
+5. Enter the user email address (your mailbox), common name (Your Name or company name), select **save to disk**, click **continue**, and the system will generate a `*.certSigningRequest` file.
+
+6. Go back to the webpage on the Apple Developer website in Step 3, click **Choose File** to upload the generated `*.certSigningRequest` file.
+
+7. Click **Continue** to generate the push certificate.
+
+8. Click **Download** to download the `Development SSL Certificate` for the development environment locally.
+
+9. Repeat steps 1 - 8 to download the `Production SSL Certificate` for the production environment to local.
+
+> **Note**
+>
+
+> The certificate in the production environment is a merged certificate of development (Sandbox) and production (Production), which can be used as both a development and production environment certificate.
+>
+
+10. Double-click to open the downloaded `SSL Certificate` for the development and production environment, and the system will import it into the keychain.
+
+11. Open the keychain access app, go to **Login** > **My Certificates**, right-click to export the newly created `P12` files for the development environment (`Apple Development IOS Push Service`) and production environment (`Apple Push Services`).
+
+> **Note**
+>
+
+> When saving the `P12` file, ensure to set a password for it.
+>
+
+### Step 2: Upload Certificate to Console
+1. Log in to the [Chat console](https://console.trtc.io/chat/push-plugin-push-identifier).
+
+2. Click the target application card to enter the basic configuration page.
+
+3. Click **iOS Native Offline Push Settings** on the right **add certificate**.
+
+4. Select certificate type, upload iOS certificate (.p12), set certificate password, click **confirm**.
+
+> **Note**
+>
+> - Upload certificate name should be in English (do not use parentheses or other special characters).
+> - Upload certificate needs to be set with password. Passwordless will not receive push notifications.
+> - Set the certificate for App Store release to production environment, otherwise unable to receive push notifications.
+> - Uploaded p12 certificate must be your own real and valid applied certificate.
+
+5. After generation of pending certificate information, record the cert ID.
+
+【Android】
+
+## Operation Steps
+
+### Step 1: Register Application to Manufacturer Push Platform
+
+Offline push requires registering your own application to various manufacturers' push platforms to obtain AppID and AppKey parameters such as, enabling offline push functionality. Currently supported domestic mobile manufacturers include: [Xiaomi](https://dev.mi.com/console/doc/detail), [Huawei](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/service-introduction-0000001050040060), [honor](https://developer.hihonor.com/cn/kitdoc), [OPPO](https://open.oppomobile.com/wiki/doc#id=10195), [VIVO](https://dev.vivo.com.cn/documentCenter/doc/281), [Meizu](https://open.flyme.cn/service/3), with overseas support for [Google FCM](https://console.firebase.google.com/u/0/).
+
+### Step 2: Chat Console Configuration
+
+Log in to Tencent Cloud [Chat console](https://console.trtc.io/chat/push-plugin-push-identifier), go to **Push Management** > **Access Setting** feature section, add push certificates from various manufacturers, and configure the AppId, AppKey, AppSecret and other parameters obtained from step 1 for the added certificates.
+
+> **Note:**
+>
+
+> Note: For the **click subsequent actions** option, if you need to use the click redirect capacity provided by this Plugin, keep default values unchanged, usually `open a specified page within the app` with default configuration.
+>
+
+> If you need to use the report statistics feature, keep this item unchanged.
+>
+
+【Xiaomi】
+| Vendor Push Platform | Chat Console Configuration |
+| --- | --- |
+|  |  |
+
+【Huawei】
+| Vendor Push Platform | Chat Console Configuration |
+| --- | --- |
+|  | <strong>Note:</strong><br>Client ID corresponds to AppID, and Client Secret corresponds to AppSecret. |
+
+#### Receipt configuration
+
+**Receipt Address:**
+- Singapore : https://apisgp.im.qcloud.com/v3/offline_push_report/huawei
+
+- Korea: https://apikr.im.qcloud.com/v3/offline_push_report/huawei
+
+- USA: https://apiusa.im.qcloud.com/v3/offline_push_report/huawei
+
+- Germany: https://apiger.im.qcloud.com/v3/offline_push_report/huawei
+
+- Indonesia: https://apiidn.im.qcloud.com/v3/offline_push_report/huawei
+
+- China: https://api.im.qcloud.com/v3/offline_push_report/huawei
+
+【OPPO】
+| Vendor Push Platform | Chat Console Configuration |
+| --- | --- |
+|  |  |
+
+【vivo】
+| Vendor Push Platform | Chat Console Configuration |
+| --- | --- |
+|  |  |
+
+**Receipt configuration**
+
+**Receipt Address:**
+- Singapore :https://apisgp.im.qcloud.com/v3/offline_push_report/vivo
+
+- Korea:https://apikr.im.qcloud.com/v3/offline_push_report/vivo
+
+- USA: https://apiusa.im.qcloud.com/v3/offline_push_report/vivo
+
+- Germany: https://apiger.im.qcloud.com/v3/offline_push_report/vivo
+
+- Indonesia: https://apiidn.im.qcloud.com/v3/offline_push_report/vivo
+
+- China: https://api.im.qcloud.com/v3/offline_push_report/vivo
+
+【Meizu】
+| Vendor Push Platform | Chat Console Configuration |
+| --- | --- |
+|  |  |
+
+**Receipt configuration**
+
+**Receipt Address:**
+- Singapore : https://apisgp.im.qcloud.com/v3/offline_push_report/meizu
+
+- Korea: https://apikr.im.qcloud.com/v3/offline_push_report/meizu
+
+- USA: https://apiusa.im.qcloud.com/v3/offline_push_report/meizu
+
+- Germany: https://apiger.im.qcloud.com/v3/offline_push_report/meizu
+
+- Indonesia: https://apiidn.im.qcloud.com/v3/offline_push_report/meizu
+
+- China: https://api.im.qcloud.com/v3/offline_push_report/meizu
+
+【Honor】
+
+| Vendor Push Platform | Chat Console Configuration |
+| --- | --- |
+|  |  |
+
+#### Receipt configuration
+
+**Receipt Address:**
+- Singapore : https://apisgp.im.qcloud.com/v3/offline_push_report/honor
+
+- Korea: https://apikr.im.qcloud.com/v3/offline_push_report/honor
+
+- USA: https://apiusa.im.qcloud.com/v3/offline_push_report/honor
+
+- Germany: https://apiger.im.qcloud.com/v3/offline_push_report/honor
+
+- Indonesia: https://apiidn.im.qcloud.com/v3/offline_push_report/honor
+
+- China: https://api.im.qcloud.com/v3/offline_push_report/honor
+
+【Google FCM】
+
+| Vendor Push Platform | Chat Console Configuration |
+| --- | --- |
+|  |  |

package/resource/knowledge/push/config/unreal-engine.md

@@ -0,0 +1,194 @@
+The push service currently supports Vendor Channels such as Xiaomi, Huawei, Honor, OPPO, vivo, Meizu, OnePlus, realme, iQOO, FCM, and Apple.
+
+> **Note:**
+>
+
+> Each vendor only supports the configuration of one certificate.
+>
+
+【iOS】
+
+Before integrating the message push plug-in, you must apply for an APNs Push Certificate from Apple and upload the push certificate to the Chat console. Then follow the quick integration procedure to complete the setup.
+
+## Operation Steps
+
+### Step 1: Apply for an APNs Certificate
+
+#### Enable Remote App Push
+1. Log in to the [Apple Developer Center](https://developer.apple.com/account/) website, click **Certificates, Identifiers & Profiles** or **Certificates, IDs & Profiles** in the sidebar, and enter the **Certificates, IDs & Profiles** page.
+
+2. Click **+** on the right of Identifiers.
+
+3. You can refer to the following steps to create a new AppID or add the `Push Notification``Service` to your original AppID.
+
+> **Note**
+>
+
+>  Note: Your App's `Bundle ID` cannot use wildcard `*`, otherwise Remote Push Service will be unavailable.
+>
+
+4. Check **App IDs**, then click **Continue** to proceed to the next step.
+
+5. Select **App**, then click **Continue** to proceed to the next step.
+
+6. Configure `Bundle ID` and other info, then click **Continue** to proceed to the next step.
+
+7. Check **Push Notifications** and enable Remote Push Service.
+
+#### Generating a Certificate
+1. Select your AppID, then click **Configure**.
+
+2. You can see two `SSL Certificates` in the **Apple Push Notification service SSL Certificates** window, used for development environment (Development) and production environment (Production) remote push certificates, as shown below:
+
+3.
+
+First select the development environment (Development) **Create Certificate**, the system will prompt us to provide a Certificate Signing Request (CSR).
+
+4. On your Mac, open **Keychain Access**, then select **Keychain Access** > **Certificate Assistant** > **Request a Certificate From a Certificate Authority** (`Keychain Access - Certificate Assistant - Request a Certificate From a Certificate Authority`).
+
+5. Enter the user email address (your mailbox), common name (Your Name or company name), select **Save to Disk**, click **Continue**, and the system will generate a `*.certSigningRequest` file.
+
+6. Go back to the webpage on the Apple Developer website in Step 3, click **Choose File** to upload the generated `*.certSigningRequest` file.
+
+7. Click **Continue** to generate the Push Certificate.
+
+8. Click **Download** to download the `Development SSL Certificate` for the development environment locally.
+
+9. Repeat steps 1-8 to download the `Production SSL Certificate` for the production environment locally.
+
+> **Note**
+>
+
+> Note: The cert in the production environment is actually a merged certificate of Sandbox and Production, which can be used as the cert for both development and production environments.
+>
+
+10. Double-click to open the downloaded `SSL Certificate` for development and production environments, and the system will import it into the Keychain.
+
+11. Open the keychain access app, go to **Login** > **My Certificates**, right-click and export the newly created `Apple Development IOS Push Service` and `Apple Push Services``P12` files for development and production environments respectively.
+
+> **Note**
+>
+
+> When saving a `P12` file, ensure to set password for it.
+>
+
+### Step 2: Upload Certificate to Console
+1. Sign in to the [Chat Console](https://console.trtc.io/chat/push-plugin-push-identifier).
+
+2. Click the target application card to enter the basic configuration page.
+
+3. Click **iOS Native Offline Push Settings** on the right **add certificate**.
+
+4. Select certificate type, upload iOS certificate (.p12), set certificate password, click **confirm**.
+
+> **Note**
+>
+> - Use English for the certificate name (do not use parentheses or other special characters).
+> - Upload certificate needs to be set with password. Passwordless will not receive push notifications.
+> - To publish an App Store certificate, set it to production environment, otherwise unable to receive push.
+> - Uploaded p12 certificate must be a real and valid certificate applied by yourself.
+
+5. After generation of pending certificate information, record the cert ID.
+
+【Android】
+
+## Operation Steps
+
+### Step 1: Register Application to Manufacturer Push Platform
+
+Offline push requires registering your own application to various manufacturers' push platforms to get parameters such as AppID and AppKey, enabling offline push functionality. Currently supported domestic mobile manufacturers include: [Xiaomi](https://dev.mi.com/console/doc/detail), [Huawei](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/service-introduction-0000001050040060), [Honor](https://developer.hihonor.com/cn/kitdoc), [OPPO](https://open.oppomobile.com/wiki/doc#id=10195), [VIVO](https://dev.vivo.com.cn/documentCenter/doc/281), [Meizu](https://open.flyme.cn/service/3), with overseas support for [Google FCM](https://console.firebase.google.com/u/0/).
+
+### Step 2: Chat Console Configuration
+
+Sign in to the [Chat console](https://console.trtc.io/chat/push-plugin-push-identifier), go to the **push management** > **access setting** feature section, add push certificates for various manufacturers, and configure the AppId, AppKey, AppSecret and other parameters obtained from step 1 for the added push certificates.
+
+> **Note:**
+>
+
+> Note: For the **click subsequent actions** option, if you need to use the click redirect power provided by this Plugin, keep default values unchanged, usually `open a specified page within the app` with default configuration.
+>
+
+> If you need to use the report statistics feature, keep this item unchanged.
+>
+
+【Xiaomi】
+| Vendor Push Platform | Chat Console Configuration |
+| --- | --- |
+|  |  |
+
+【Huawei】
+| Vendor Push Platform | Chat Console Configuration |
+| --- | --- |
+|  | <strong>Note:</strong><br>Client ID corresponds to AppID, and Client Secret corresponds to AppSecret. |
+
+【OPPO】
+| Vendor Push Platform | Chat Console Configuration |
+| --- | --- |
+|  |  |
+
+【vivo】
+| Vendor Push Platform | Chat Console Configuration |
+| --- | --- |
+|  |  |
+
+**Receipt configuration**
+
+**Receipt Address:**
+- Singapore :https://apisgp.im.qcloud.com/v3/offline_push_report/vivo
+
+- Korea:https://apikr.im.qcloud.com/v3/offline_push_report/vivo
+
+- USA: https://apiusa.im.qcloud.com/v3/offline_push_report/vivo
+
+- Germany: https://apiger.im.qcloud.com/v3/offline_push_report/vivo
+
+- Indonesia: https://apiidn.im.qcloud.com/v3/offline_push_report/vivo
+
+- China: https://api.im.qcloud.com/v3/offline_push_report/vivo
+
+【Meizu】
+| Vendor Push Platform | Chat Console Configuration |
+| --- | --- |
+|  |  |
+
+**Receipt configuration**
+
+**Receipt Address:**
+- Singapore : https://apisgp.im.qcloud.com/v3/offline_push_report/meizu
+
+- Korea: https://apikr.im.qcloud.com/v3/offline_push_report/meizu
+
+- USA: https://apiusa.im.qcloud.com/v3/offline_push_report/meizu
+
+- Germany: https://apiger.im.qcloud.com/v3/offline_push_report/meizu
+
+- Indonesia: https://apiidn.im.qcloud.com/v3/offline_push_report/meizu
+
+- China: https://api.im.qcloud.com/v3/offline_push_report/meizu
+
+【Honor】
+
+| Vendor Push Platform | Chat Console Configuration |
+| --- | --- |
+|  |  |
+
+#### Receipt configuration
+
+**Receipt Address:**
+- Singapore : https://apisgp.im.qcloud.com/v3/offline_push_report/honor
+
+- Korea: https://apikr.im.qcloud.com/v3/offline_push_report/honor
+
+- USA: https://apiusa.im.qcloud.com/v3/offline_push_report/honor
+
+- Germany: https://apiger.im.qcloud.com/v3/offline_push_report/honor
+
+- Indonesia: https://apiidn.im.qcloud.com/v3/offline_push_report/honor
+
+- China: https://api.im.qcloud.com/v3/offline_push_report/honor
+
+【Google FCM】
+
+| Vendor Push Platform | Chat Console Configuration |
+| --- | --- |
+|  |  |