MAPI Manual

NAME

LIST_BROADCAST_REPLIES

FUNCTION

List replies to a broadcast

SYNOPSIS

broadcast_id, time_from, time_to, order_type, search_limit

DESCRIPTION

This function allows users to list replies to a broadcast.

Required Parameters
* action: LIST_BROADCAST_REPLIES.
* broadcast_id: broadcast ID.

Optional Parameters
* time_from: the beginning of time frame. This field is used to filter results based on the date and time the replies are received. The date and time format is YYYY-MM-DD HH:MM:SS. Must be URL encoded.
* time_to: the end of time frame. This field is used to filter results based on the date and time the replies are received. The date and time format is YYYY-MM-DD HH:MM:SS. Must be URL encoded.
* order_type: specifies in which order the results are listed. Value is either "DESC" or "ASC", which means in descending or ascending order respectively.
* search_limit: imposes a limit on the number of list results. Value is either a number or two numbers split by a comma. For example, "5" means the first five results will be returned; if value is "5,10", the function will return the results that are sequenced from the 5th to the 10th.

RETURN DATA

The response contains the following attributes:
* mcp_inbound_id: ID of the inbound message.
* mcp_channeltype_id: channel type.
* sender: where the message appears to come from.
* recipient: the recipient that the message is sent to.
* contact_name: name of the sender.
* content: the message content.
* inbound_dt: the date and time the message is received by MCP.

ROLE PERMITTED

Manager

EXAMPLES

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

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

Response:
<result tftype='1' infotype='0'>
    <resultset name='mcp_inbound' search_found_rows='2'>
        <row>
            <field name='mcp_inbound_id'>258</field>
            <field name='mcp_channeltype_id'>sms</field>
            <field name='sender'>61411111111</field>
            <field name='recipient'>61419262701</field>
            <field name='contact_name'>stephen</field>
            <field name='content'>TestSecondReply</field>
            <field name='inbound_dt'>2013-09-19 09:42:03</field>
        </row>
        ...
        ...
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

LIST_BROADCAST_TALKS

Mweb v2.0 YVNTECH 2014