UploadData

You can call UploadData.json to upload text-based quality inspection data. Text typically originates from online customer service interactions or tickets. The API returns a task ID. You can retrieve results in one of three ways:

• Message notification: For details, see message queues. After you receive a message, call the GetResult API to retrieve detailed results. (Recommended)

• Callback: Specify a callback URL in your request parameters. After the task completes, the system sends a callback to that URL. Then call the GetResult API to retrieve detailed results.

• Polling: Use the returned task ID to poll the GetResult API asynchronously. Check whether the status field in the response indicates completion. (Not recommended)

JsonStr property description

JsonStr.tickets property description

dialogue property description

Emoji display notes

On the review details page, only standard Emoji characters display. When uploading, replace emojis with UTF-8 character codes such as 😀. For example, the smiley face emoji is 😀. Codes start with &# and end with a semicolon. For more information, see the Emoji character reference table and the HTML character display guide.

Callback parameter description

If you specify the callback URL http://aliyun.com/callback, the full callback URL becomes http://aliyun.com/callback?taskId=xxx&timestamp=xxx&signature=xxx&event=xxx. Parameters:

• taskId: Task ID.

• timestamp: UNIX timestamp of the callback request. Unit: milliseconds.

• aliUid: Alibaba Cloud account UID of the caller.

• signature: Signature used to verify the request originated from Alibaba Cloud. Compute it by applying MD5 then Base64 encoding to the string taskId=xxx&timestamp=xxx&aliUid=xxx. Maintain the parameter order. After receiving the callback, extract taskId and timestamp from the URL. Use your Alibaba Cloud account UID as aliUid. Compare your computed signature with the one in the URL. See the Java code example below.

• event: Event name. Use this to identify which event triggered the callback. Valid value: TaskComplete (sent when the task completes).

public static void signature() {
    long timestamp = System.currentTimeMillis();
    String taskId = "xxxx";
    String aliUid = "xxxxx";
    // Apply MD5 then Base64 encoding to "taskId=xxx&timestamp=xxx&aliUid=xxx", and place result in the signature field
    String signature;
    try {
        signature = URLEncoder.encode(md5Base64("taskId=" + taskId + "&timestamp=" + timestamp + "&aliUid=" + aliUid), "utf-8");
        System.out.println(signature);
    } catch (Exception e) {
        e.printStackTrace();
    }
}

public static String md5Base64(String str) throws NoSuchAlgorithmException {
    // String encoding must be UTF-8
    byte[] utfBytes = str.getBytes(StandardCharsets.UTF_8);
    MessageDigest mdTemp = MessageDigest.getInstance("MD5");
    mdTemp.update(utfBytes);
    byte[] md5Bytes = mdTemp.digest();
    return Base64.encodeBase64String(md5Bytes);
}

Request parameter example

{
  "callbackUrl": "https://123.123.com/sca-callback",
  "tickets": [
    {
      "schemeTaskConfigId": "389",
      "customerName": "Zhang San 1",
      "customerId": "zhangsan-vip-audio",
      "dialogue": [
        {
          "beginTime": "2019-11-25 15:36:01",
          "role": "customer",
          "identity": "A customer",
          "emotionValue": 6,
          "speechRate": 153,
          "words": "Hello.",
          "end": 2580,
          "begin": 1800,
          "channelId": 1
        },
        {
          "beginTime": "2019-11-25 15:37:01",
          "role": "agent",
          "identity": "An agent",
          "emotionValue": 6,
          "speechRate": 153,
          "words": "How can I help you? What would you like to buy? Please tell me.",
          "end": 2580,
          "begin": 1800,
          "channelId": 1
        },
        {
          "beginTime": "2019-11-25 15:37:06",
          "role": "agent",
          "identity": "An agent",
          "emotionValue": 6,
          "speechRate": 305,
          "words": "I want to buy a sweater.",
          "end": 12540,
          "begin": 6770,
          "channelId": 0
        }
      ]
    }
  ]
}

Request code example

public class sca {

    private static String ak = "YOUR_ACCESS_KEY_ID";
    private static String sk = "YOUR_ACCESS_KEY_SECRET";

    private static void uploadText() throws Exception {
        String json="{\n" +
                "    \"callbackUrl\":\"https://123.123.com/sca-callback\",\n" +
                "    \"tickets\":[\n" +
                "        {\n" +
                "            \"schemeTaskConfigId\":\"389\",\n" +
                "            \"customerName\": \"Zhang San 1\",\n" +
                "            \"customerId\": \"zhangsan-vip-audio\",\n" +
                "            \"dialogue\":[\n" +
                "                 {\n" +
                "                    \"beginTime\":\"2019-11-25 15:36:01\",\n" +
                "                    \"role\":\"customer\",\n" +
                "                    \"identity\":\"A customer\",\n" +
                "                    \"emotionValue\":6,\n" +
                "                    \"speechRate\":153,\n" +
                "                    \"words\":\"Hello.\",\n" +
                "                    \"end\":2580,\n" +
                "                    \"begin\":1800,\n" +
                "                    \"channelId\":0\n" +
                "                },\n" +
                "                {\n" +
                "                    \"beginTime\":\"2019-11-25 15:37:01\",\n" +
                "                    \"role\":\"agent\",\n" +
                "                    \"identity\":\"An agent\",\n" +
                "                    \"emotionValue\":6,\n" +
                "                    \"speechRate\":153,\n" +
                "                    \"words\":\"How can I help you? What would you like to buy? Please tell me.\",\n" +
                "                    \"end\":2580,\n" +
                "                    \"begin\":1800,\n" +
                "                    \"channelId\":1\n" +
                "                },\n" +
                "                {\n" +
                "                    \"beginTime\":\"2019-11-25 15:37:06\",\n" +
                "                    \"role\":\"customer\",\n" +
                "                    \"identity\":\"A customer\",\n" +
                "                    \"emotionValue\":6,\n" +
                "                    \"speechRate\":305,\n" +
                "                    \"words\":\"I want to buy a sweater.\",\n" +
                "                    \"end\":12540,\n" +
                "                    \"begin\":6770,\n" +
                "                    \"channelId\":0\n" +
                "                }\n" +
                "            ]\n" +
                "        }\n" +
                "    ]\n" +
                "}";

        Config config = new Config();
        config.setAccessKeyId(ak).setAccessKeySecret(sk).setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com")
                .setRegionId("cn-hangzhou").setProtocol("HTTPS");

        Client client = new Client(config);
        UploadDataRequest result = new UploadDataRequest();

        result.setJsonStr(json);

        UploadDataResponse response = client.uploadData(result);
        System.out.println(JSONObject.toJSONString(response));
    }


    public static void main(String[] args) throws Exception {
        uploadText();
    }
}