MAPI Manual

NAME

LIST_CONTACTS_INCONTACTGROUP

FUNCTION

List contacts in a contact group

SYNOPSIS

contactgroup_id, search_limit

DESCRIPTION

This function allows users to list contacts within a contact group.

Required Parameters

* action: LIST_CONTACTS_INCONTACTGROUP.
* contactgroup_id: ID of the contact group.

Optional Parameters

* search_limit: specifies a limit on the number of list results. It accepts two formats - either a number or two numbers separated by a comma. For example, if value is "5", the function will return the first five results to users; if value is "5,10", the function will return results that are ordered within this range. 

RETURN DATA

The response contains the following attributes:
* mcp_org_id: ID of the organisation.
* mcp_contactbook_id: ID of the contact book.
* mcp_contact_id: ID of the contact.

ROLE PERMITTED

Manager

EXAMPLES

The following example shows a successful HTTP GET request and response.

Request:
http://app02.yvntech.com/MapIHttpS/MapIS?action=LIST_CONTACTS_INCONTACTGROUP&contactgroup_id=164&login_name=user@example.com&login_passwd=1111

Response:
<result tftype='1' infotype='0'>
    <resultset name='mcp_contacts' search_found_rows='10'>
        <row>
            <field name='mcp_org_id'>9000</field>
            <field name='mcp_contactbook_id'>1</field>
            <field name='mcp_contact_id'>1156</field>
            <field name='name'>simon</field>
            <field name='mobile'>+61400000000</field>
            <field name='email'>simon@example.com</field>
        </row>
        ...
        ...
        
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

LIST_CONTACTGROUPS

Mweb v2.0 YVNTECH 2014