MAPI Manual

NAME

COPY_UPDATE_BROADCAST_EXPRESS

FUNCTION

Copy a broadcast and update it by express mode

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 copy a broadcast and then update this copy by express mode.

Required Parameters
* action: COPY_UPDATE_BROADCAST_EXPRESS.
* broadcast_id: the unique identifier of the broadcast.
* broadcast_title: title of the broadcast.

* broadcast_status: status of the broadcast. Below is a list of available statuses:

  • draftonly: the broadcast draft will be saved.
  • draft: the broadcast draft will be deleted once it has been sent.
* dialogmap_template_id: template ID.
* dialogmap_template_stencil_id: stencil ID.

Optional Parameters

* 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". Note: Only include the fields that need to be updated within this value. For more information about the xlabels within a stencil, see ADD_BROADCAST_EXPRESS.
* 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

The response contains the following attributes:

* infotype: status code.

  • 0: Success,
  • 1: Failure.
* mcp_broadcast_id: ID of the broadcast copy.

ROLE PERMITTED

Manager

EXAMPLES

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

Request:

http://app02.yvntech.com/MapIHttpS/MapIS?action=COPY_UPDATE_BROADCAST_EXPRESS&broadcast_id=730&broadcast_title=Copy%20of%20Customer%20rate%20service%20sample&broadcast_status=draftonly&dialogmap_template_id=3&dialogmap_template_stencil_id=1&xlabel_xml=%3Cfield%20xlabel_id%3D%273%27%3EPlease%20rate%20our%20service.%20Thanks.%3C%2Ffield%3E&login_name=user@example.com&login_passwd=1111


Response:

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

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

ADD_BROADCAST_EXPRESS, UPDATE_BROADCAST_EXPRESS, COPY_UPDATE_BROADCAST_EXPRESS_START

Mweb v2.0 YVNTECH 2014