This API sends stored content from a specified account using an MMSID to a single mobile number.
FROM must be one of the shortcodes allowed for your account. In case the number is from a different country than the FROM shortcode is assigned to, the default shortcode for those countries will be used.
When MMS is sent as SMS, the fallback SMS text and link are sent.
You can dynamically send custom text for each slide by setting up the CUSTOMTEXT node (CUSTOMTEXT must include mandatory fields: value and slide) and the MMS Subject by setting up the CUSTOMSUBJECT node. Line breaks are supported in the custom slide texts of the MMS.
If “Enforce Campaign Check” is turned ON, then this function will require the campaign reference ID of the messaging campaign that the recipient’s phone number is subscribed into to be passed inside the campaignref node.
Every binary MMS we deliver can be transcoded for the destination handset and every web page we deliver is transcoded for the browsing handset. To transcode a binary MMS we must know what type of handset the user has. We are able to obtain this handset type information from delivery receipts and store the record in a handset cache for later use. We have a database of attributes which we manually match to every new handset in the cache so we can adapt the content during MMS delivery.
This API also supports sending MMS with a Passbook Pass. The pass can be sent as a link by passing ‘yes’ to the FORCEPASSASLINK node.
This API also supports sending MMS with embedded Personalized Images. For this, you have to create a Personalized Image Template with merge tag vars in your account and add that to your MMS ID slide on the MMS Composer. You can send the personalized data for this template in the DATA node. Look at the request below to understand. Some additional notes:
This API also supports sending MMS with embedded Dynamic vCard. The custom Dynamic vCard data can be supplied in the API. Look at the request below to understand. Some additional notes:
<REQUEST> <ACTION>sendSavedMMS</ACTION> <API_KEY>apiKey</API_KEY> <MMSID>MMSID</MMSID> <TO>Number</TO> <FROM>Shortcode</FROM> <FROM_MASK>*shortcodeMask</FROM_MASK> <OPERATORID>OPERATORID</OPERATORID> <CAMPAIGNREF>CampaignReferenceID</CAMPAIGNREF> <FALLBACKSMSTEXT>This text replaces the MMS subject when MMS is sent as SMS link</FALLBACKSMSTEXT> <DISABLEFALLBACKSMS>'yes' to disable fallback SMS</DISABLEFALLBACKSMS> <DISABLEFALLBACKSMSLINK>'yes' to disable fallback SMS link</DISABLEFALLBACKSMSLINK> <CUSTOMTEXT> <VALUE>Custom Text for slide</VALUE> <SLIDE>Slide ID</SLIDE> </CUSTOMTEXT> <CUSTOMSUBJECT>MMS Custom Subject</CUSTOMSUBJECT> <DATA> <BARCODEID>Barcode ID</BARCODE> <FIRSTNAME>First Name</FIRSTNAME> <LASTNAME>Last Name</LASTNAME> <GENDER>Gender</GENDER> ... </DATA> <DYNAMICVCARD> <NAME> <FIRSTNAME>First Name</FIRSTNAME> <LASTNAME>Last Name</LASTNAME> <SUFFIX>Suffix Name</SUFFIX> </NAME> <ORGANIZATION>Organization Name</ORGANIZATION> <TITLE>Organization Title</TITLE> <PHOTOURL>Photo URL</PHOTOURL> <NOTE>Contact Note</NOTE> <PHONE> <NUMBER>Phone Number 1</NUMBER> <LABEL>Phone Label 1 (e.g. 'work' or 'home')</LABEL> </PHONE> <PHONE> <NUMBER>Phone Number 2</NUMBER> <LABEL>Phone Label 2 (e.g. 'work' or 'home')</LABEL> </PHONE> <EMAIL> <ID>Email Address</ID> <LABEL>Email Address Label (e.g. 'work' or 'home')</LABEL> </EMAIL> <PHYSICALADDRESS> <ADDRESS>Physical Address</ADDRESS> <LABEL>Physical Address Label (e.g. 'work' or 'home')</LABEL> </PHYSICALADDRESS> </DYNAMICVCARD> </REQUEST> *ShortcodeMask (Alphanumeric sender) is allowed only in few countries. Not supported in the United States.
API_URL?action=sendsavedmms &api_key=API key &mmsid=MMSID &to=number &from=shortcode &from_mask=shortcode mask &operatorid=operator ID &campaignref=campaign reference ID &fallbacksmstext=this text replaces the MMS subject when MMS is sent as SMS link &disablefallbacksms='yes' to disable fallback SMS &disablefallbacksmslink='yes' to disable fallback SMS link &customtext_#=Custom Text for slide (replace '#' with slide number) &customsubject=MMS Custom Subject &data_first_name=first name &data_last_name=last name &data_age=age ... &forcepassaslink='yes' to force pass as link &di_bgimage=dynamic image: background image URL &di_barcodeid=dynamic image: barcode ID &di_textarea1=dynamic image: textarea text 1 &di_textarea2=dynamic image: textarea text 2 &di_textarea3=dynamic image: textarea text 3 &di_textarea4=dynamic image: textarea text 4 &di_textarea5=dynamic image: textarea text 5 &di_textarea6=dynamic image: textarea text 6 &di_textarea7=dynamic image: textarea text 7 &di_textarea8=dynamic image: textarea text 8 &di_savedata='yes' or 'no' to save the dynamic image data
Mandatory: action, api_key, mmsId, to, from, campaignRef (if "Enforce Campaign Check" IS enabled), di_barcodeid (if saved MMS includes a personalized image with barcode), firstname (if dynamicvcard is enabled), lastname (if dynamicvcard is enabled) Optional: campaignRef (if "Enforce Campaign Check" is NOT enabled), fallbackSmsText, disableFallbackSms, disableFallbackSmsLink, customText, customSubject, data, operatorid, forcepassaslink, di_barcodeid (if saved MMS does NOT include a personalized image with barcode), di_textarea#, di_bgimage, di_savedata, dynamicvcard, firstname (if dynamicvcard is NOT enabled), lastname (if dynamicvcard is NOT enabled) suffix, organization, title, photourl, note, phone_number_1, phone_label_1, phone_number_2, phone_label_2, email_id_1, email_label_1, physical_address_1, physical_address_label_1
status, to, from, mmsId, trackingId, errorCode, errorInfo
<REQUEST> <ACTION>sendSavedMMS</ACTION> <API_KEY>qTFkykO9JTfahCOqJ0V2Wf5Cg1t8iWlZ</API_KEY> <TO>16501234123</TO> <FROM>60856</FROM> <CAMPAIGNREF>Campaign123</CAMPAIGNREF> <MMSID>35674</MMSID> <FALLBACKSMSTEXT>Visit this link for more details</FALLBACKSMSTEXT> <CUSTOMTEXT> <VALUE>My Custom text in first slide\r\nAnd some more Custom text</VALUE> <SLIDE>1</SLIDE> </CUSTOMTEXT> <CUSTOMSUBJECT>My Custom Subject</CUSTOMSUBJECT> <DATA> <FIRST_NAME>John</FIRST_NAME> <LAST_NAME>Smith</LAST_NAME> <AGE>30</AGE> <PET>Dog</PET> </DATA> <DYNAMICIMAGE> <BACKGROUNDIMAGE>https://www.yourwebsite.com/images/backgroundimage.jpg</BACKGROUNDIMAGE> <BARCODEID>SKY-13332-433433</BARCODEID> <TEXTAREA1>Company-SKY</TEXTAREA1> <TEXTAREA2>Mr.XXXX</TEXTAREA2> <TEXTAREA3>Email:xxxx@yyyy.com</TEXTAREA3> <TEXTAREA4>Mobile:xxx-xxx-xxxx</TEXTAREA4> </DYNAMICIMAGE> <DYNAMICVCARD> <NAME> <FIRSTNAME>John</FIRSTNAME> <LASTNAME>Smith</LASTNAME> <SUFFIX>Jr.</SUFFIX> </NAME> <ORGANIZATION>My Organzation Name</ORGANIZATION> <TITLE>Agent</TITLE> <PHOTOURL>https://yourwebsite.com/contacts/photo1.png</PHOTOURL> <NOTE>My agent</NOTE> <PHONE> <NUMBER>(617) 314-7688</NUMBER> <LABEL>work</LABEL> </PHONE> <PHONE> <NUMBER>(617) 000-0000</NUMBER> <LABEL>home</LABEL> </PHONE> <EMAIL> <ID>johnsmith@yourorganzation.com</ID> <LABEL>work</LABEL> </EMAIL> <PHYSICALADDRESS> <ADDRESS>397 Moody St 202, Waltham, MA 02453-0461</ADDRESS> <LABEL>work</LABEL> </PHYSICALADDRESS> </DYNAMICVCARD> </REQUEST>
https://secure.skycore.com/API/wxml/1.3/index.php?action=sendsavedmms &api_key=qTFkykO9JTfahCOqJ0V2Wf5Cg1t8iWlZ &to=16501234123 &from=60856 &campaignref=Campaign123 &mmsid=35674 &fallbacksmstext=Visit+this+link+for+more+details &customtext_1=My+Custom+text+in+first+slide\r\nAnd+some+more+Custom+text &customsubject=My+Custom+Subject &di_bgimage=https://www.yourwebsite.com/images/backgroundimage.jpg &di_barcodeid=SKY-13332-4333433 &di_textarea1=Company-SKY &di_textarea2=Mr.XXXX &di_textarea3=Email%3Axxxx%40yyyy.com &di_textarea4=Mobile%3Axxx-xxx-xxxx &data_first_name=John &data_last_name=Smith &data_age=30 &data_pet=Dog
<RESPONSE> <STATUS>Success</STATUS> <MMSID>35674</MMSID> <TRACKINGID>TU1TXzU5Nzg3OQ==</TRACKINGID> <TO>16501234123</TO> <FROM>60586</FROM> <STATUSDETAILS>MMS request accepted and queued for delivery</STATUSDETAILS> </RESPONSE>
<RESPONSE> <STATUS>Failure</STATUS> <ERRORCODE>E713</ERRORCODE> <TO>16501234123</TO> <ERRORINFO>There is billing problem on your account</ERRORINFO> </RESPONSE>
When the MMS delivery is processed successfully the system will generate a Postback notification. When an MMS delivery report is received the system will generate another Postback notification. Not all carriers provide MMS delivery receipts. For more details please visit the MMS MT Delivery Status section of the Delivery Report Postback documentation.
