MAPI Manual

NAME

SAVE_BROADCAST_EXPRESS_START

FUNCTION

Save broadcast by express mode, and then start broadcast

SYNOPSIS

broadcast_id, broadcast_title, broadcast_status, dialogmap_template_id, dialogmap_template_stencil_id, xlabel_xml, broadcast_description, broadcast_rate, broadcast_priority, begin_dt, end_dt, tz_abbr_forschedule, mcp_schedule_id, mcp_acl_id, completedcondition_type, mcp_integration_partner_id, mcp_integration_broadcast_id

DESCRIPTION

This function allows users to update an existing broadcast or create a new one if not exists, and then start this broadcast. If the ID of an existing broadcast is provided, the broadcast will be updated; otherwise, a new broadcast will be created.


Required Parameters

* action: SAVE_BROADCAST_EXPRESS_START.
* broadcast_title: title of the broadcast.
* broadcast_status: status of the broadcast. Below is a list of available statuses: 'draft','stop','start','delete','complete','sent','starting','starting_error','pause','draftonly'.  
* dialogmap_template_id: template ID. For more information about templates, see LIST_DIALOGMAP_TEMPLATES.
* dialogmap_template_stencil_id: stencil ID. For more information about stencils, see LIST_DIALOGMAP_TEMPLATE_STENCILS.
* xlabel_xml: specifies values for the fields of the broadcast. The fields of the broadcast are represented in the form of numbered xlabels. This entire value must be URL encoded. For example, value is "<field xlabel_id='1'>Please rate our service.</field><field xlabel_id='2'>+61411111111</field>"; after encoding, the result is "%3Cfield%20xlabel_id%3D%271%27%3EPlease%20rate%20our%20service.%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%272%27%3E%2B61411111111%3C%2Ffield%3E". For more information about the xlabels within a stencil, see GET_DIALOGMAP_TEMPLATE_STENCIL.

Optional Parameters

* broadcast_id: ID of the broadcast that needs to be updated.
* broadcast_description: description of the broadcast. Default is the broadcast title.
* broadcast_rate: specifies the number of broadcasts sent per minute. Default is 0, which means sending as soon as possible.
* broadcast_priority: a number specifying the priority of the broadcast. Broadcasts with a high priority will be sent first.
* begin_dt: the start time of the broadcast. The date and time format is YYYY-MM-DD HH:MM:SS. Must be URL encoded.
* end_dt: the end time of the broadcast. The date and time format is YYYY-MM-DD HH:MM:SS. Must be URL encoded. Default is current time + 5 days.
* tz_abbr_forschedule: time zone of the schedule. Default is the time zone of the user who created the broadcast.
* mcp_schedule_id: specifies the schedule for the broadcast. Default is sending at any time.
* mcp_acl_id: ID of the access control list.
* completedcondition_type: value is "MCPTYPE_NOTASK" or "MCPTYPE_ENDDATE". If the broadcast need to be sent to the newly added contacts, this value must be MCPTYPE_ENDDATE.
* mcp_integration_partner_id: integration partner ID.
* mcp_integration_broadcast_id: custom field which you can store an ID that is associated with the broadcast. This value can be returned to users when needed. It can include characters and numbers.

RETURN DATA

On successful update of the broadcast, the response contains the following attribute:

* msg: Success or error message.


On successful creation of a new broadcast, the response contains the following attribute:

* mcp_broadcast_id: ID of the newly created broadcast.

ROLE PERMITTED

Manager

EXAMPLES

The following example shows a successful HTTP GET request and response. It creates a new broadcast since broadcast ID is not given in the request, and then starts the broadcast.

Request:

http://app02.yvntech.com/MapIHttpS/MapIS?action=SAVE_BROADCAST_EXPRESS_START&broadcast_title=Customer%20rate%20service%20sample&broadcast_status=draftonly&dialogmap_template_id=3&dialogmap_template_stencil_id=1&xlabel_xml=%3Cfield%20xlabel_id%3D%271%27%3E164%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%272%27%3E2%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%273%27%3EHi%20%5B%25name%25%5D%2C%20please%20rate%20our%20service.%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%274%27%3E0%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2721%27%3E%2B61412345678%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2722%27%3EHi%20manager%2C%20customer%20has%20rated%20us%201.%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2732%27%3EThanks%20for%20rating%20us%202%2C3%20and%204.%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2742%27%3EThanks%20for%20rating%205.%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2752%27%3ECan%20you%20provide%20further%20comments%3F%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2761%27%3E3%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2762%27%3EThanks%20for%20rating%20us%205.%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2771%27%3EHi%20manager%2C%20customer%20said%20%5B%25reply_content%25%5D.%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2772%27%3E%2B61412345678%3C%2Ffield%3E&login_name=user@example.com&login_passwd=1111

Response:

<result tftype='1' infotype='0'>
    <field name='mcp_broadcast_id'>996</field>
</result>




The following example finds the broadcast ID and updates this broadcast, then starts it.



Request:

http://app02.yvntech.com/MapIHttpS/MapIS?action=SAVE_BROADCAST_EXPRESS_START&broadcast_id=996&broadcast_title=Updated%20customer%20rate%20service%20sample&broadcast_status=draftonly&dialogmap_template_id=3&dialogmap_template_stencil_id=1&xlabel_xml=%3Cfield%20xlabel_id%3D%271%27%3E164%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%272%27%3E2%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%273%27%3EHi%20%5B%25name%25%5D%2C%20please%20rate%20our%20service.%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%274%27%3E0%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2721%27%3E%2B61412345678%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2722%27%3EHi%20manager%2C%20customer%20has%20rated%20us%201.%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2732%27%3EThanks%20for%20rating%20us%202%2C3%20and%204.%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2742%27%3EThanks%20for%20rating%205.%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2752%27%3ECan%20you%20provide%20further%20comments%3F%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2761%27%3E3%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2762%27%3EThanks%20for%20rating%20us%205.%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2771%27%3EHi%20manager%2C%20customer%20said%20%5B%25reply_content%25%5D.%3C%2Ffield%3E%3Cfield%20xlabel_id%3D%2772%27%3E%2B61412345678%3C%2Ffield%3E&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

SAVE_BROADCAST_EXPRESS, START_BROADCAST, ADD_BROADCAST_EXPRESS

Mweb v2.0 YVNTECH 2014