MAPI Manual

NAME

GET_BROADCAST_EXPRESS

FUNCTION

Get a broadcast by express mode

SYNOPSIS

broadcast_id

DESCRIPTION

This function allows users to get the details of a broadcast.

Required Parameters

* action: GET_BROADCAST_EXPRESS.
* broadcast_id: ID of the broadcast.

RETURN DATA

The response contains the following attributes:
* mcp_broadcast_id: broadcast ID.
* broadcast_title: title of the broadcast.
* broadcast_description: description of the broadcast.
* broadcast_rate: specifies the number of broadcasts sent per minute.
* broadcast_priority: a number specifying the priority of the broadcast.
* begin_dt: the start time of the broadcast.
* end_dt: the end time of the broadcast.
* tz_abbr_forschedule: time zone of the schedule.
* mcp_schedule_id: specifies the schedule for the broadcast.
* mcp_acl_id: ID of the access control list.
* completedcondition_type: value is "MCPTYPE_NOTASK" or "MCPTYPE_ENDDATE".
* mcp_integration_partner_id: integration partner ID.
* mcp_integration_broadcast_id: the custom field the broadcast is associated with.
* status: status of the broadcast.
* status_dt: timestamp of the status.
* mcp_dialogmap_template_id: ID of the dialog map template.
* mcp_dialogmap_template_stencil_id: ID of the template stencil.
* mcp_dialogmap_template_stencil: contains a list of fields within the broadcast.

ROLE PERMITTED

Manager

EXAMPLES

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

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

Response:
<result tftype='1' infotype='0'>
    <resultset name="mcp_broadcast">
        <row>
            <field name="mcp_broadcast_id">729</field>
            <field name="broadcast_title">Customer rate service sample</field>
            <field name="broadcast_description">2014-08-26 10:09:39</field>
            <field name="broadcast_rate">0</field>
            <field name="broadcast_priority">0</field>
            <field name="begin_dt">1970-01-02 00:00:01</field>
            <field name="end_dt">2014-08-31 10:09:39</field>
            <field name="tz_abbr_forschedule">TZ89</field>
            <field name="mcp_schedule_id">1</field>
            <field name="mcp_acl_id">0</field>
            <field name="completedcondition_type">MCPTYPE_NOTASK</field>
            <field name="mcp_integration_partner_id">0</field>
            <field name="mcp_integration_broadcast_id" />
            <field name="status">draftonly</field>
            <field name="status_dt">2014-08-26 10:09:39</field>
        </row>
    </resultset>
    <resultset name="mcp_dialogmap">
        <row>
            <field name="mcp_dialogmap_template_id">3</field>
            <field name="mcp_dialogmap_template_stencil_id">1</field>
            <resultset name="mcp_dialogmap_template_stencil">
                <row>
                    <field value_title="demo group " xlabel_id="1">164</field>
                    <field value_title="mobile" xlabel_id="2">2</field>
                    <field xlabel_id="3">Hi [%name%], please rate our service.</field>
                    <field xlabel_id="4">0</field>
                    <field xlabel_id="21">+61412345678</field>
                    <field xlabel_id="22">Hi manager, customer has rated us 1.</field>
                    <field xlabel_id="32">Thanks for rating 2.</field>
                    <field xlabel_id="42">Thanks for rating 5.</field>
                    <field xlabel_id="52">Can you provide comments?</field>
                    <field value_title="email" xlabel_id="61">3</field>
                    <field xlabel_id="62">Thanks for rating 5 via email.</field>
                    <field xlabel_id="71">Hi manager, customer said [%reply_content%].</field>
                    <field xlabel_id="72">+61412345678</field>
                </row>
            </resultset>
        </row>
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

GET_BROADCAST_SIMPLE, ADD_BROADCAST_EXPRESS

Mweb v2.0 YVNTECH 2014