api:employeesubscription:subscribers
Table of Contents
API : Employee Subscription Subscribers
Introduction
This request will return the list of subscribers to a given employee subscription. This is used to fetch the list of e-mail addresses to send e-mail to or phone numbers to send SMS messages to.
Request
| URL | https://api.telecomx.dk/employeeSubscription/SUBSCRIPTION_ID/subscribers | |
|---|---|---|
| Method | GET | |
| Access level | RESELLER if employee subscription belongs to the reseller or a subreseller ADMIN. |
|
| Param | SUBSCRIPTION_ID | Id of the employee subscription (24 hex-char string) |
Query example
https://api.telecomx.dk/employeeSubscription/1234567890ABCDEF12345678/subscribers
Response
| JSON object | ||
|---|---|---|
| Array | Array of e-mail addresses for the subscribers, if the employee subscription uses e-mail. | |
| sms | Array | Array of mobile phone numbers for the subscribers, if the employee subscription uses SMS notification. |
Example
{ email: [ 'donald@disney.com', 'goofy@disney.com' ], sms: [ '+4512345678', '+4512345679' ] }
Errors
| Error code | Message | Description |
|---|---|---|
| 400 | employeeSubscription | Employee subscription id not found in arguments |
| 404 | employeeSubscription | Employee subscription not found |
| 403 | access_denied | Insufficient access level |
api/employeesubscription/subscribers.txt · Last modified: 2014/07/03 11:59 by Per Møller