MAPI Manual

NAME

ADD_BROADCAST_EXPRESS_START

FUNCTION

Add a broadcast and start it

SYNOPSIS

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 add a broadcast and start it.

Required Parameters
* action: ADD_BROADCAST_EXPRESS_START.
* broadcast_title: title of the broadcast.

* broadcast_status: specifies whether the draft will be saved when the broadcast is started. If value is "draftonly", the draft will be saved; otherwise, the draft will be deleted.

* 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, click here .

Optional Parameters
* 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.



Note: The details of xlabels for a stencil can be retrieved via GET_DIALOGMAP_TEMPLATE_STENCIL. The following screenshots explain the result returned from the API request.





Below are the xlabels for existing stencils of dialog maps:

Note: Smart Content can be inserted into the Node content in the following tables. Please visit this page to learn more.

Ask Customer Rate Service

Dialog map template ID

3

Dialog map stencil ID

1

xlabel id group

1,2,3,4,21,22,32,42,52,61,62,71,72

xlabel_id_list

1_25,2_22,3_10001,4_22,21_1,22_1,32_1,42_1,52_1,61_22,62_1,71_10001,72_1

xlabel1

NODE 1 contact group ID

xlabel2

NODE 1 destination column ID

xlabel3

NODE 1 content. Include the column name within [%%] to show the value of the column. For example, [%name%] shows the value of the name column. For a list of Smart Content that can be included within this node, please visit this page.

xlabel4

Broadcast new added contact? Boolean value: 0 means No, 1 means Yes.

xlabel21

NODE 2 manager mobile number. The number needs to be prefixed with + and country code. Eg, +61412345678.

xlabel22

NODE 2 content, e.g., Send message to Manager, customer rate 1.

xlabel32

NODE 3 content, e.g., Customer rate 2,3,4, then sms thanks to them.

xlabel42

NODE 4 content, e.g., Customer rate 5, sms thanks to customer.

xlabel52

NODE 5 content, e.g., Customer replied 1, say sorry to customer and ask for comment.

xlabel61

NODE 6 destination column ID

xlabel62

NODE 6 content, e.g., Say thanks to customer who rate 5 by email.

xlabel71

NODE 7 content. Include [%reply_content%] to show the customer replied comment. For a list of Smart Content that can be included within this node, please visit this page.

xlabel72

NODE 7 manager mobile number.  The number needs to be prefixed with + and country codeEg, +61412345678.


Find a Worker

Dialog map template ID

4

Dialog map stencil ID

1


xlabel id group

1,2,3,32,52,62,71,72,83,91,92

xlabel_id_list

1_25,2_22,3_10001,32_1,52_1,62_1,71_22,72_1,83_10001,91_1,92_10001

xlabel1

NODE 1 contact group ID

xlabel2

NODE 1 destination column ID

xlabel3

NODE 1 content. Include the column name within [%%] to show the value of the column. For example, [%name%] shows the value of the name column. For a list of Smart Content that can be included within this node, please visit this page.

xlabel32

NODE 3 content, e.g., Say thanks to worker who replied not available.

xlabel52

NODE 5 content, e.g., Job was taken,say sorry to worker reply yes.

xlabel62

NODE 6 content, e.g., Let replyer know he has the job.

xlabel71

NODE 7 destination column ID

xlabel72

NODE 7 content, e.g., Email job description to worker.

xlabel83

NODE 8 content. Include the column name within [%%] to show the value of the column. For example, [%name%] shows the value of the name column. For a list of Smart Content that can be included within this node, please visit this page.

xlabel91

NODE 9 manager mobile number. The number needs to be prefixed with + and country codeEg, +61412345678.

xlabel92

NODE 9 content. Include f581f to show the job taker’s name. For a list of Smart Content that can be included within this node, please visit this page.


Appointment Reminder

Dialog map template ID

5

Dialog map stencil ID

1

xlabel id group

1,2,3,4,5,6,7,17,18,20,21

xlabel_id_list

1_1,2_1,3_1,4_25,5_22,6_22,7_3,17_22,18_22,20_10001,21_22

xlabel1

Map title, e.g., express map name.

xlabel2

Taskfunc name, e.g., express task name.

xlabel3

Recipient type. Value is 12.

xlabel4

Contact group ID

xlabel5

Due date column ID

xlabel6

Remind days before due date. Value is a number prefixed with a minus sign(-). The number is in the range of 1 to 7(inclusive). For example, -3 means three days before.

xlabel7

Remind Time. Time is expressed in 24-hour format. The time format is hh:mm:ss, e.g., 13:50:00.

xlabel17

Channel type. Value is sms or email.

xlabel18

Destination field column ID

xlabel20

Message content. Include the column name within [%%] to show the value of the column. For example, [%name%] shows the value of the name column. For a list of Smart Content that can be included within this message, please visit this page.

xlabel21

Broadcast new added contact? Boolean value: 0 means No, 1 means Yes.


Partner Send Sms

Dialog map template ID

101

Dialog map stencil ID

1

xlabel id group

1,2,3,5,9,22,32

xlabel_id_list

1_25,2_22,3_10001,5_22,9_4,22_10001,32_10001

xlabel1

Customer contact group ID

xlabel2

Mobile column ID

xlabel3

Message. Include the column name within [%%] to show the value of the column. For example, [%name%] shows the value of the name column. For a list of Smart Content that can be included within this message, please visit this page.

xlabel5

Broadcast new added contact? Boolean value: 0 means No, 1 means Yes.

xlabel9

End Date. Time is expressed in 24-hour format. The date and time format is yyyy-mm-dd hh:mm:ss, e.g., 2014-09-01 13:50:00.

xlabel22

Set parameters to inform partner send sms success. Include the column name within [%%] to show the value of the column. For example, [%name%] shows the value of the name column. For a list of Smart Content that can be included within this node, please visit this page.

xlabel32

Set parameters to inform partner got replied message. Include the column name within [%%] to show the value of the column. For example, [%name%] shows the value of the name column. For a list of Smart Content that can be included within this node, please visit this page.



Sms Regularly

Dialog map template ID

51

Dialog map stencil ID

1

xlabel id group

1,2,3,7,20,23,33,43,53,63,73,203

xlabel_id_list

1_25,2_22,3_10001,7_22,20_22,23_10001,33_10001,43_10001,53_10001,63_10001,73_10001,203_10001

xlabel1

NODE 1 contact group ID

xlabel2

NODE 1 destination column ID

xlabel3

NODE 1 content. Include the column name within [%%] to show the value of the column. For example, [%name%] shows the value of the name column. For a list of Smart Content that can be included within this node, please visit this page.

xlabel7

Broadcast new added contact? Boolean value: 0 means No, 1 means Yes.

xlabel20

Time interval between Nodes. Time is expressed in seconds, e.g., 300 represents 5 minutes.

xlabel23

NODE 2 content. Include the column name within [%%] to show the value of the column. For example, [%name%] shows the value of the name column. For a list of Smart Content that can be included within this node, please visit this page.

xlabel33

NODE 3 content. As above.

xlabel43

NODE 4 content. As above.

xlabel53

NODE 5 content. As above.

xlabel63

NODE 6 content. As above.

xlabel73

NODE 7 content. As above.

xlabel203

Reply Content. As above.


RETURN DATA

The response contains the following attribute:
* msg: indicates the broadcast has been created and started successfully.

ROLE PERMITTED

Manager

EXAMPLES

The following shows an example request and response.


Request:

http://app02.yvntech.com/MapIHttpS/MapIS?action=ADD_BROADCAST_EXPRESS_START&broadcast_title=Customer%20rate%20service%20sample%20start&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%2B61411111111%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%2B61411111111%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

ADD_BROADCAST_EXPRESS, START_BROADCAST

Mweb v2.0 YVNTECH 2014