MAPI Manual

NAME

LIST_CONTACTGROUPS

FUNCTION

List contact groups

SYNOPSIS

search_limit

DESCRIPTION

This function allows users to list the contact groups.

Required Parameters

* action: LIST_CONTACTGROUPS.

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 the results that are ordered within this range.

RETURN DATA

The response contains the following attributes:
* mcp_org_id: organization ID.
* mcp_contactgroup_id: ID of the contact group.
* mcp_contactbook_id: ID of the contact book that defines the columns for the contact group.
* contactgroup_type: type of the contact group.
* contactgroup_name: name of the contact group.
* contactgroup_description: description of the contact group.
* owner_mcp_user_id: ID of the user who created the contact group.
* creat_dt: timestamp when the contact group was created.
* lastupdate_mcp_user_id: ID of the user who last updated the group.
* last_update_dt: timestamp when last update was made to the group.
* contacts_count: the total number of contacts within the group.
* contactbook_name: name of the contact book.

ROLE PERMITTED

Manager, admin, account manager, root

EXAMPLES

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

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

Response:
<result tftype='1' infotype='0' requestid='LIST_CONTACTGROUPS'>
    <resultset name='mcp_contactgroups' search_found_rows='31'>
        <row>
            <field name='mcp_org_id'>9000</field>
            <field name='mcp_contactgroup_id'>134</field>
            <field name='mcp_contactbook_id'>1</field>
            <field name='contactgroup_type'>org_level</field>
            <field name='contactgroup_name'>NewTestTeam</field>
            <field name='contactgroup_description'>NewlyAddedGroup</field>
            <field name='owner_mcp_user_id'>7009000</field>
            <field name='creat_dt'>2014-07-04 09:55:51</field>
            <field name='lastupdate_mcp_user_id'>7009000</field>
            <field name='last_update_dt'>2014-07-04 09:55:51</field>
            <field name='contacts_count'>0</field>
            <field name='contactbook_name'>default teamchat contactbook</field>
        </row>
        ...
        ...
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

LIST_CONTACTGROUP_COLUMNS

Mweb v2.0 YVNTECH 2014