Труконф

# searchContact

Версия: 4.2.0

Описание: поиск контактов на сервере.

Результаты поиска кешируются. Время жизни записи кеша - 5 минут. Также есть ограничение на частоту запросов. Доступен один запрос на поиск в 2 секунды. Если в этот период таймаута будет сделан запрос с новой строкой поиска, вернется ошибка, если со строкой, которая уже запрашивалась - закешированный результат.

Пример запроса:

{
    "method" : "searchContact",
    "searchingString" : "us",
    "searchingMask" : 3,
    "searchingTimeoutMsec" : 2000
}

Пример ответа:

{
    "method": "searchContact",
    "requestId": "",
    "foundContacts": [{
        "peerId": "user1@some.server",
        "displayName": "U1",
        "isInAbook" : true
    }, {
        "peerId": "user2@some.server",
        "displayName": "U2",
        "isInAbook" : true
    }, {
        "peerId": "user3@some.server",
        "displayName": "U3",
        "isInAbook" : false
    }],
    "result": true
}

Описание параметров:

  • searchingString - строка, по которой будет произведен поиск

  • searchingTimeoutMsec - таймаут для поиска и выдачи ответа, переданное в миллисекундах. Доступный диапазон значений - 1..20000

  • isInAbook - флаг, обозначающий наличие контакта в АК

  • searchingMask - необязательный параметр - маска, обозначающее места поиска. Доступные места:

    • 1 - поиск по уникальному идентификатору пользователя

    • 2 - поиск по отображаемому имени пользователя или по дополнительным полям пользователя - имени и фамилии

  • requestId - уникальный идентификтор запроса

  • foundContacts - список найденных контактов

  • peerId - уникальный идентификатор найденного контакта

  • displayName - отображаемое имя найденного контакта

См. также: