Finding your API Key

You must first request access to the API from your Skycore account manager. Once the API is turned on, you can find your API_KEY in the API Settings page under your ‘Account’ dropdown.

Making API requests

GET Request - with URL encoded key/value pairs. The API URL is https://secure.skycore.com/API/wxml/1.3/.

POST Request - with XML data passed inside an ‘xml’ variable.

Note: You must URL Encode the values in the query string of your GET Requests. Failure to do so may result in the API failing to fully interpret your request. For example this query string &data_full_name=John Smith&data_age=35 would need to be encoded &data_full_name=John+Smith&data_age=35 (space replaced with plus sign)

Receiving API callbacks

POST XML - to the Postback URL defined in your Account’s API Settings page. Postback notifications are forwarded to your server individually every second and require an HTTP STATUS 200 response.

We expect your server to accept our postback within 10 seconds by responding with a standard HTTP STATUS 200 header (success). If establishing a connection to your Postback URL takes longer than 10 seconds, the connection will time out and be dropped. If the connection times out or the HTTP code is not 200 we will retry the notification again five minutes later for a maximum of 5 retries per notification.

API Limitations

You may have a throughput limit on your account. If your API requests exceed the throughput on your account then you may have some latency in the delivery of your messages. There may also be limits on the number of API calls allowed per second/minute/day. These limits will be published in your API Settings page.

Authentication

Authenticating your API call can be done in two ways:

apikey – Each API request must contain the accounts APIKEY. Some API requests may also require an MD5 encrypted password.

Authentication Error codes: E100, E101, E102, E103, E104, E105, E106, E107, E108, E109

Error XML Example:

<RESPONSE>
  <STATUS>Failure</STATUS>
  <ERRORCODE>E101</ERRORCODE>
  <ERRORINFO> 'action' required</ERRORINFO>
</RESPONSE>

Special Considerations

Always Use International Number Format: You must use international format when sending SMS or MMS. International format includes both the country code with the phone number. We use the country code to determine routing of the message. There should be no dialing prefixes (eg 00 or 001) or special characters such as the plus symbol when submitting messages. (e.g. ’642111111′ not ‘+642111111′)

For example the US number (774)-319-9144 in international number format would be 17743199144 because the USA country code is 1.

Resources

API Error Codes

Postback Notification Codes