https://wiki-messangi.ogangi.com/documentation/ 2026-05-08T02:17:17-0400 https://wiki-messangi.ogangi.com/documentation/ https://wiki-messangi.ogangi.com/documentation/lib/tpl/bootstrap3/images/favicon.ico text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:active_campaigns&rev=1581528089&do=diff RESTful API List Mobile Operators Overview List the current mobile operators table. This may vary depending on client's specify connectivity requirements. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/getCarriers/{instanceId}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:add_to_restriction_list_3_34&rev=1584134876&do=diff RESTful API Add to Restriction List (Tag 34) Overview The API support a global restriction list, clients can block traffic to a desired recipient by adding it to the restriction list, use this method to do so. We support both white restriction list and black text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:add_to_restriction_list_3_35&rev=1584134876&do=diff RESTful API Add to Restriction List Previous Versions Tag 34 Overview The API support a global restriction list, clients can block traffic to a desired recipient by adding it to the restriction list, use this method to do so. We support both white restriction list and text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:add_to_restriction_list_bulk_3_34&rev=1584134876&do=diff RESTful API Add to Restriction List Bulk (Tag 34) Overview The API support a global restriction list, clients can block traffic to a desired recipient by adding it to the restriction list, you can load big user's list at once using this method. We support both text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:add_to_restriction_list_bulk_3_35&rev=1584134876&do=diff RESTful API Add to Restriction List (Bulk) Previous Versions Tag 34 Overview The API support a global restriction list, clients can block traffic to a desired recipient by adding it to the restriction list, you can load big user's list at once using this method. text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:add_user_to_email_list_3_34&rev=1584134876&do=diff RESTful API Add User to Email List (Tag 34) Overview Add an email address to an Email list. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/addToEmailList/{instanceId}/{emailListId}/{email}/{alias}/{publicKey}/{signature} Parameter Name text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:add_user_to_email_list_3_35&rev=1584134876&do=diff RESTful API Add User to Email List Previous Versions Tag 34 Overview Add an email address to an Email list URL Http access method: POST Parameters on the following URL are inside braces { } {base_url}/rest/api/addToEmailList/{instanceId}/{emailListId}/{email}/{alias}/{publicKey}/{signature} text/html 2016-04-20T15:06:01-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:allinone&rev=1461179161&do=diff Social Networks Facebook RESTful API Authentication Request (with registration) Overview Use this method to register your application with the Campaign Manager it will return the URL that you need to grant the application permissions to post your message in your Facebook wall. text/html 2016-01-26T14:24:05-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_base_url&rev=1453836245&do=diff RESTful API Base URL You must build the method URL according your Campaign Manager installation. It is tied by the domain name and base context. Lets asume for a moment that your Campaign Manager is located at http://www.messangi.com/messangi_mmc. And the method's text/html 2017-01-12T11:35:45-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_blacklist_status&rev=1484238945&do=diff RESTful API Blacklist Types Blacklist TypeValueBroadcast1Interactive Campaigns2Broadcast and Interactive Campaigns3 text/html 2016-01-04T09:51:11-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_blast_search&rev=1451919071&do=diff RESTful API Blast Inline Search String Available Search filters Name Possible Values Description TYPE EMAIL, PUSH, SMS, VOICE, GEOPUSH, GEOFENCE_PUSH, BEACON_PUSH or FACEBOOK Choose which kind of messages you want to retrieve. It is possible to filter by several values separated by comma (',') text/html 2016-01-26T14:13:02-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_broadcast&rev=1453835582&do=diff RESTful API Broadcasts Types Value Name Description 1 BY_DISTRIBUTION_LIST Target users are contained in a distribution list 2 BY_USERPREFERENCES Campaign Manager Internal notification process 3 BY_OSM Triggered by O.S.M. 4 BY_CUSTOM_LIST Target users were contained in a volatile distribution list text/html 2016-06-24T11:20:12-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_c_types&rev=1466781612&do=diff RESTful API Campaign's Types Campaign TypeValueMultiple Choice2Keyword9External Web Service88Raffle190 text/html 2019-01-04T16:16:36-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_call_ex&rev=1546636596&do=diff RESTful API Java Example Call Guidelines This is a basic example in Java to build the proper URL and make the call. * The first thing you are going to need is your public and private key of your workspace; you can request your credentials to your Sales representative. text/html 2016-08-18T12:09:54-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_call_json_ex&rev=1471536594&do=diff RESTful API JSON Broadcast Example Call Guidelines This page presents two examples, one on PHP and the other in JAVA, for properly making the call. * The first thing you are going to need is your public and private key from Ogangi; you can request your credentials with your Ogangi’s representative. text/html 2018-11-12T09:17:31-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_callbacks&rev=1542032251&do=diff RESTful API Client's Callback URL As you can imagine many of the RESTful API methods are asynchronous, this is why a client's callback is needed, we will be posting there updates and event information when it arises. If you want to be prepared for those notifications you need to configure a basic WebServer (public text/html 2018-10-02T16:53:53-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_ciphering&rev=1538513633&do=diff RESTful API Ciphering Data Sometimes using this REST API we find ourselves in situations where we need to use some kind of encryption in order to pass through some text parameters that could contain special characters and may cause data loss or maybe to obfuscate text text/html 2016-01-04T09:46:20-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_date&rev=1451918780&do=diff RESTful API Date Format - Pattern Letters Symbol Meaning Presentation Examples ------ ------- ------------ ------- G era text AD C century of era (>=0) number 20 Y year of era (>=0) year 1996 x weekyear year 1996 w week of weekyear number 27 e day of week number 2 E… text/html 2017-08-03T09:32:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_delivery_method&rev=1501767176&do=diff RESTful API Delivery Method Types Value Name Description 1 DELIVER_SMS Delivery method by SMS 2 DELIVER_PUSH Delivery method by PUSH 7 DELIVER_SIM_MO Delivery method through simulation to the campaigns text/html 2016-01-04T09:48:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_geoline_search&rev=1451918936&do=diff RESTful API Geo-Fence Inline Search String Available Search filters Name Possible Values Description EVENTTYPE ENTER EXIT ENTER-EXIT Filter data using the event type ACTIVATED 1 or 0 Filter data using the Geo-Fence active status GEOFENCEID Text Filter by Geo-Fence Id text/html 2016-01-04T09:49:19-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_mo_search&rev=1451918959&do=diff RESTful API MO Inline Search String Available Search filters Name Possible Values Description CARRIER Text Filter the response by the Carrier's Name TO Text Filter the response by TO FROM Text Filter the response by FROM KEYWORD Text A regular expression to filter by keyword. Learn more about regular expressions text/html 2019-03-18T15:50:17-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_msg_status&rev=1552938617&do=diff RESTful API Message's Status SMS NameDescriptionSENTMessage sent to carrier.DELIVERED_TO_CARRIERDelivered to Carrier.EXPIREDMaximum number of tries reached.UNREACHABLEUnknown Mobile number or device id.NOT_SENTThe message could not be sent.BAD_FROMMessage not sent. Invalid 'from' parameter. text/html 2016-01-04T09:49:39-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_mt_search&rev=1451918979&do=diff RESTful API MT Inline Search String Available Search filters Name Possible Values Description APPNAME Text Filter messages for a particular App PLATFORM ANDROID or IOS Filter messages for a particular OS BLASTID Text Filter messages for a particular blast text/html 2019-06-27T18:17:49-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_phonelist&rev=1561673869&do=diff RESTful API Phone List Guidelines Generally when sending blasts you will need to create a recipient list. This recipient list its a file that contains the detailed information for each recipient. The file could also contain additional parameters for each recipient. text/html 2017-02-01T10:28:11-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_phonelist_5_3_52&rev=1485962891&do=diff RESTful API Phone List Guidelines Generally when sending blasts you will need to create a recipient list. This recipient list its a file that contains the detailed information for each delivery. This file could also contain parameters for each particular case, this parameters help to customise each delivery by adding personalized information. text/html 2019-12-17T14:39:53-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_resp_xml&rev=1576611593&do=diff RESTful API The Response XML Basically, all API methods will respond with the same XML structure, we have divided this structure in two parts, a non changing - static part -, and a - dynamic part - that contains special information about the method per se, this last one will always be inside the text/html 2016-01-04T09:50:50-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_rl_search&rev=1451919050&do=diff RESTful API Restriction List Search String Available Search filters Name Possible Values Description REASON BOUNCED, COMPLAINT or UNSUBSCRIBE Filter messages for a particular App USER Text The recipient contact information Each parameter must be separated by ampersand ('&') and for each parameter is possible to filter by several values separated by comma (',') text/html 2016-01-04T09:48:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_rules&rev=1451918909&do=diff RESTful API The RULE Parameter Some methods allows you to use the {rules} parameter, this special parameter allows you to easily extend a method's functionality. Available Rules Rule Type Value Description Starts STARTS Date Check if the value of the Date already occurred. The Date is in milliseconds text/html 2016-01-04T09:50:32-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_sc_search&rev=1451919032&do=diff RESTful API Scratch Card Search String Available Search filters Parameters permitted: NAME, CATEGORY, BACKGROUND,SEARCH, ORDER (ASC | DESC). Each parameter must be separated by ampersand ('&'). Name Possible Values Description NAME Text Filter by Scratch Card name text/html 2016-01-04T09:51:35-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_sc_templates&rev=1451919095&do=diff RESTful API Scratch Cards Templates Template 1 - Scratch Card This is the most common Scratch Card presentation, You will require 5 images to set this scratch card up. Use Case * The scratch card start with only 3 visible images: header, cover and footer. text/html 2016-10-03T17:36:51-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_template_send_3_35&rev=1475530611&do=diff RESTful API Template Configuration JSON file to configure the template, chasers and timeout. Main Parameters Parameter Name Description Valid Values to_address User mobile number who will receive this messages String channel_id Desired Channel to deliver the information text/html 2016-01-04T09:50:04-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_url_search&rev=1451919004&do=diff RESTful API URL Inline Search String Available Search filters Name Possible Values Description They are the search's filters. Parameters permitted: TYPE, TO, ID_TYPE, EXTERNAL_ID. Each parameter must be separated by ampersand ('&'). TYPE Word Use this as a tag value, you could use any word you want, useful for reporting. The most common word when working with scratchcards is SCRATCH_CARD. text/html 2016-01-04T09:47:11-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:appx_wb_list&rev=1451918831&do=diff RESTful API Restriction List File Format You can add multiples recipients to the restriction list by building this file. All parameters on the file are optional, the only mandatory parameter it's the recipient and it has to be at the first column This file could be either a text file or an excel one. text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:beacon&rev=1581528089&do=diff RESTful API Create Beacon Overview A Beacon it's a small device that constantly will be broadcasting some information to its surroundings (indoor use, low distant range) using Bluetooth. This method allows you to attach your information to a specific beacon, so users that enter in the beacon's range will receive the desired information. text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:blacklist&rev=1584134876&do=diff RESTful API User Blacklisted Overview Show if an user is in the black list URL Http access method: GET Parameters on the following URL are inside braces { } {base_url}/rest/api/isUserInBlackList/{instanceId}/{mobilenumber}/{shortcode}/{publicKey}/{signature} text/html 2020-04-14T13:49:16-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:broadcasts&rev=1586886556&do=diff RESTful API Blast by File Overview Send SMSs massively using as recipient a list of mobile numbers. The recipient list its a File (text or excel). Please read the SMSs Recipient List to learn more about this. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/tools/sendSMSByFile/{instanceId}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:campaign_broadcast_3_34&rev=1584134876&do=diff RESTful API Campaign Broadcast (Tag 34) Overview Send a broadcast to a campaign's users. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/sendOnAirBroadcast/{instanceId}/{mimId}/{userName}/{text}/{shortcode}/{shortcodeIgnore}/{initialDate}/{finalDate}/{textSearch}/{mobileNumber}/{carrierId}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:campaign_broadcast_3_35&rev=1584134876&do=diff RESTful API Campaign Broadcast Previous Versions Tag 34 Overview Send a broadcast to a campaign's users. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/sendOnAirBroadcast/{instanceId}/{mimId}/{userName}/{text}/{shortcode}/{shortcodeIgnore}/{initialDate}/{finalDate}/{textSearch}/{mobileNumber}/{carrierId}/{publicKey}/{signature} text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:campaign_json&rev=1581528089&do=diff RESTful API Campaign Descriptor This descriptor -as a json file- contains all the details to describe each different type of campaign (Multiple Choice, Raffle, Keyword and External Interaction) Json Structure { "name": "Campaign Name", "description": "Campaign Description", "useFallback": false, "wildcards": true, "active": 1, "delivery_method": "SMS", "listIds": "", "autowildcards": true, "keyphrasesBegin": false, "onetime": false, "autoMenu": true, "alertMimAggre… text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:campaigns&rev=1581528089&do=diff RESTful API Create Campaign Overview Allows the user to create interactive campaigns URL Parameters on the following URL are inside braces { } {base_url}/rest/api/createCampaign/{instanceId}/{mimId}/{minType}/{publicKey}/{signature} Parameter Name Description text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:client&rev=1581528089&do=diff RESTful API Retrieve Client's Credits Overview Clients will require credits to send messages. Every message (regardless the channel) cost 1 credit. Use this method to see how many credits a client currently have. URL Parameters on the following URL are inside braces { } text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_broadcast_by_distribution_list_3_34&rev=1584134876&do=diff RESTful API Create or Edit Broadcast by Distribution List (Tag 34) Overview Create or edit a broadcast. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/createBroadcast/{instanceId}/{broadcastId}/{shortcode}/{text}/{userName}/{distListId}/{shortcodeIgnore}/{campaignName}/{date}/{hour}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_broadcast_by_distribution_list_3_35&rev=1584134876&do=diff RESTful API Create Broadcast by Distribution List Previous Versions Tag 34 Overview Create a broadcast. URL Http access method: POST Parameters on the following URL are inside braces { } {base_url}/rest/api/broadcast/{instanceId}/{shortcode}/{text}/{userName}/{distListId}/{shortcodeIgnore}/{campaignName}/{date}/{hour}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_broadcast_by_distribution_list_using_throttle_and_delivery_method&rev=1584134876&do=diff Create Broadcast by Distribution List Using Throttle and Delivery Method Overview Create a broadcast allowing used Throttle and Delivery Method. URL Http access method: POST Parameters on the following URL are inside braces { } {base_url}/rest/api/broadcast/{instanceId}/{shortcode}/{text}/{userName}/{distListId}/{shortcodeIgnore}/{campaignName}/{throttle}/{deliveryMethod}/{date}/{hour}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_broadcast_by_distribution_list_with_throttle&rev=1584134876&do=diff Home Create Broadcast by Distribution List using Throttle and Delivery Method Overview Create a broadcast allowing used Throttle and Delivery Method. URL Http access method: POST Parameters on the following URL are inside braces { } {base_url}/rest/api/broadcast/{instanceId}/{shortcode}/{text}/{userName}/{distListId}/{shortcodeIgnore}/{campaignName}/{throttle}/{deliveryMethod}/{date}/{hour}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_broadcast_by_file_3_34&rev=1584134876&do=diff RESTful API Create or Edit Broadcast By File (Tag 34) Overview Create or edit a broadcast by file. This is a POST method, which means that you need to use it through a POST call URL Parameters on the following URL are inside braces { } {base_url}/rest/api/createBroadcastByFile/{instanceId}/{broadcastId}/{shortcode}/{userName}/{shortcodeIgnore}/{campaignName}/{date}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_broadcast_by_file_3_35&rev=1584134876&do=diff RESTful API Create Broadcast By File Previous Versions Tag 34 Overview Create a broadcast by file. URL Http access method: POST Parameters on the following URL are inside braces { } {base_url}/rest/api/broadcastByFile/{instanceId}/{shortcode}/{userName}/{shortcodeIgnore}/{campaignName}/{date}/{publicKey}/{signature} text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_campaign_3_34&rev=1581528089&do=diff RESTful API Create Campaign (Tag 34) Overview Allows the user to create interactive campaigns URL Parameters on the following URL are inside braces { } {base_url}/rest/api/createCampaign/{instanceId}/{mimId}/{minType}/{publicKey}/{signature} Parameter Name text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_campaign_3_35&rev=1581528089&do=diff RESTful API Create Campaign Previous versions Tag 34 Overview Allows the user to create interactive campaigns URL Http access method: POST Parameters on the following URL are inside braces { } {base_url}/rest/api/campaign/{instanceId}/{minType}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_distribution_list_3_34&rev=1584134876&do=diff RESTful API Create Distribution List (Tag 34) Overview Create an empty distribution list. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/createDistributionList/{instanceId}/{name}/{userName}/{publicKey}/{signature} Parameter Name text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_distribution_list_3_35&rev=1584134876&do=diff RESTful API Create Distribution List Previous Versions Tag 34 Overview Create an empty distribution list. URL Http access method: POST Parameters on the following URL are inside braces { } {base_url}/rest/api/distributionList/{instanceId}/{name}/{userName}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_email_list_3_34&rev=1584134876&do=diff RESTful API Create Email List (Tag 34) Overview Create an empty email list URL Parameters on the following URL are inside braces { } {base_url}/rest/api/createEmailList/{instanceId}/{name}/{userName}/{publicKey}/{signature} Parameter Name Description instanceId text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_email_list_3_35&rev=1584134876&do=diff RESTful API Create Email List Previous Versions Tag 34 Overview Create an empty email list. URL Http access method: POST Parameters on the following URL are inside braces { } {base_url}/rest/api/emailList/{instanceId}/{name}/{userName}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_label_3_34&rev=1584134876&do=diff RESTful API Create Label (Tag 34) Overview Creates a new Label. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/createLabel/{instanceId}/{mimId}/{labelName}/{labelId}/{labelResponse}/{publicKey}/{signature}/?labelKeyword= Parameter Name text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_label_3_35&rev=1584134876&do=diff RESTful API Create Label Previous Versions Tag 34 Overview Creates a new Label. URL Http access method: POST Parameters on the following URL are inside braces { } {base_url}/rest/api/createLabel/{instanceId}/{mimId}/{labelName}/{labelId}/{labelResponse}/{publicKey}/{signature}/?labelKeyword= text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_personalized_broadcast_3_34&rev=1584134876&do=diff RESTful API Create or Edit Personalized Broadcast (Tag 34) Overview Create or edit a personalized broadcast. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/createPersonalizedBroadcast/{instanceId}/{broadcastId}/{shortcode}/{userName}/{shortcodeIgnore}/{b64text}/{campaignName}/{date}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_personalized_broadcast_3_35&rev=1584134876&do=diff RESTful API Create Personalized Broadcast Previous Versions Tag 34 Overview Create or edit a personalized broadcast. URL Http access method: POST Parameters on the following URL are inside braces { } {base_url}/rest/api/personalizedBroadcast/{instanceId}/{shortcode}/{userName}/{shortcodeIgnore}/{b64text}/{campaignName}/{date}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_segmented_distribution_list_3_34&rev=1584134876&do=diff RESTful API Create Segmented Distribution List Overview Creates a new distribution list with segmentation capabilities This is a POST method, which means that you need to use it through a POST call URL Parameters on the following URL are inside braces { } text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_segmented_distribution_list_3_35&rev=1584134876&do=diff RESTful API Create Segmented Distribution List Previous Versions Tag 34 Overview Creates a new distribution list with segmentation capabilities URL Http access method: POST Parameters on the following URL are inside braces { } {base_url}/rest/api/segmentedDistList/{instanceId}/{name}/{userName}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:create_segmented_distribution_list_custom_key_3_35&rev=1584134876&do=diff Create Segmented Distribution List With Custom Key Overview Creates a new distribution list with segmentation capabilities with a custom key URL Http access method: POST Parameters on the following URL are inside braces { } {base_url}/rest/api/segmentedDistList/{instanceId}/{name}/{userName}/{listKey}/{publicKey}/{signature} text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:delete_campaign_3_34&rev=1581528089&do=diff RESTful API Delete Campaign Overview Delete an existing campaign URL Parameters on the following URL are inside braces { } {base_url}/rest/api/deleteCampaign/{instanceId}/{searchString}/{publicKey}/{signature} Parameter Name Description instanceId An instance id text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:delete_campaign_3_35&rev=1581528089&do=diff RESTful API Delete Campaign Previous Versions Tag 34 Overview Delete an existing campaign URL Http access method: DELETE Parameters on the following URL are inside braces { } {base_url}/rest/api/campaign/{instanceId}/{searchString}/{publicKey}/{signature} Parameter Name text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:delete_distribution_list_3_34&rev=1584134876&do=diff RESTful API Delete Distribution List Overview Delete an empty distribution list. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/deleteDistributionList/{instanceId}/{distListId}/{publicKey}/{signature} Parameter Name Description text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:delete_distribution_list_3_35&rev=1584134876&do=diff RESTful API Delete Distribution List Previous Versions Tag 34 Overview Delete an empty distribution list. URL Http access method: DELETE Parameters on the following URL are inside braces { } {base_url}/rest/api/distributionList/{instanceId}/{distListId}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:delete_email_list_3_34&rev=1584134876&do=diff RESTful API Delete Email List (Tag 34) Overview Delete an empty email list URL Parameters on the following URL are inside braces { } {base_url}/rest/api/deleteEmailList/{instanceId}/{name}/{publicKey}/{signature} Parameter Name Description instanceId An text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:delete_email_list_3_35&rev=1584134876&do=diff RESTful API Delete Email List Previous Versions Tag 34 Overview Delete an empty email list URL Http access method: DELETE Parameters on the following URL are inside braces { } {base_url}/rest/api/emailList/{instanceId}/{name}/{publicKey}/{signature} Parameter Name text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:dlist&rev=1581528089&do=diff RESTful API Add User to Distribution List Overview Add a mobile number to a distribution list. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/addUserDistributionList/{instanceId}/{distListId}/{mobileNumber}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:edit_broadcast_by_distribution_list_3_35&rev=1584134876&do=diff RESTful API Edit Broadcast by Distribution List Previous Versions Tag 34 Overview Edit a broadcast. URL Http access method: PUT Parameters on the following URL are inside braces { } {base_url}/rest/api/broadcast/{broadcastId}/{instanceId}/{shortcode}/{text}/{userName}/{distListId}/{shortcodeIgnore}/{campaignName}/{date}/{hour}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:edit_broadcast_by_file_3_35&rev=1584134876&do=diff RESTful API Edit Broadcast By File Previous Versions Tag 34 Overview Create or edit a broadcast by file. URL Http access method: PUT Parameters on the following URL are inside braces { } {base_url}/rest/api/broadcastByFile/{instanceId}/{broadcastId}/{shortcode}/{userName}/{shortcodeIgnore}/{campaignName}/{date}/{publicKey}/{signature} text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:edit_campaign_3_35&rev=1581528089&do=diff RESTful API Edit Campaign Overview Allows the user to edit an interactive campaigns URL Http access method: POST Parameters on the following URL are inside braces { } {base_url}/rest/api/campaign/{instanceId}/{mimId}/{minType}/{publicKey}/{signature} Parameter Name text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:edit_labe_3_34l&rev=1584134876&do=diff RESTful API Edit Label (Tag 34) Overview Edit the current values of a label URL Parameters on the following URL are inside braces { } {base_url}/rest/api/editLabel/{instanceId}/{mimId}/{labelName}/{labelId}/{labelResponse}/{publicKey}/{signature}/?labelKeyword= text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:edit_label_3_35&rev=1584134876&do=diff RESTful API Edit Label Previous Versions Tag 34 Overview Edit the current values of a label URL Http access method: PUT Parameters on the following URL are inside braces { } {base_url}/rest/api/label/{instanceId}/{mimId}/{labelName}/{labelId}/{labelResponse}/{publicKey}/{signature}/?labelKeyword= text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:edit_personalized_broadcast_3_35&rev=1584134876&do=diff RESTful API Edit Personalized Broadcast Previous Versions Tag 34 Overview Http access method: PUT Create or edit a personalized broadcast. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/personalizedBroadcast/{instanceId}/{broadcastId}/{shortcode}/{userName}/{shortcodeIgnore}/{b64text}/{campaignName}/{date}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:edit_segmented_distribution_list_3_35&rev=1584134876&do=diff RESTful API Edit Segmented Distribution List Overview Method to add, edit or remove a user from a segmented distribution list. Please switch the call method to obtain the desired behavior as follows: Call Method Behavior HTTP GET Removes a user from a segmented subscription list text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:edit_segmented_distribution_list_3_36&rev=1584134876&do=diff RESTful API Edit Segmented Distribution List Previous Versions Tag 35 Overview Method to add, edit or remove a user from a segmented distribution list. Please switch the call method to obtain the desired behavior as follows: Call Method Behavior HTTP GET Retrieves a user information text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:email&rev=1581528089&do=diff RESTful API Send Email Overview Send a email message URL Parameters on the following URL are inside braces { } {base_url}/rest/api/tools/sendEmail/{instanceId}/{from}/{to}/{subject}/{publicKey}/{signature} Please note that on the URL you won't see any POST parameters, only the regular parameters text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:facebook&rev=1581528089&do=diff RESTful API Authentication Request (with registration) Overview Use this method to register your application with the Campaign Manager it will return the URL that you need to grant the application permissions to post your message in your Facebook wall. This method is very convenient if the user wants to remain registered for future publications. text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:geo&rev=1581528089&do=diff RESTful API Request Device Location Overview You can request the location for a particular device by using this method, the Campaign Manager will request the current location from the device using a special PUSH message, when the device's location arrive it will deliver the information through your text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:get_campaign_3_34&rev=1581528089&do=diff RESTful API Get Campaign Overview Returns the basic information about the campaign URL Parameters on the following URL are inside braces { } {base_url}/rest/api/getCampaign/{instanceId}/{searchString}/{publicKey}/{signature} Parameter Name Description instanceId text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:get_campaign_3_35&rev=1581528089&do=diff RESTful API Get Campaign Previous Versions Tag 34 Overview Returns the basic information about the campaign URL Http access method: GET Parameters on the following URL are inside braces { } {base_url}/rest/api/campaign/{instanceId}/{searchString}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:get_distribution_list&rev=1584134876&do=diff RESTful API Get List Subscribers Overview This method will return the information about an specific distribution list, including the users registered to the list in a paginated fashion. URL Http access method: GET Parameters on the following URL are inside braces { } text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:get_template_sms&rev=1584134876&do=diff RESTful API Get Template SMS Overview Retrieve a template. URL Http access method: GET Parameters on the following URL are inside braces { } {base_url}/rest/api/template/{instanceId}/{templateB64}/{publicKey}/{signature} Parameter Name Description instanceId text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:label_detail_3_34&rev=1584134876&do=diff RESTful API Label Detail Overview Retrieves the detailed information of a label. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/getLabelDetail/{instanceId}/{mimId}/{labelId}/{userName}/{publicKey}/{signature} Parameter Name Description text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:label_detail_3_35&rev=1584134876&do=diff RESTful API Label Detail Previous Versions Tag 34 Overview Retrieves the detailed information of a label. URL Http access method: GET Parameters on the following URL are inside braces { } {base_url}/rest/api/labelDetail/{instanceId}/{mimId}/{labelId}/{userName}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:list_campaign_labels_3_34&rev=1584134876&do=diff RESTful API List Campaign Labels (Tag 34) Overview List labels for the given campaign URL Parameters on the following URL are inside braces { } {base_url}/rest/api/getLabels/{instanceId}/{mimId}/{userName}/{publicKey}/{signature} Parameter Name Description text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:list_campaign_labels_3_35&rev=1584134876&do=diff RESTful API List Campaign Labels Previous Versions Tag 34 Overview List labels for the given campaign URL Http Access Method: GET Parameters on the following URL are inside braces { } {base_url}/rest/api/labels/{instanceId}/{mimId}/{userName}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:list_campaigns_3_34&rev=1584134876&do=diff RESTful API List Campaigns Overview List all campaigns for the given user, you also can narrow the results using the campaign name. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/getMims/{instanceId}/{userName}/{campaignName}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:list_campaigns_3_35&rev=1584134876&do=diff RESTful API List Campaigns Previous Versions Tag 34 Overview List all campaigns for the given user, you also can narrow the results using the campaign name. URL Http access method: GET Parameters on the following URL are inside braces { } {base_url}/rest/api/mims/{instanceId}/{userName}/{campaignName}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:list_instance_codes_3_35&rev=1584134876&do=diff RESTful API List Instance Codes Overview List all short/long codes for a given instance. URL Http access method: GET Parameters on the following URL are inside braces { } {base_url}/rest/api/shortcodes/{instanceId}/{userName}/{publicKey}/{signature} Parameter Name text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:lists_broadcasts_3_34&rev=1584134876&do=diff RESTful API List Broadcasts (Tag 34) Overview List broadcasts by instance. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/getBroadcasts/{instanceId}/{type}/{initialDate}/{finalDate}/{text}/{publicKey}/{signature} Parameter Name text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:lists_broadcasts_3_35&rev=1584134876&do=diff RESTful API List Broadcasts Previous Versions Tag 34 Overview List broadcasts by instance. URL Http access method: GET Parameters on the following URL are inside braces { } {base_url}/rest/api/broadcasts/{instanceId}/{type}/{initialDate}/{finalDate}/{text}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:lists_distribution_lists_3_34&rev=1584134876&do=diff RESTful API List Distribution Lists (Tag 34) Overview Lists the distribution lists by instance URL Parameters on the following URL are inside braces { } {base_url}/rest/api/getDistributionList/{instanceId}/{userName}/{mobileNumber}/{publicKey}/{signature} Parameter Name text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:lists_distribution_lists_3_35&rev=1584134876&do=diff RESTful API List Distribution List Previous Versions Tag 34 Overview List the distribution list by instance URL Http access method: GET Parameters on the following URL are inside braces { } {base_url}/rest/api/distributionList/{instanceId}/{userName}/{mobileNumber}/{publicKey}/{signature} text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:message&rev=1581528089&do=diff RESTful API Retrieving a Message Overview Retrieve a message by its Id. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/tools/getMessage/{instanceId}/{messageId}/{publicKey}/{signature} Parameter Name Description instanceId text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:multiple_choice&rev=1581528089&do=diff RESTful API Inspect User Interaction for Multiple Choice Overview Inspect a user message flow in the given Multiple Choice URL Parameters on the following URL are inside braces { } {base_url}/rest/api/getChoicesForMobileNumber/{instanceId}/{mobileNumber}/{initialDate}{finalDate}/{publicKey}/{signature} text/html 2018-11-14T10:08:14-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:orbit_billing_api&rev=1542208094&do=diff RESTful API Billing API Overview Charging a mobile number or “account” and deliver SMS with a text (Only for MT Billing). URL Parameters on the following URL are inside braces { } http://backend17.ogangi.com:9020/orbit/api/bill/{account}/{amount}/{callback_b64}/{message_b64}/{hints_b64} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:posting_a_message_to_the_facebook_wall_3_34&rev=1584134876&do=diff RESTful API Posting a Message to the Facebook Wall (Tag 34) Overview Allows you to post messages in your Facebook's wall. Use this method if you meet the following requirements: * You have a Facebook app. * You has registered your app with the Campaign Manager * text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:posting_a_message_to_the_facebook_wall_3_35&rev=1584134876&do=diff RESTful API Posting a Message to the Facebook Wall Previous Versions Tag 34 Overview Allows you to post messages in your Facebook's wall. Use this method if you meet the following requirements: * You have a Facebook app. * You has registered your app with the Campaign Manager text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:posting_to_the_twitter_timeline_3_34&rev=1584134876&do=diff RESTful API Posting a Message to the Twitter Timeline (Tag 34) Overview Allows you to post messages in your Twitter's Timeline. Use this method if you meet the following requirements: * You have a Twitter app. * You has registered your app with the Campaign Manager text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:posting_to_the_twitter_timeline_3_35&rev=1584134876&do=diff RESTful API Posting a Message to the Twitter Timeline Previous Versions Tag 34 Overview Allows you to post messages in your Twitter's Timeline. Use this method if you meet the following requirements: * You have a Twitter app. * You has registered your app with the Campaign Manager text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:push_registration&rev=1581528089&do=diff RESTful API Android App Registration Overview Push Notifications are messages sent from the Campaign Manager tool to user's smartphones. Clients need an Android App registered to the Campaign Manager to handle the message. You could request our home brewed Android App if you don't have one URL Parameters on the following text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:push_retrieve&rev=1581528089&do=diff RESTful API Retrieving Pending Push Messages Overview This method will list all pending push messages that a user may have. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/tools/getPendingMessages/{instanceId}/{to}/{appName}/{platform}/{publicKey}/{signature} text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:push_send&rev=1581528089&do=diff RESTful API Sending Push to Phone Overview Send a single Push Notification to a registered device using the mobile number as the destination. This is a POST method, which means that you need to use it through a POST call URL Parameters on the following URL text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:register_facebook_app_3_34&rev=1584134876&do=diff RESTful API Register Facebook App (Tag 34) Overview To post a message on a Facebook user's wall you will need first a Facebook app. Once you have it you need to register it with the Campaign Manager to make it able to post your messages. Please keep in mind that Facebook will text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:register_facebook_app_3_35&rev=1584134876&do=diff RESTful API Register Facebook Application Previous Versions Tag 34 Overview To post a message on a Facebook user's wall you will need first a Facebook app. Once you have it you need to register it with the Campaign Manager to make it able to post your messages. Please keep in mind that Facebook will text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:register_twitter_app_3_34&rev=1584134876&do=diff RESTful API Register Twitter App Overview To post a message on your Twitter's timeline you will need a Twitter app, you could use the Twitter's fabric to do so. Once you have it you need to register it with the Campaign Manager to make it able to post messages in your name. text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:register_twitter_app_3_35&rev=1584134876&do=diff RESTful API Register Twitter App Previous Versions Tag 34 Overview To post a message on your Twitter's timeline you will need a Twitter app, you could use the Twitter's fabric to do so. Once you have it you need to register it with the Campaign Manager to make it able to post messages in your name. text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:remove_from_restriction_list_3_34&rev=1584134876&do=diff RESTful API Remove from Restriction List (Tag 34) Overview Remove a recipient from a restriction list. We support both white restriction list and black restriction list. Keep in mind that the whitelist recipients are allowed and the blacklist recipients are not. text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:remove_from_restriction_list_3_35&rev=1584134876&do=diff RESTful API Remove from Restriction List Previous Versions Tag 34 Overview Remove a recipient from a restriction list. We support both white restriction list and black restriction list. Keep in mind that the whitelist recipients are allowed and the blacklist recipients are not. text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:remove_user_from_email_list_3_34&rev=1584134876&do=diff RESTful API Remove User from Email List (Tag 34) Overview Remove an email address from an email list URL Parameters on the following URL are inside braces { } {base_url}/rest/api/removeUserEmailList/{instanceId}/{emailListId}/{email}/{publicKey}/{signature}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:remove_user_from_email_list_3_35&rev=1584134876&do=diff RESTful API Remove User from Email List Previous Versions Tag 34 Overview Remove an email address from an email list URL Http access method: DELETE Parameters on the following URL are inside braces { } {base_url}/rest/api/removeUserEmailList/{instanceId}/{emailListId}/{email}/{publicKey}/{signature} text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:report&rev=1581528089&do=diff RESTful API Message Report Overview List all messages information in a given period of time. It support filters to help you get the desired information easily. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/tools/messageReport/{instanceId}/{initialDate}/{finalDate}/{page}/{resultsPerPage}/{parameters}/{publicKey}/{signature} text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:reports&rev=1581528089&do=diff RESTful API Weekly Global Report Overview Returns a weekly report for the given user. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/getWeekReport/{instanceId}/{userName}/{date}/{publicKey}/{signature} Parameter Name Description text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:restricion&rev=1581528089&do=diff RESTful API Remove from Restriction List by Id Overview Remove a recipient from a restricted list using its list's id instead of the contact information. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/tools/removeOfRestrictionListById/{instanceId}/{id}/{publicKey}/{signature} text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:scratchcard&rev=1581528089&do=diff RESTful API Creating a Scratch Card Overview Create a new Scratch Card. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/tools/createScratchCard/{instanceId}/{name}/{template}/{backgroundColor}/{link}/{publicKey}/{signature} Please note that on the text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:send_a_smart_url_3_34&rev=1584134876&do=diff RESTful API Send a Smart URL (Tag 34) Overview Generate a short URL to redirect a user to a given destination allowing the API to keep track about the user interaction. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/tools/createRedirectURL/{instanceId}/{redirectURL}/{to}/{oneTime}/{externalId}/{type}/{idType}/{parameters}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:send_a_smart_url_3_35&rev=1584134876&do=diff RESTful API Send a Smart URL Previous Versions Tag 34 Overview Generate a short URL to redirect a user to a given destination allowing the API to keep track about the user interaction. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/tools/createRedirectURL/{instanceId}/{redirectURL}/{to}/{oneTime}/{externalId}/{type}/{idType}/{parameters}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:send_location_3_34&rev=1584134876&do=diff RESTful API Send Location (Tag 34) Overview Report a device current location to the Campaign Manager. It's supposed to be used from your App if you are developing yours. This method needs to be invoked as a reaction of calling the Request Device Location method URL Parameters on the following text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:send_location_3_35&rev=1584134876&do=diff RESTful API Send Location Previous Versions Tag 34 Overview Report a device current location to the Campaign Manager. It's supposed to be used from your App if you are developing yours. This method needs to be invoked as a reaction of calling the Request Device Location method URL text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:send_response_3_34&rev=1584134876&do=diff RESTful API Send Response (Tag 34) Overview If you are developing your own Android or iOS application you could use this method to allow users to give you some direct feedback through your Callback URL. URL Parameters on the following URL are inside braces { } text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:send_response_3_35&rev=1584134876&do=diff RESTful API Send Response Previous Versions Tag 34 Overview If you are developing your own Android or iOS application you could use this method to allow users to give you some direct feedback through your Callback URL. URL Parameters on the following URL are inside braces { } text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:sending_geo_push_3_34&rev=1584134876&do=diff RESTful API Sending Geo Push (Tag 34) Overview This method allows you to fire a Push Message over a region. The region will be defined as a circle given a cardinal point of the globe and a radius. All registered devices inside that circle at that moment will receive the message you send. text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:sending_geo_push_3_35&rev=1584134876&do=diff RESTful API Sending Geo Push Previous Versions Tag 34 Overview This method allows you to fire a Push Message over a region. The region will be defined as a circle given a cardinal point of the globe and a radius. All registered devices inside that circle at that moment will receive the message you send. text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:smarturl&rev=1581528089&do=diff RESTful API Blast a Smart URL Overview Generate a short URL to redirect a user to a given destination allowing the API to keep track about the user interaction. This method will blast the URL to a list of recipients. URL Parameters on the following URL are inside braces { } text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:sms&rev=1581528089&do=diff RESTful API Send SMS Overview Send a text message to a cell phone using its mobile number as target. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/tools/sendSMS/{instanceId}/{carrier}/{from}/{mobileNumber}/{text}/{publicKey}/{signature} text/html 2020-03-16T14:24:37-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:start&rev=1584383077&do=diff Home 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 text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:subscription_list_skipped_lines_report&rev=1584134876&do=diff Subscription list skipped lines report Overview Method to download a detailed report of the skipped lines in the creation of a subscription list. URL Http access method: GET Parameters on the following URL are inside braces {} {base_url}/rest/api/segmentedDistListReport/{instanceId}/{listId}/{name}/{timestamp}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:template_3_35&rev=1584134876&do=diff RESTful API Send Templates with Chasers & Timeout Overview Send a text message to a cell phone using its mobile number as target and a predefined template. URL Http access method: POST Parameters on the following URL are inside braces { } {base_url}/rest/api/template/{instanceId}/{publicKey}/{signature} text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:twitter&rev=1581528089&do=diff RESTful API Authentication Request (with registration) Overview Use this method to register your application with the Campaign Manager it will return the URL that you need to grant the application permissions to post your message in your Timeline. This method is very convenient if the user wants to remain registered for future publications. text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:two_way_message&rev=1584134876&do=diff Two Way Message Overview Obtain the MT response to a given MO. The real MT will not be delivered to the specified mobile number. URL Http access method: POST Parameters on the following URL are inside braces { } {base_url}/rest/api/twoWayMessage/{instanceId}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:update_user_on_restriction_list_3_34&rev=1584134876&do=diff RESTful API Update User On Restriction List (Tag 34) Overview Update user information on a restriction list. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/tools/updateRestrictionList/{instanceId}/{userOld}/{userNew}/{reasonNew}/{messageType}/{typeList}/{source}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:update_user_on_restriction_list_3_35&rev=1584134876&do=diff RESTful API Update User On Restriction List Previous Versions Tag 34 Overview Update user information on a restriction list. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/tools/updateRestrictionList/{instanceId}/{userOld}/{userNew}/{reasonNew}/{messageType}/{typeList}/{source}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:update_user_on_restriction_list_by_id_3_34&rev=1584134876&do=diff RESTful API Update User On Restriction List by Id (Tag 34) Overview Update user information on a restriction list given its id on the list. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/tools/updateRestrictionListById/{instanceId}/{id}/{userNew}/{reasonNew}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:update_user_on_restriction_list_by_id_3_35&rev=1584134876&do=diff RESTful API Update User On Restriction List by Id Previous Versions Tag 34 Overview Update user information on a restriction list given its id on the list. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/tools/updateRestrictionListById/{instanceId}/{id}/{userNew}/{reasonNew}/{publicKey}/{signature} text/html 2020-02-12T12:21:29-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:voice&rev=1581528089&do=diff RESTful API Placing a Voice Call Overview Place a voice call to a mobile phone number. The voice call will be generated from the message's content via a text to speech software. This is a final interaction which means that we don't expect any replay form the recipient. text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:wallet&rev=1584134876&do=diff RESTful API Overview The digital passes are becoming incresingly common use around the world to substitute paper passes, reach wider audiences and speed deliveries up. The API described in this documentation allows you to create a single template to deliver multiple passes and bind information with any data server to write on them specific data. Once your end-users have accepted the passes you sent, you can update each single pass or all the passes delivered simultaneously according to your ne… text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:weekly_campaign_report_3_34&rev=1584134876&do=diff RESTful API Weekly Campaign Report Overview Returns a weekly summary report for the given campaign. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/getCampaignWeekReport/{instanceId}/{mimId}/{userName}/{date}/{publicKey}/{signature} text/html 2020-03-13T17:27:56-0400 Anonymous (anonymous@undisclosed.example.com) https://wiki-messangi.ogangi.com/documentation/doku.php?id=restapi:weekly_campaign_report_3_35&rev=1584134876&do=diff RESTful API Weekly Campaign Report Previous Versions Tag 34 Overview Returns a weekly summary report for the given campaign. URL Parameters on the following URL are inside braces { } {base_url}/rest/api/getCampaignWeekReport/{instanceId}/{mimId}/{userName}/{date}/{publicKey}/{signature}