Phone Directory

Overview

This API fetches the phone directory for the Agent.

Pre-requisite

The agent must be in the LoggedIn state.

Sequence Diagram

Message Structure

Data Parameters

Response Parameters

Response Data Parameters

Sample Request

{
    "channel": "Cisco",
    "topic": "Agent",
    "subtopic": "GetPhoneDirectory"
}

Sample Response

{
    "channel": "Cisco",
    "topic": "Agent",
    "subtopic": "SetPhoneDirectory",
    "message": 
    {
        "packet": "phoneBook",
        "data": 
        [
            {
                "name": "TestShiva",
                "type": "GLOBAL",
                "uri": "/finesse/api/PhoneBook/1",
                "contacts": [
                    {
                        "firstName": "kathy",
                        "lastName": "kathy",
                        "phoneNumber": "5054",
                        "description": "Kathy jabber extn",
                        "uri": "/finesse/api/PhoneBook/1/Contact/1"
                    },
                    {
                        "firstName": "joseph",
                        "lastName": "jabber",
                        "phoneNumber": "5055",
                        "description": "josephjabber extnsion number",
                        "uri": "/finesse/api/PhoneBook/1/Contact/2"
                    },
                    {
                        "firstName": "kk",
                        "lastName": "wrong",
                        "phoneNumber": "1234",
                        "description": "invalid",
                        "uri": "/finesse/api/PhoneBook/1/Contact/3"
                    },
                    {
                        "firstName": "mazi",
                        "lastName": "sk",
                        "phoneNumber": "99381604019",
                        "description": "ph.no",
                        "uri": "/finesse/api/PhoneBook/1/Contact/4"
                    },
                    {
                        "firstName": "test",
                        "lastName": "test1",
                        "phoneNumber": "18878473732843789g89876866657",
                        "description": "lenghty characters ",
                        "uri": "/finesse/api/PhoneBook/1/Contact/5"
                    }
                ]
            }
        ]
    }
}