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 | VIEWER, MANAGER or OWNER if the user belongs to the reseller that owns the subscription. RESELLER if the subscription belongs to the reseller or a sub reseller. RESELLER_ADMIN or ADMIN (required for common subscriptions). |
|
| Param | SUBSCRIPTION_ID | Id of the employee subscription (24 hex-char string) |
Query example
https://api.telecomx.dk/employeeSubscription/650000000000000000000001/subscribers
Response
| JSON object | ||
|---|---|---|
| Array | Array of e-mail addresses for the subscribers. | |
| sms | Array | Array of mobile phone numbers for the subscribers, normalized to E.164. Only subscribers with a valid phone number are included. |
Example
{ "email": [ "donald@example.com", "goofy@example.com" ], "sms": [ "+4512345678", "+4512345679" ] }
Errors
| Error code | Message | Description |
|---|---|---|
| 422 | id | Subscription id is not valid |
| 404 | employeeSubscription | Employee subscription not found |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/employeesubscription/subscribers.txt · Last modified: by Mikkel Meerwaldt Jørgensen