MAPI Manual

NAME

START_BROADCAST

FUNCTION

Start a broadcast

SYNOPSIS

broadcast_id, start_mode

DESCRIPTION

This function allows users to start a broadcast. A broadcast can be started if it is in any of the following statuses: "pause", "draft", "draftonly" or "starting".

Note: When starting a broadcast that has the "draftonly" status, the system first makes a copy of this broadcast and assigns the next available ID to this copy. Then it starts this copy, leaving the status of the original one unchanged. Related functions, such as PAUSE_BROADCAST, STOP_BROADCAST and LIST_BROADCAST_REPLIES, should use this copy's ID.

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

Optional Parameters
* start_mode: value is either "NORMAL_MODE" or "EXPRESS_MODE". Default is NORMAL_MODE. EXPRESS_MODE will set broadcast end_date to current_datetime + 5 days.


RETURN DATA

The response contains the following attribute:
* msg: Success or error message.

ROLE PERMITTED

Manager

EXAMPLES

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

Request:

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

Response:

<result tftype='1' infotype='0'>
    <field name='msg'>SUCCESS</field>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

ADD_BROADCAST_EXPRESS, ADD_BROADCAST_EXPRESS_START

Mweb v2.0 YVNTECH 2014