MAPI Manual

NAME

GET_BROADCAST_SIMPLE

FUNCTION

Get the details of a broadcast by simple mode

SYNOPSIS

action: GET_BROADCAST_SIMPLE
broadcast_id

login_name
login_passwd 
or 
login_name 
session_id 
or 
device_id

DESCRIPTION

This function allows users to get the details of a broadcast created by simple mode. Both GET and POST methods can be used to perform the request.

Required Parameters
* action: specifies the requested function. Sets to GET_BROADCAST_SIMPLE.
* broadcast_id: broadcast ID.

* login_name: the login name for authenticating the user.
* login_passwd: the login password for authenticating the user.
or
* login_name: the login name for authenticating the user.
* session_id: the session ID for authenticating the user.
or
* device_id: a unique ID of the device. The system can use it as a key to identify users. 

RETURN DATA

For each valid request, the server provides a response in XML format.
The response contains the following attributes:
* broadcast_title: title of the broadcast.
* status: current status of the broadcast. Given below is a list of status: 'draft','stop','start','delete','complete','sent','starting','starting_error','pause','draftonly'.
* contactgroup_id: ID of the contact group that the broadcast is delivered to.
* contactgroup_name: name of the contact group.
* channel_type: type of the channel through which the broadcast is delivered.
* begin_dt: start date of the time frame.
* end_dt: end date of the time frame.
* whentosend: specifies when the broadcast will be started.
* msg: the broadcast message.

For an invalid request, the response XML contains the following attribute:
* msg: a string containing the 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=GET_BROADCAST_SIMPLE&broadcast_id=439&device_id=mytestid

Response:
<result tftype='1' infotype='0'>
    <field name='broadcast_title'>manlySMS</field>
    <field name='status'>stop</field>
    <field name='contactgroup_id'>152</field>
    <field name='contactgroup_name'>team 3</field>
    <field name='channel_type'>sms</field>
    <field name='begin_dt'>0000-00-00 00:00:00</field>
    <field name='end_dt'>2030-01-01 00:00:01</field>
    <field name='whentosend'>2013-09-24 10:22:01</field>
    <field name='msg'>HelloYVN</field>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

GET_BROADCAST_EXPRESS, ADD_BROADCAST_SIMPLE

Mweb v2.0 YVNTECH 2014