MAPI Manual

NAME

LIST_ROUTERS

FUNCTION

List routers

SYNOPSIS

LIST_ROUTERS

DESCRIPTION

This function allows admin users to list routers for all channel types.

Required Parameters

* action: LIST_ROUTERS.

RETURN DATA

The response contains the following attributes:
* mcp_router_id: router ID. 
* mcp_channeltype_id: channel type.
* router_name: name of the router.
* router_title: title of the router.
* router_workmode: the work mode.
* router_type: type of the router.
* gateway_assign_type: type of how the router is associated with a gateway.
* destlock_seconds: specifies how long the router will be locked.
* mcp_channeltype_funclass_id:
* isactive: specifies whether the router is active or not.
* priority: priority of the router.

ROLE PERMITTED

Admin

EXAMPLES

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

Request:

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


Response:

<result tftype='1' infotype='0'>
    <resultset name='mcp_router' search_found_rows='760'>
        <row>
            <field name='mcp_router_id'>1</field>
            <field name='mcp_channeltype_id'>voice</field>
            <field name='router_name'>voice_default_allowall</field>
            <field name='router_title'>voice_default_allowall</field>
            <field name='router_workmode'>WORKMODE_NORMAL</field>
            <field name='router_type'>MCPTYPE_UNIQUEID</field>
            <field name='gateway_assign_type'>MCPTYPE_ASSIGN_BYSYS</field>
            <field name='destlock_seconds'>7200</field>
            <field name='mcp_channeltype_funclass_id'>0</field>
            <field name='isactive'>1</field>
            <field name='priority'>1</field>
        </row>
        <row>
            <field name='mcp_router_id'>2</field>
            <field name='mcp_channeltype_id'>email</field>
            <field name='router_name'>email_default_allowall</field>
            <field name='router_title'>email_default_allowall</field>
            <field name='router_workmode'>WORKMODE_NORMAL</field>
            <field name='router_type'>MCPTYPE_UNIQUEID</field>
            <field name='gateway_assign_type'>MCPTYPE_ASSIGN_BYSYS</field>
            <field name='destlock_seconds'>7200</field>
            <field name='mcp_channeltype_funclass_id'>0</field>
            <field name='isactive'>1</field>
            <field name='priority'>1</field>
        </row>
        ...
        ...
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

Mweb v2.0 YVNTECH 2014