Get Messaging Campaigns API

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:

Related Error Codes:

Key Term Definitions: