CodesThere are three main codes you'll need to send your telegrams via API. These are the TGID, the Secret Key, and your Client Key. Below, you'll find steps to obtain each. This section is only about how to get these codes, not how to use them! Go to the
Next Section to learn how to use these codes.
TGID and Secret KeyBoth of these items are obtained through the same processes, and are specific to the individual telegram being sent. These codes *can* be shared with another nation, but doing so is not recommended, as they'll always send with the name of the creator on the "from" line! Also, if the creator ceases to exist or leaves the region the client key is issued for (more on that later), the telegrams will stop! Best to keep all your codes coming from the same place, eh?
First, go to your telegrams page, and hit "new telegram." Write the telegram you wish to be sent via the API in the relevant box (reminder: the code "%NATION%" allows each recipient to see their nation name where it is placed). If your telegram is a recruitment message, make sure to click the drop down arrow and check the box stating "This is a recruitment telegram" - this both adds the "move to [region]" link at the bottom of your message, and properly marks all instances of this telegram sent. If your telegram is a campaign message, use the further options available in the drop down menu to select that instead and avoid modly wraith. If your message is neither, don't worry about checking any boxes.
For more information, see the technical section of the FAQ.Next, address the telegram to "tag:api" and send it. You will not receive a reply- rather, use the menu in the top left of your inbox to navigate to your sent messages, find the message you just sent, and click to open it in full. Scrolling to the bottom of that message, click "Recruitment & Delivery Reports." The following information will appear:
This is an API Template. To wire a copy to someone, make make an API request using the following information:
TGID: #######
Secret Key: a111111a1111
Do not share your Secret Key with anyone.
...followed by delivery information (which, while perhaps of interest to you later, is not relevant at present time). These are the TGID and Secret Key for this message, and can always be found under this link in your sentbox.
Client KeyTo acquire a Client Key, you'll need to file a "Getting Help Request" (GHR). To do so, go to
This Page. Select, the "other" option, and enter the following information into the text box (as described by Senior Game Moderator
Frisbeeteria, with an associated notice):
Frisbeeteria wrote:You MUST include:
Please send me a client key
<Your nation name>
<Your region name> (and your requesting nation MUST reside in that region)
<The reason for the script> (can be as simple as "Recruiting")
It rarely takes more than a day or two, but wait patiently - we'll get to it eventually. If you pester us with "WHERE THE HELL IS MY CLIENT KEY" tasks, it's very annoying and will most likely get you an irritated response or even a warning for spamming.
When the Moderation Team processes your request, they'll send you back a Voice of Mod telegram containing your Client Key. Please note, Client Keys are region-specific. If you wish to recruit for a new region, you need to acquire a new key.
Keep reading below to learn how to put these codes to work!