Table of Contents
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 Parameters:
| Term | Mandatory/Optional | Description |
|---|---|---|
| ACTION | Mandatory | This is the name of the function you want to execute with the API. |
| API_KEY | Mandatory | 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. |
Response Parameters:
| Param Name | Presence | Description |
| STATUS | Always | “Success” or “Failure”. |
| MESSAGINGCAMPAIGNS | Success response only | The list of messaging campaigns for the account. |
| MESSAGINGCAMPAIGNS:CAMPAIGN | Success response only | The messaging campaign details including campaign ID, campaign name, and campaign reference. |
| MESSAGINGCAMPAIGNS:CAMPAIGN:CAMPAIGNID | Success response only | The campaign ID. |
| MESSAGINGCAMPAIGNS:CAMPAIGN:NAME | Success response only | The name of the campaign. |
| MESSAGINGCAMPAIGNS:CAMPAIGN:REFERENCE | Success response only | The campaign reference. |
| ERRORCODE | Error response only | Error code associated with the error. |
| ERRORINFO | Error response only | Error message explaining the error code. |
Request Example: XML
<REQUEST>
<ACTION>getMessagingCampaigns</ACTION>
<API_KEY>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</API_KEY>
</REQUEST>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. |
Related Error Codes:
| Code | Description |
|---|---|
| E405 | No Messaging Campaigns were created in this account |