Sign up Login

XML Feed / Version 1 Explained

Follow

The feed is located at networks.xml

Below is a sample network extract from the XML feed:

<network>
<id>ORANGEUK5</id>
<name>Orange</name>
<country>UK</country>
<country_name>United Kingdom</country_name>
<shortcode>60999</shortcode>
<tariff>0.250 GBP</tariff>
<credits>0.500 Cr</credits>
<billing_type>MT</billing_type>
<keyword/>
<country_prefix/>
<reports>2</reports>
<isAdult>0</isAdult>
<supportsWapPush>0</supportsWapPush>
<supportsVcards>0</supportsVcards>
<supportsUnicode>0</supportsUnicode>
<supportsDirectOperatorBilling>0</supportsDirectOperatorBilling>
<Default_Language>English</Default_Language>
<Monthly_User_Spending_Limit>-</Monthly_User_Spending_Limit>
<User_Transaction_Spending_Limit>-</User_Transaction_Spending_Limit>
<Require_Stop_Acknowledgment>0</Require_Stop_Acknowledgment>
<imsi>
<mnc>33</mnc>
<mcc>234</mcc>
</imsi>
</network>

Please see below for further details on important variables:

<id>ORANGEUK5</id>

This is the mobile network ID, you will notice some networks have numbers appended to the end like above. This is to distinguish between multiple tariffs on the same short code and should be removed before posting to us. In the example you should use "ORANGEUK" removing the "5". When you receive a post this number will not be present.

To quickly search the XML feed and hit CTRL + F on your keyboard (command + F) on a mac. Enter the countries two letter code between > + < (i.e, >IL< for Israel) in the text box. This will then search the entire page for you.

For a full list of all countries please follow this link http://www.iso.org/iso/country_codes.htm

<tariff>0.250 GBP</tariff>

This is the value of the network entry in local currency, translated it would be sent as: "value=0.25", "currency=gbp"

<credits>0.500</credits>

For clients using our older version of the mobile gateway this is the credit value associated with each tariff, if you are reading this it is likely you can ignore this value.

With the 2010 release of our Gateway where you post messages to http://client.txtnation.com/mbill.php (as opposed to the old http://client.txtnation.com/ir_response.php) you can post in local currency and value, which is easier than the below Credits http post method:

Credits - txtNation uses a simple credit notation as the charging unit for microbilling. 1 Credit = 0.5 GBP. Values for other currencies will be converted at the given exchange rate. A client sets the value of a billed SMS message to a number of credits, rather than having to set a value for each currency.

1 Credit = 0.5 GBP. 
0.5 Credit = 0.25 GBP

Please Note: Values for other currencies will be converted at the given exchange rate.

Note that, although campaigns are set up in Credits, rather than units of currency, your advertising must show your customers how much they will pay in their currency.

Check to see what each line bills, and when you are performing your post to us, set the amount of credits that corresponds to the value of the line / the amount you want to bill.

<billing_type>MT</billing_type>

This is the billing type of the shortcode, for more information on this please read: http://clients.txtnation.com/entries/163712-all-products-premium-sms-what-are-the-sms-billing-types-available-what-are-mt-mo-no-do-io-mf-lc-dc

<country_prefix/>

If a value is present in this field it should be placed for your keyword upon texting in (unless otherwise pre-arranged with your account manager).

<reports>2</reports>

Please read the below for details on this variable:

0 - Delivery reports not supported

1 - Delivery reports supported

2 - Delivery reports exist in the last three months.

<supportsWapPush>0</supportsWapPush>
<supportsVcards>0</supportsVcards>
<supportsUnicode>0</supportsUnicode>

These are extra message sending options on the shortcode, 0 = not available 1 = available

<Require_Stop_Acknowledgment>0</Require_Stop_Acknowledgment>

This means that when a user sends in STOP you need to send them a standard rate message informing the user that the STOP has been received and that they will not receive any more messages. 

1 = It is required to acknowledge a users stop request

0 = it is not required to acknowledge a STOP request

<isAdult>0</isAdult>

0 = The short code cannot run adult content (e.g Gambling or pornography)

1 = The short code can run adult content 

<imsi>
<mnc>2</mnc>
<mcc>242</mcc>
</imsi>
This identifies the MCC and MNC of the network. This can be used as a result running a HLR or RTLU check on a number. 
Was this article helpful?
0 out of 0 found this helpful

Comments

Powered by Zendesk