跳到主要内容

获取联系人列表 (contact.list)

Android 扩展

此函数为 Android 平台扩展，仅在 NBTouch (Android) 上可用。

声明​

结果 = contact.list([偏移量, 限制数量])

参数及返回值​

  • 偏移量
    • 整数型，可选，默认 0
  • 限制数量
    • 整数型，可选，默认 100
  • 结果
    • 文本型，JSON 格式的响应字符串

说明​

获取联系人列表，支持分页。

示例​

-- 获取全部联系人（默认最多 100 条）
local result = contact.list()

-- 获取前 50 条
local result = contact.list(0, 50)

-- 分页获取：跳过前 50 条，获取后 50 条
local result = contact.list(50, 50)

-- 解析结果
local data = json.decode(result)
if data.code == 200 then
    print("共有", data.data.count, "个联系人")
    for _, c in ipairs(data.data.list) do
        print(c.display_name, table.concat(c.phones, ", "))
    end
end

返回示例​

{
  "code": 200,
  "data": {
    "offset": 0,
    "limit": 100,
    "count": 2,
    "list": [
      {
        "_id": 1,
        "display_name": "张三",
        "has_phone_number": 1,
        "phones": ["13800138000"]
      },
      {
        "_id": 2,
        "display_name": "李四",
        "has_phone_number": 1,
        "phones": ["13900139000"]
      }
    ]
  },
  "msg": "OK"
}

返回字段说明​

字段名类型说明
_idlong联系人唯一 ID
display_namestring联系人显示名称
has_phone_numberint是否有电话号码：1=有, 0=无
phonesarray电话号码列表