Broadcast shared content using shared devices

Prerequisites

The sharer must have created a project and added broadcasting devices. For more information, see Step 1: Create a project, Step 2: Add a device and obtain authentication information, and Step 3: Develop the device.

Background information

The shared content feature lets you share some or all of your broadcasting devices with other users for their voice marketing campaigns. This helps you increase the value and utilization of your devices.

Enable shared content

Both the sharer and the sharee must enable the shared content feature.

1. Log in to the IoT Platform console and click the Value-added Service tab.

2. Under Voice Broadcasting Service, click Go to Service.

3. In the upper-left corner of the workbench, select the target instance.

4. In the left-side navigation pane, choose Shared Content Management.

5. Select all checkboxes in the shared content agreement and click Enable.

   In the left-side navigation pane, click Shared Content Management to go to the shared content agreement page. The three checkboxes are: Allow the sharee to obtain the ProductKey and DeviceName information of the devices, Allow the sharee to create shared content, and Allow the sharee to obtain the monthly playback count and combined data of shared content.

Configure a sharing task

Create a sharing task

1. The sharer logs in to the IoT Platform console and clicks the Value-added Service tab.

2. Under Voice Broadcasting Service, click Go to Service.

3. In the upper-left corner of the workbench, select the target instance.

4. In the left-side navigation pane, choose Shared Content Management.

5. On the Sharing Task tab, click Add Task.

6. In the Add Task dialog box, enter a Task Name and click Confirm.

   The Task Name can contain Chinese characters, English letters, numbers, underscores (_), and hyphens (-). The name must be 1 to 64 characters in length. A Chinese character is counted as two characters.

   After the sharing task is created, the Current Status is To be shared. You can then click Edit in the Actions column to change the Task Name.

   In addition, the Actions column contains the Details and Sharing Approval links.

7. In the task list, find the Sharing Code for the task and send it to the sharee.

Join a sharing task

The sharee must use the sharing code to join the sharing task.

1. The sharee logs in to the IoT Platform console and clicks the Value-added Service tab.

2. Under Voice Broadcasting Service, click Go to Service.

3. In the upper-left corner of the workbench, select the target instance.

4. In the left-side navigation pane, choose Shared with Me, and then click Add Sharing Task.

5. In the dialog box that appears, enter the sharing code and click Confirm.

   You must obtain the sharing code from the sharer. After you add the sharing task, the Current Status is Pending Review.

   After the sharer approves the request, the Task Status changes to Sharing.

Review a sharee's join request

After a sharee uses a sharing code to join a task, the sharer must approve the request.

1. The sharer returns to the Shared Content Management page in the Voice Broadcasting Service console.

2. In the task list, find the target task whose status is Pending Review, and click Sharing Approval.

3. In the Confirm Share dialog box, select all checkboxes in the sharing agreement and click Agree.

   The sharing agreement checkboxes include: Allow the sharee to obtain the ProductKey and DeviceName information of the devices, Allow the sharee to create shared content, and Allow the sharee to obtain the monthly playback count and combined data of shared content.

   After the sharer approves the request, the task's Current Status changes to Sharing.

Add shared devices

After the sharing task is approved, the sharer must add the devices they want to share to the task.

1. In the task list, find the target sharing task and click Details in the Actions column.

2. On the Task Details page, click the Shared Devices tab.

3. Click Add Device and find the target project in the list of Voice Broadcasting Service projects for the current instance.

4. In the Actions column for the project, perform one of the following actions to add devices:

   • Click Add All, and then click Confirm in the dialog box that appears to add all broadcasting devices from the project.

   • Click Select Devices. In the Select Devices dialog box, add devices in one of the following ways:

     Use the search box at the top of the dialog box to search for a device by its DeviceName. Click Where to check the import progress to view the progress in the batch import dashboard on the Task Details > Shared Devices page.

     • Select the checkboxes next to the target devices and click OK.

     • Click Add from File. In the Import Device File dialog box, click Import CSV to Add Devices, upload the file as prompted, and click OK.

       Click Download to get a template file. Then, fill it with the ProductKey and DeviceName of the devices in your project.

Add shared content

1. The sharee returns to the Shared with Me page in the Voice Broadcasting Service console.

2. In the task list, find the target task and click Details in the Actions column.

3. On the Task Details page, click Add Shared Content.

   You can view the sharer's information on the task details page.

4. In the New Content dialog box, configure the content information and click OK.

   For parameter descriptions, see Create content.

   After you add the shared content, the Sharing Review Status is Pending Review. You can then click Edit in the Actions column to modify the content.

   After the sharer approves the request, the Sharing Review Status changes to Approved. The sharee can no longer edit the shared content.

   If the sharer rejects the request, the sharee can click Edit in the Actions column to modify the content and resubmit it for review.

Review shared content

After the sharee adds shared content, the sharer must review and approve it.

1. The sharer returns to the Task Details page of the sharing task.

2. On the Shared Content tab, click Audition in the Actions column for the corresponding content.

3. After you audition the content, click Pending Approval in the Actions column for the content.

4. In the Content Review dialog box, review the content information and approve or reject it.

   The content information includes Content, Speaker, Speech Rate, Content Format (WAV, MP3, or AMR), and Volume.

   • Click Agree. The Current Status of the shared content changes to Approved. The sharee can no longer edit this content information.

     Note

     The service pushes approved shared content to all shared devices in the task.

   • Click Reject. The Current Status of the shared content changes to Rejected. The sharee can modify the content information and wait for another review from the sharer.

     The sharee can click Pending Approval in the Actions column to resubmit it for review.

Push task dashboard

The sharer can view the push details for shared content and shared devices in the current sharing task.

1. On the Task Details page, the sharer clicks the push task dashboard tab.

   The push task dashboard page displays a list of tasks with columns for Task creation time, Push mode, Completion rate, Remaining time, and Actions. At the top of the page, you can use the All Modes drop-down list to filter tasks by push mode. The Actions column for each task contains a Details link.

2. Click Details in the Actions column for the target task to view its completion status.

3. Click Details in the Actions column for a shared device to view information about the shared content pushed to it.

   The top of the push details page displays four metrics: Total Target Devices, Successful Targets, Failed Targets, and In Progress. The device list below includes columns for DeviceName, Completion status, Error code, and Last updated. When you click a device, the Content details panel appears on the right, showing the No. and Content ID associated with the device.

Broadcast shared content

After configuring the sharing task, the sharer must broadcast the shared content to the shared devices using the specified broadcast method.

To play shared content, use the shared combination broadcast API provided by the Voice Broadcasting Service. For more information, see ShareSpeechByCombination and Use OpenAPI examples.

Broadcast dashboard

The broadcast dashboard allows the sharer to quickly view overall playback performance.

1. The sharer returns to the Shared Content Management page in the Voice Broadcasting Service console.

2. Click the broadcast dashboard tab to view the broadcast information and performance of the sharing task.

   The broadcast dashboard displays the following statistics: Total shared devices and New shared devices this month; the Broadcast device statistics area includes Devices with broadcast records, Devices with broadcast records this month, and Devices with broadcast records yesterday, and for each metric, you can click Download CSV to export the data; the Daily statistics area includes Total daily broadcasts, Daily broadcast success rate, and a donut chart for the Distribution of broadcast failure reasons (failure reasons include duplicate broadcasts, non-existent content, internal platform errors, device timeouts, and offline devices), and you can click Export Details to obtain the details.