//[[:start|Home]]//

~~NOTOC~~

====== RESTful API ======

Welcome to the RESTful API documentation site, before you start note that this API integrates two engines (Onmichannel and Campaign Manager) and you need the correct credentials to access both. If you aren't sure you have the correct credentials please contact your representative, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login.

//Methods starting with an asterisk **(*)** don't need that verification as long as you have an active Campaign Manager account.//

<WRAP group>

<WRAP half column>

===== SMS =====
<WRAP indent>
=== MT === 

[[restapi:sms#send_sms_campaign_manager|*Send SMS (Campaign Manager)]]

=== MO ===

[[restapi:sms#fire_message|*Fire Message]]

[[restapi:two_way_message|*Two Way Message]]

=== Lists ===

[[restapi:lists_distribution_lists_3_35|*List Distribution Lists]]

[[restapi:create_segmented_distribution_list_custom_key_3_35|*Create Segmented Distribution List With Custom Key]]

[[restapi:edit_segmented_distribution_list_3_36|*Edit Segmented Distribution List]]

[[restapi:get_distribution_list|*Get list subscribers (Paginated)]]

=== Blasting ===

[[restapi:lists_broadcasts_3_35|*List Broadcasts]]

[[restapi:list_instance_codes_3_35|*List Instance Codes]]

[[restapi:create_broadcast_by_distribution_list_3_35|*Create Broadcast By Distribution List]]

[[restapi:edit_broadcast_by_distribution_list_3_35|*Edit Broadcast By Distribution List]]

[[restapi:create_personalized_broadcast_3_35|*Create Personalized Broadcast]]

[[restapi:edit_personalized_broadcast_3_35|*Edit Personalized Broadcast]]

[[restapi:create_broadcast_by_file_3_35|*Create Broadcast By File]]

[[restapi:edit_broadcast_by_file_3_35|*Edit Broadcast By File]]

[[restapi:broadcasts#create_or_edit_broadcast_from_json|*Create or Edit Broadcast From JSON]]

[[restapi:broadcasts#get_broadcast|*Broadcast Detail]]

[[restapi:broadcasts#suspend_broadcast|*Suspend Broadcast]]

[[restapi:broadcasts#resume_broadcast|*Resume Broadcast]]

[[restapi:broadcasts#stop_broadcast|*Stop Broadcast]]

[[restapi:broadcasts#delete_broadcast|*Delete Broadcast]]

</WRAP>

===== Blacklist =====
<WRAP indent>

[[restapi:blacklist#is_user_in_blacklist|User Blacklisted]]

[[restapi:blacklist#add_user_to_black_list|Add User to black list]]

[[restapi:blacklist#remove_user_from_black_list|Remove User from Blacklist]]

</WRAP>

===== Reports =====
<WRAP indent>

[[restapi:report#message_report|Message Report]]

[[restapi:report#blast_report|Blast Report]]

[[restapi:report#scratch_card_report|Scratch Cards Report]]

[[restapi:report#urls_redirect_s_report|URLs redirect's report]]

[[restapi:weekly_campaign_report_3_35|*Weekly Campaign Report]]

[[restapi:reports#weekly_global_report|*Weekly Global Report]]

[[restapi:reports#product_report|*Product Report]]

[[restapi:reports#mt_report|*MT Report]]

[[restapi:reports#mt_report_with_filters|*MT Report With Filters]]

[[restapi:reports#multiple_choice_statistics_report|*Multiple Choice Statistics Report]]

[[restapi:reports#list_message_report|*List Message Report]]

[[restapi:reports#list_messages_by_code_report|*List Messages by Code Report]]

</WRAP>

===== Geo-Location =====
<WRAP indent>
[[restapi:sending_geo_push_3_35|Sending Geo Push]]

[[restapi:geo#request_device_location|Request Device Location]]

[[restapi:send_location_3_35|Send Location]]

[[restapi:geo#checking_device_location_by_coordinates|Checking Device Location by Coordinates]]

[[restapi:geo#create_geo-fence|Create Geo-Fence]]

[[restapi:geo#notify_region_event|Notify Region Event]]

[[restapi:geo#remove_geo-fence|Remove Geo-fence]]

[[restapi:geo#retrieving_geo-fence|Retrieving Geo-fence]]

[[restapi:geo#retrieving_geo-fence_paginated|Retrieving Geo-fence paginated]]

[[restapi:geo#retrieve_geo-fence_by_id|Retrieve Geo-fence By Id]]

[[restapi:geo#update_geo-fence|Update Geo-fence]]

</WRAP>


===== Wallet =====
<WRAP indent>

[[restapi:wallet#Overview]]

[[restapi:wallet#Lifecycle of Wallet campaigns in API]]

[[restapi:wallet#Get organization name]]

[[restapi:wallet#Get wallet image file]]

[[restapi:wallet#Store image file for Wallet]]

[[restapi:wallet#Create Wallet Template]]

[[restapi:wallet#Get Wallet Templates list]]

[[restapi:wallet#Delete Wallet Template]]

[[restapi:wallet#Get Wallet Template]]

[[restapi:wallet#Update Wallet template]]

[[restapi:wallet#Get Wallet URL list]]

[[restapi:wallet#Set template-to-data attribute matches]]

[[restapi:wallet#Register Wallet Broadcast]]

[[restapi:wallet#Get Wallet broadcasts]]

[[restapi:wallet#Wallet passes Delivery]]

[[restapi:wallet#Send massive push updates for passes]]

[[restapi:wallet#Send single pass push update]]

[[restapi:wallet#Register Device for Wallet updates]]

[[restapi:wallet#Register Device for PassWallet updates]]

[[restapi:wallet#Send New Pass to Wallet apps]]

[[restapi:wallet#Get changed passes list]]

[[restapi:wallet#Remove Wallet Registration]]

[[restapi:wallet#Logging errors from device to server]]

</WRAP>


</WRAP>

<WRAP half column>

===== Email =====
<WRAP indent>
[[restapi:email#send_email|Send Email]]

[[restapi:email#email_blast_by_file|Email's Blast by File]]

[[restapi:email#email_blast_by_list|Email's Blast by List]]

[[restapi:email#email_blast_by_list_with_custom_key|Email's Blast by List With Custom Key]]

[[restapi:email#email_blast_by_list_with_from_field|Email Blast by List With From Field]]

[[restapi:create_email_list_3_35#create_email_list|*Create Email List]]

[[restapi:add_user_to_email_list_3_35|*Add User to Email List]]

[[restapi:remove_user_from_email_list_3_35|*Remove User From Email List]]

[[restapi:delete_email_list_3_35#delete_email_list|*Delete Email List]]

[[restapi:create_email_list_3_35#get_email_list|*Get Email List]]
</WRAP>

===== Scratch Cards =====
<WRAP indent>

=== Cards ===

[[restapi:scratchcard#creating_a_scratch_card|Creating a Scratch Card]]

[[restapi:scratchcard#edit_a_scratch_card|Edit a Scratch Card]]

[[restapi:scratchcard#delete_scratch_card_by_id|Delete Scratch Card by Id]]

[[restapi:scratchcard#retrieve_a_scratch_card_by_id|Retrieve a Scratch Card by Id]]

[[restapi:scratchcard#retrieving_scratch_cards|Retrieving Scratch Cards]]

=== Smart URL ===

[[restapi:send_a_smart_url_3_35|Send a Smart URL]]

[[restapi:smarturl#blast_a_smart_url|Blast a Smart URL]]

[[restapi:smarturl#activate_a_smart_url|Activate a Smart URL]]

[[restapi:smarturl#deactivate_a_smart_url|Deactivate a Smart URL]]

[[restapi:smarturl#retrieve_a_smart_url_by_id|Retrieve a Smart URL by Id]]

[[restapi:smarturl#execute_a_smart_url_redirection|Executing a Smart URL Redirection]]
</WRAP>

===== Push Notifications =====
<WRAP indent>

=== Registration ===

[[restapi:push_registration#android_app_registration|Android App Registration]]

[[restapi:push_registration#android_device_registration|Android Device Registration]]

[[restapi:push_registration#ios_app_registration|iOS App Registration]]

[[restapi:push_registration#ios_device_registration|iOS Device Registration]]

[[restapi:push_registration#mobile_registration|Mobile Registration]]

[[restapi:push_registration#mobileactivation|Mobile Activation]]

=== Sending ===

[[restapi:push_send#sending_push_to_phone|Sending Push to Phone]]

[[restapi:push_send#sending_push_to_phone_ianpp|Sending Push to Phone (inapp)]]

[[restapi:push_send#sending_push_to_phone_by_file|Sending Push to Phone By File]]

[[restapi:push_send#sending_push_to_phone_by_file_inapp|Sending Push to Phone By File (inapp)]] 

[[restapi:push_send#sending_push_to_app|Sending Push to App]]

[[restapi:push_send#send_response|Send Response]]

=== Retrieving ===

[[restapi:push_retrieve#retrieving_pending_push_messages|Retrieving Pending Push Messages]]

[[restapi:push_retrieve#retrieving_application_s_users|Retrieving Application's users]]
</WRAP>



===== Appendix =====
<WRAP indent>

[[restapi:appx_base_url#base_url|Base URL]]

[[restapi:appx_ciphering#ciphering_data|Ciphering Data]]

[[restapi:appx_call_ex#java_example_call|API REST call example]]

[[restapi:appx_resp_xml#the_response_xml|Response XML - Basics]]

[[restapi:appx_msg_status|Message's Status]]

[[restapi:appx_date|Date Format Pattern Letters]]

[[restapi:appx_phonelist|Phone List Guidelines]]

[[restapi:appx_wb_list#restriction_list_file_format|Restriction List File Format]]

[[restapi:appx_callbacks|Client's Callback URL]]

[[restapi:appx_rules|The RULE parameter]]

[[restapi:appx_geoline_search|Geo-Fence Inline Search String]]

[[restapi:appx_mo_search|MO Inline Search String]]

[[restapi:appx_mt_search|MT Inline Search String]]

[[restapi:appx_url_search|URL Inline Search String]]

[[restapi:appx_sc_search|Scratch Card Search String]]

[[restapi:appx_rl_search|Restriction List Search String]]

[[restapi:appx_blast_search|Blast Inline Search String]]

[[restapi:appx_sc_templates|Scratch Card Templates]]

[[restapi:appx_broadcast|Broadcast Types and Status]]

[[sdk:android|Android SDK]]

[[sdk:ios|iOS SDK]]

[[sdk:push_types|PUSH types]]

[[restapi:appx_c_types|Campaign Types]]

[[restapi:campaign_json|Campaign Descriptor]]

</WRAP>
</WRAP>

</WRAP>

<WRAP clear></WRAP>

//Read all information in [[restapi:allinone|one]] single page//