MAPI Manual

NAME

LIST_GATEWAYS

FUNCTION

List gateways

SYNOPSIS

mcp_channeltype_id, keyword_set, order_type, search_limit

DESCRIPTION

This function allows root users to list the gateways.

Required Parameters

* action: LIST_GATEWAYS.


Optional Parameters

* mcp_channeltype_id: channel type. Available channel types are:

  • voice,
  • email,
  • sms,
  • CHANNELTYPE_LINKACTION,
  • CHANNELTYPE_TEXT2SPEECH.

* keyword_set: searches for titles and descriptions of gateways which contain the given keywords.

* order_type: specifies the list order of the results. Value is either "DESC" or "ASC", which means in descending or ascending order respectively.

* search_limit: constrains the number of search results that are returned. It can also be used for pagination of search results. Value is a number or two numbers split by a comma. With one number, the value specifies the maximum number of results to return from the beginning of the search results. With two numbers, the first number specifies the offset of the first result to return, and the second specifies the maximum number of results to return. Note: The offset of the first result is 0 (not 1).  E.g., if value is "5", the first five search results will be returned; if value is "20,5", it will return maximum five results starting from the 21st result. Default value is 100.

RETURN DATA

The response contains the following attributes:

* mcp_channeltype_id: channel type of the gateway.

* mcp_gateway_id: gateway ID.

* gateway_name: name of gateway.

* gateway_type: type.

* assign_type: assign type.

* username:

* password:

* token:

* outbound_process:

* inbound_process:

* inbound_process:

* gateway_config:

* priority: priority of the gateway.

* isactive: specifies whether the gateway is active or not. "1" mean active.

* gateway_comm_mode: communication mode. Available modes are listed below:

  • "RECV_ONLY": used for receiving only.
  • "SEND_ONLY": used for sending only.
  • "DUPLEX": used for two-way(send and receive) communication.

* max_online:

* diagnosis_continuesfailed:

* testrun_interval:

* international_prefix:

* gateway_preserve_1:

* gateway_preserve_2:

* serve_org_list:

* note: a note about the gateway.

ROLE PERMITTED

Root

EXAMPLES

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


Request:

http://app02.yvntech.com/MapIHttpS/MapIS?action=LIST_GATEWAYS&mcp_channeltype_id=sms&login_name=user@example.com&login_passwd=1111&search_limit=1,2


Response:

<result tftype='1' infotype='0'>
    <resultset name='mcp_gateway' search_found_rows='9'>
        <row>
            <field name='mcp_channeltype_id'>sms</field>
            <field name='mcp_gateway_id'>2001</field>
            <field name='gateway_name'>+61412345678</field>
            <field name='gateway_type'>MCPTYPE_SENDERID</field>
            <field name='assign_type'>MCPTYPE_ASSIGN_BYSYS</field>
            <field name='username'>abcd</field>
            <field name='password'>1234</field>
            <field name='token'></field>
            <field name='outbound_process'>http://yvntech.com/MchISmsInboundS/BurstInboundS</field>
            <field name='inbound_process'></field>
            <field name='gateway_ip'></field>
            <field name='gateway_config'></field>
            <field name='priority'>1</field>
            <field name='isactive'>1</field>
            <field name='gateway_comm_mode'>RECV_ONLY</field>
            <field name='max_online'>10000</field>
            <field name='diagnosis_continuesfailed'>200</field>
            <field name='testrun_interval'>10</field>
            <field name='international_prefix'></field>
            <field name='gateway_preserve_1'></field>
            <field name='gateway_preserve_2'></field>
            <field name='serve_org_list'></field>
            <field name='note'>BURST SMS</field>
        </row>
        ...
        ...
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

Mweb v2.0 YVNTECH 2014