[TOC]

1.1. 语音识别结果说明

语音听写结果示例：

{
  "sn": 1,
  "ls": true,
  "bg": 0,
  "ed": 0,
  "ws": [
    {
      "bg": 0,
      "cw": [
        {
          "w": " 今天 ",
          "sc": 0
        }
      ]
    },
    {
      "bg": 0,
      "cw": [
        {
          "w": " 的",
          "sc": 0
        }
      ]
    },
    {
      "bg": 0,
      "cw": [
        {
          "w": " 天气 ",
          "sc": 0
        }
      ]
    },
    {
      "bg": 0,
      "cw": [
        {
          "w": " 怎么样 ",
          "sc": 0
        }
      ]
    },
    {
      "bg": 0,
      "cw": [
        {
          "w": " 。",
          "sc": 0
        }
      ]
    }
  ]
}

多候选结果示例：

{
  "sn": 1,
  "ls": false,
  "bg": 0,
  "ed": 0,
  "ws": [
    {
      "bg": 0,
      "cw": [
        {
          "w": "我想听",
          "sc": 0
        }
      ]
    },
    {
      "bg": 0,
      "cw": [
        {
          "w": "拉德斯基进行曲",
          "sc": 0
        },
        {
          "w": "拉得斯进行曲",
          "sc": 0
        }
      ]
    }
  ]
}

语法识别结果示例：

{
  "sn": 1,
  "ls": true,
  "bg": 0,
  "ed": 0,
  "ws": [
    {
      "bg": 0,
      "cw": [
        {
          "sc": "70",
          "gm": "0",
          "w": "北京到上海"
        },
        {
          "sc": "69",
          "gm": "0",
          "w": "天京到上海"
        },
        {
          "sc": "58",
          "gm": "0",
          "w": "东京到上海"
        }
      ]
    }
  ]
}

1.2. 语音唤醒结果说明

唤醒结果字段说明:

语音唤醒结果示例：

{
    "sst":"wakeup",
    "id":0,
    "score":1450,
    "bos":1610,
    "eos":2260,
    "keyword":"ding1-dong1-ding1-dong1"
}

1.3. 声纹识别结果说明

文本密码JSON示例：

{
  "txt_pwd": [
    "我的地盘我做主",
    "移动改变生活",
    "芝麻开门"
  ]
}

数字密码JSON示例：

{
  "num_pwd": [
    "03285469",
    "09734658",
    "53894276",
    "57392804",
    "68294073"
  ]
}

声纹业务结果（VerifierResult）成员说明：

1.3.1. 声纹注册字段

声纹注册结果示例：

{
  "vid":"418bf8071f6a56be862f9b1681395a7f",
  "suc": 5,
  "rgn": 5,
  "sst": "enroll",
  "ssub": "ivp",
  "ret": 0
}

1.3.2. 查询/删除模型字段

查询结果示例 ：

{
  "ssub": "ivp",
  "sst": "query",
  "ret": 0
}

删除结果示例：

{
  "ssub": "ivp",
  "sst": "delete",
  "ret": 0
}

1.4. 人脸识别结果说明

1.4.1. 人脸注册字段

人脸注册结果示例：

{
  "ret": 0,
  "suc": 1,
  "rgn": 1,
  "sst": "enroll",
  "ssub": "ifr",
  "fid": "90f821fa7381ee297a80ed9570dea635"
}

1.4.2. 查询/删除模型字段

查询结果示例 ：

{
  "ssub": "ivp",
  "sst": "query",
  "ret": 0
}

删除结果示例：

{
  "ssub": "ivp",
  "sst": "delete",
  "ret": 0
}

1.5. 身份验证结果说明

1.5.1. 人脸、声纹和融合验证字段

验证结果示例：

{
  "ret": 0,
  "face_score": 99.732,
  "voice_score": 86.874,
  "ssub": "ivp|ifr",
  "decision": "accepted",
  "fusion_score": 99.823,
  "sst": "verify"
}

1.5.2. 组管理字段

创建组结果示例：

{
  "ssub": "ipt",
  "group_name": " xxxxxxxx ",
  "sst": "add",
  "ret": 0,
  "group_id": "xxxxxxxx"
}

删除组结果示例：

{
  "ssub": "ipt",
  "group_name": " xxxxxxxx ",
  "sst": "delete",
  "ret": 0,
  "group_id": " xxxxxxxx "
}

查询组中人员结果示例：

{
  "ssub": "ipt",
  "person": [
    {
      "user": " xxxxxxxx "
    }
  ],
  "group_name": " xxxxxxxx ",
  "sst": "query",
  "ret": 0,
  "group_id": " xxxxxxxx "
}

用户加入组结果示例：

{
  "ssub": "ipt",
  "group_name": " xxxxxxxx ",
  "ret": 0,
  "sst": "add",
  "user": " xxxxxxxx ",
  "group_id": " xxxxxxxx "
}

用户退出组结果示例：

{
  "ssub": "ipt",
  "group_name": " xxxxxxxx ",
  "ret": 0,
  "sst": "delete",
  "user": " xxxxxxxx ",
  "group_id": " xxxxxxxx "
}

1.5.3. 人脸、声纹鉴别字段

鉴别结果示例：

{
  "ret": 0,
  "group_id": "xxxxxx",
  "group_name": "xxxxxx",
  "ifv_result": {
    "candidates": [
      {
        "model_id": "xxxxxxxx",
        "decision": "accepted",
        "score": 88.888888,
        "user": "user_name"
      }
    ]
  },
  "sst": "identify",
  "ssub": "ivp",
  "topc": 1
}

1.5.4. 查询/删除模型字段

查询结果示例 ：

{
  "ssub": "ivp",
  "sst": "query",
  "ret": 0
}

删除结果示例：

{
  "ssub": "ivp",
  "sst": "delete",
  "ret": 0
}

1.6. 合成发音人列表

1、 语言为中英文的发音人可以支持中英文的混合朗读。2、 英文发音人只能朗读英文，中文无法朗读。3、 汉语发音人只能朗读中文，遇到英文会以单个字母的方式进行朗读。4、 使用新引擎参数会获得更好的合成效果。5、发音人的授权管理详见：控制台-我的应用-在线语音合成服务管理-发音人授权管理

1.7. 错误码列表

10000~19999的错误码参见MSC错误码。

其它错误码参见下表：

1.8. 集成帮助文档

打开终端（termainl或iterm），cd 到压缩包的doc 目录，执行以下命令：

cp -R -f -a com.iflytek.IFlyMSC.docset ~/Library/Developer/Shared/Documentation/DocSets/

然后执行命令：

open ~/Library/Developer/Shared/Documentation/DocSets/

注意：不同的Xcode版本，对应的docset路径可能有变化，需要根据实际路径来操作。（例如：/Applications/Xcode.app/Contents/Developer/Documentation/DocSets/）

请核对文档的版本为最新下载的版本：

打开Xcode的帮助文档就可以看到已经集成的文档：