getMessagingCampaigns

Synopsis:

This API function returns a list of MMS Campaigns for that account. Returned data consists of the campaign ID from our system, campaign name, and campaign reference ID.

Request: XML

<REQUEST>
    <ACTION>getMessagingCampaigns</ACTION>
    <API_KEY>apiKey</API_KEY>
</REQUEST>

Request: GET

API_URL?action=getmessagingcampaigns
&api_key=API key

Request Parameters:

Mandatory: action, api_key
Optional: N/A

Response Parameters:

status, messagingcampaigns, campaign, id, name, reference, errorCode, errorInfo

Request Example: XML

<REQUEST>
    <ACTION>getMessagingCampaigns</ACTION>
    <API_KEY>qTFkykO9JTfahCOqJ0V2Wf5Cg1t8iWlZ</API_KEY>    
</REQUEST>

Request Example: GET

https://secure.skycore.com/API/wxml/1.3/index.php?action=getmessagingcampaigns
&api_key=qTFkykO9JTfahCOqJ0V2Wf5Cg1t8iWlZ

Response Example: Success

<RESPONSE>
    <STATUS>Success</STATUS>
    <MESSAGINGCAMPAIGNS>
        <CAMPAIGN>
            <ID>1233</ID>
            <NAME>Winter Sale</NAME>
            <REFERENCE>Campaign01</REFERENCE>
        </CAMPAIGN>
        <CAMPAIGN>
            <ID>1234</ID>
            <NAME>Summer Sale</NAME>
            <REFERENCE>Campaign02</REFERENCE>
        </CAMPAIGN>
        <CAMPAIGN>
            <ID>1235</ID>
            <NAME>Store opening</NAME>
            <REFERENCE>Campaign03</REFERENCE>
        </CAMPAIGN>
    </MESSAGINGCAMPAIGNS>
</RESPONSE>

Response Example: Failure

<RESPONSE>
    <STATUS>Failure</STATUS>
    <ERRORCODE>E405</ERRORCODE>
    <ERRORINFO>No Messaging Campaigns were created in this account</ERRORINFO>
</RESPONSE>

General Error Codes:

Code Description
E100 Invalid request. Make a valid request via GET/POST/XML with all the required variables.
E104 User Authentication Failed.
E105 This account has no API rights.
E106 You can call API every X seconds.
E107 This account has no rights to use this action.
E108 XML Parse error: $error.
E109 API not activated.
E112 IP was not whitelisted. API call rejected.
E113 Set throughput exceeded for this API action. API call rejected.
E114 Phone number is blacklisted. API call rejected.
E120 Account has reached the API request limit.
E503 Internal error.


Code Description
E405 No Messaging Campaigns were created in this account


Key Term Definitions:

Term Description
ACTION This is the name of the function you want to execute with the API.
API_KEY Random key that is assigned to an account that can be used for authorization instead of USER/PASS. You can find and regenerate this key on the ‘API Settings’ page.
ID The campaign ID from our system.
NAME The name of the campaign.
REFERENCE The campaign reference ID (string).