sjero.net Git - linphone/blob - coreapi/plugins/buddylookup/README

   1 This plugin implements a buddy lookup using a xml-rpc lookup to a distant server.
   2 The server side implementation isn't available here but it is quite simple to implement.
   3 The format of the xml-rpc request defined below:
   4
   5 The function name is "fp.searchUsers"
   6  /**
   7  * Arguments:
   8  * sip_uri: string, mandatory, the SIP username, ie john.doe@example.net
   9  * password: string, mandatory, the SIP password
  10  * criteria: string, mandatory, the key or criteria to search for, multiple keywords should be space separated
  11  * limit: int, optional default 100, the maximum number of results to get back, -1 for all of them (note that -1 would really be limited by a hard limit at the server, something decent in the style of 100 or similar).
  12  * offset: int, optional default 0, where to start in the result list for the given criteria
  13  * domain: string, optional default is the same name as the SIP name, in which domain to search for users
  14  *
  15  * Returns:
  16  * If sip-uri & password is correct, an array where each element is a struct with the following members:
  17  * first_name: string, example: "John"
  18  * last_name: string, example: "Doe"
  19  * display_name: string, example: "John Doe"
  20  * street: string, example: "Paradise Avenue"
  21  * zip: string, example: "7777777"
  22  * city: string, example: "Heaven"
  23  * country: string, example: "SKY"
  24  * email: string, example: "john.doe@example.net"
  25  * sip: string, example "john.doe@example.net"
  26  * domain: string, example: "myjoice.com"
  27  *
  28  * If username || password is incorrect an error with a numeric code and a message is returned.
  29  *
  30  */
  31
  32 The server uri is configurable in ~/.linphonerc :
  33
  34 [BuddyLookup]
  35 url=https://....