Get a single subscription
Beta/Early Access Program
This API is in the Beta/Early Access Program and is still under development. If you are interested in using this API, please contact your Customer Success Manager or Account Manager. Participation in this pilot program is at the discretion of Product Management and not guaranteed.
Use of this API outside of the program is prohibited.
GET /subscriptions/{subscriptionId} endpoint returns information about a single subscription.
Most URLs in the example code use the following values:
- ***. To access the API for your region, replace *** with the correct subdomain for your region:
Region URL subdomain Base URL EMEA emea https://emea.api.newvoicemedia.com USA nam https://nam.api.newvoicemedia.com APAC apac https://apac.api.newvoicemedia.com - <ACCESS_TOKEN>. The value represents a bearer access token which you must use to validate every request. Replace <ACCESS_TOKEN> where used with your bearer access token. For information about getting a bearer access token, see How to authenticate with a Vonage Contact Center (VCC) API.
Headers
Header parameters in Requests (Webhooks API) apply to this endpoint.
Authorization scopes required:
| Scope |
|---|
admin:read |
Parameters
The endpoint accepts the following path parameter:
subscriptionId
| Type | Required | Example |
|---|---|---|
| String | True | 2V1d4FfmK5ho8aiomIwP9QdpQjv |
The unique identifier for the subscription.
Requests
Requests a single subscription
curl -L -X GET "https://***.api.newvoicemedia.com/webhooks/subscriptions/2V1dP1RidyufqyPHlng0VJpGF3i" \ -H "Authorization: bearer <ACCESS_TOKEN>" \ -H "Accept: application/vnd.newvoicemedia.v1+json"
Responses
Response returns a single subscription, if one is found with the same subscription ID.
Successful response
Success response code and parameters in Requests (Webhooks API) apply to a successful response.
Example response
{
"subscriptionId": "2V1EhIxvsBPpnqf6Hqv9mtPZx1a",
"name": "My app",
"url": "https://your-application.com/webhooks/events",
"events": [
"agent.presencechanged.v0"
],
"enabled": true
}
The subscription contains the following parameters:
subscriptionId— The unique identifier for the subscription. This ID can be used to edit or delete the subscription.name— The name for the subscription, specified during the creation of the subscription. The name is unique.url— The URL that the webhook events are sent to.events— A list of the event types that are subscribed to and are sent to the URL. Each item in the list is the name of an event type.enabled— Indicates whether the subscription is enabled. Notifications are only sent to the URL if the subscription is enabled.
For information, see Trying out Vonage Contact Center APIs.