KB Newsman
Newsman API Listing
Sms | |||
| API Method | HTTP method | Endpoint | Description |
|---|---|---|---|
| sms.getCurrentCreditsNumber | GET | /sms.getCurrentCreditsNumber.json | Returns the number of currently available SMS credits |
| sms.lists | GET | /sms.lists.json | Returns a hash array with all available lists of type SMS |
| sms.sendone | POST | /sms.sendone.json | Send one text SMS message to a recipient |
| sms.getByTelephone | GET | /subscriber.getByTelephone.json | Returns subscriber data as hash (struct) array |
| sms.saveSubscribe | POST | /sms.saveSubscribe.json | Saves / subscribes a subscriber to the list |
| sms.saveUnsubscribe | POST | /subscriber.saveUnsubscribe.json | Unsubscribes a telephone from a list |
| sms.getCampaignProps | GET | /sms.getCampaignProps.json | Returns a hash array with the properties of a campaign |
| sms.getCampaignProp | GET | /sms.getCampaignProp.json | Returns the specified property of a campaign |
| sms.updateCampaignProps | POST | /sms.updateCampaignProps.json | Updates the properties of a campaign |
| sms.updateCampaignProp | POST | /sms.updateCampaignProp.json | Updates one property of a campaign |
| sms.pauseCampaign | POST | /sms.pauseCampaign.json | Pauses a sending campaign |
| sms.resumeCampaign | POST | /sms.resumeCampaign.json | Resumes a paused campaign |
| sms.scheduleCampaign | POST | /sms.scheduleCampaign.json | Schedules a campaign to be sent in the future |
| sms.cancelCampaign | POST | /sms.cancelCampaign.json | Cancels a campaign |
| sms.confirmCampaign | POST | /sms.confirmCampaign.json | Confirms a campaign via API |
| sms.sendCampaignConfirm | POST | /sms.sendCampaignConfirm.json | Sends a newsletter confirmation mail |
| sms.createCampaign | POST | /sms.createCampaign.json | Creates a new campaign in this list |
| sms.getCampaignSegments | GET | /sms.getCampaignSegments.json | Returns a hash array with the segments of a campaign |
| sms.getCampaignExcludedSegments | GET | /sms.getCampaignExcludedSegments.json | Returns a hash array with the excluded segments of a campaign |
| sms.setCampaignSegments | POST | /sms.setCampaignSegments.json | Updates the segments of a campaign |
| sms.setExcludedCampaignSegments | POST | /sms.setExcludedCampaignSegments.json | Updates the excluded segments of a campaign |
| sms.allCampaigns | GET | /sms.allCampaigns.json | Returns a list of campaigns with status $status between $start_date, $stop_date (inclusive) |
| sms.campaignStats | GET | /sms.campaignStats.json | Returns stats for the specified campaign |
| sms.campaignLinksClicked | GET | /sms.campaignLinksClicked.json | Returns links clicked for the specified campaign |
| sms.restartCampaign | POST | /sms.restartCampaign.json | Restarts a cancelled / sent campaign |
| sms.campaignSubscribersHistory | GET | /campaign.subscribersHistory.json | Returns an array with the history entries for the subscribers of a campaign |
| sms.campaignStatusActions | GET | /sms.campaignStatusActions.json | Returns info about the campaign status and actions which may be taken |