Service information XML

Full service data is available in XML format. A link to XML file can be found under the “Setup” tab of an API service. Link example:

1

https://api.fortumo.com/api/services/2/8edae...8adcc5e.342340...ce5920a39.xml

There is a shorter version of the file available with no information regarding the operators and billing statuses. Additional parameter billing_info=false should be used in this case:

1

https://api.fortumo.com/api/services/2/8edae...8adcc5e.342340...ce5920a39.xml?billing_info=false

In order to request a single country data, an optional parameter country can be used in combination with a country code, for example country=DE for Germany:

1

https://api.fortumo.com/api/services/2/8edae...8adcc5e.342340...ce5920a39.xml?country=DE

It is recommended to schedule daily update requests of the file (for example, with a CRON job).

XML structure

• Status – contains information about whether the XML request was successful or not.
• Service::countries – holds all countries, associated with a service.
• Country – holds pricing and promotional information for a specific country.
• Price – groups short codes and operators with the same price point.
• Message_profile – groups operators with same short code and keyword combination.
• Operator – profile for a specific operator.
• Operator::codes – MCC and MNC pairs for a specific operator.
• Promotional_text – an example of promotional information for specific country.

Although in most of the countries the price point, short code and keyword are the same for all operators, there are countries where some of parameters may defer among them. In this case, there will be several price or message_profile nodes, and all_operators=false.

Note that in some of the countries customers will be asked to send a second message with a word “YES” or similar to confirm the purchase. This is called a double confirmation or double opt-in.

List of parameters

The following table gives an overview of all elements of the file and their possible values.

API file statuses

• 0 - OK (default)
• 1 - invalid service signature
• 2 - service not found
• 3 - service archived
• 4 - XML API not supported by service
• 5 - specified country not available

Parsing the file

For automatic processing of service data XML, an XML parser should be used. It’s strongly advised to use a built-in parser provided with the development framework to avoid parsing errors. There are built-in XML parsers available for most of the programming languages. The following table gives an overview of the most popular solutions.