API Reference

Create a Event Subscription

post
https://{server}/ns-api/v2/subscriptions
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum

This is the type of data that will be sent. you will need to reqest multiple subscriptions if you want more than one model. Addtional details available in guide at https://docs.ns-api.com/docs/event-subscriptions-1

url

This is the url the API will be posting data to. Should be in the format including https://. Can make a custom port if needed and the URL should have a valid SSL certificate as well. Http:// is supproted but not ideal for production.

string
enum
Defaults to yes

When enabled this setting will turn on voicemail for the user.

Allowed:
string

This is the reseller that the subscription will filter data for. * will be used for all resellers, but only valid with Super User scope on the request.

string
Defaults to *

This is the domain that the subscription will filter data for. "*" will be used for all domains, but only valid with Super User scope

string
Defaults to *

This is the user that the subscription will filter data for. * will be used for all users.

date-time

This timestamp in the format of YYYY-MM-DD HH:MM:SS will be with the subscription will expire. After it expires it will be removed after some amount of time. If left blank it will set the expires time to the expires time of the timed token used, if using a APIkey it will be 20 years from the creation date that it will set for the expires for the new subscription

string

This is the server hostname for the prefered server for this subscription, meaning if this server is up and online it will be the one sending the events. It wil fail back to this servre after 60s of stability.

Responses

Updated 8 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago