com.innovaphone.search (App API)

This API provides an interface for cross-app searches.

API model

Service info

The API doesn't define any service info.

Provider model

The API doesn't define a provider model.

API messages

All messages are JSON objects that have a mandatory attribute "mt" that specifies the message type.

Requests

Search

Starts a search for a given phone number.

type

Type of serach information (e.g. "contact")

search

The pattern to be searched

Example: { mt: "Search", type: "contact", search: "673" }

Responses

SearchInfo

Zero or more SearchInfo are returned for each Search request

type

Type of serach information (e.g. "contact")

guid

User's GUID on the PBX

dn

Display name

link

App-Item-Link (if the originating app can display item details)

contact

Directory entry that matches the criteria. An entry contains the following optional members:

sn, givenname, company, displayname

telephonenumber (ARRAY), mobile (ARRAY), homephone (ARRAY), extension (ARRAY), facsimiletelephonenumber (ARRAY)

sip (ARRAY), email (ARRAY)

title, position, url, department, description, info, roomnumber

city, street, postalcode, state, country

privatecity, privatestreet, privatepostalcode, privatestate, privatecountry

photourl

URL to image data. Could be HTTP/HTTPS url or inline data (data:image/png;base64…).

avatar

Username to get the profile picture with the Avatar API.

pbx

Location

node

Node

template

Config template

adjust

Indicates that provided phone numbers might not contain the external line prefix and might need to be adjusted by the phone/softphone app before dialing.

Example:

    {
        mt: "SearchInfo",
        type: "contact",
        guid: "8800aa00-a000-5f01-4800-009030010600",
        dn: "Jake Blues",
        link:"someapp?id=jbl@example.com",
        contact: {
            extension: ["673"],
            givenname: "Jake",
            sn: "Blues",
            company: "Blues Brothers",
            sip: ["jbl@example.com"],
            email: ["john.blues@example.com"]
        },
        avatar: "jbl",
        pbx: "master",
        node: "root",
        template: "Config",
        photourl: "http://1.2.3.4/jbl/avatar.png",
        adjust: true
    }

SearchResult

One single SearchResult is returned for each Search request (after all SearchInfo)

Example: { mt: "SearchResult" }