NSns-api
Event Subscriptions

Read Event Subscriptions for Domain

Changed on
get/domains/{domain}/subscriptions

Request

  • Base URL
    https://ns-api.com/ns-api/v2
  • URL
    https://ns-api.com/ns-api/v2/domains/{domain}/subscriptions
  • Auth
    HTTP bearer

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com

Response

idstring required

This is the main subscription id. This will be needed to edit and delete the subscription.

model'agent' | 'auditlog' | 'auditlog_lite' | 'call' | 'call_origid' | 'cdr' | 'message' | 'messagesession' | 'subscriber' | 'presence' | 'voicemail'

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

post-urlstring 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.

subscription-geo-support'yes' | 'no'
user-scope'Basic User' | 'Simple User' | 'Advanced User' | 'Call Center Agent' | 'Site Manager' | 'Call Center Supervisor' | 'Office Manager' | 'Reseller' | 'Super User' | 'NDP' | 'No Portal'

Will link this resource with a User Scope granting it certain permisionf to the system for use in API and Portal.

resellerstring

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.

domainstring

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

userstring

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

subscription-creation-datetimestring date-time

This is a timestamp of creation of the event subscrtipion.

subscription-expires-datetimestring 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

preferred-serverstring hostname

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.

current-active-serverstring hostname

This is the current server that is running this schedule. It will chagne only when a new server takes over and is a read only field.

status'pending' | 'active' | 'error'

This is the status of the schedule. A new schedule will get "pending" till it gets some data to send and once successfull it will go to "active". If any attempts get a error over a interval it will toggle this field to "error" and reset only once it gets a clean interval of posts.

error-countinteger

This is the number of attempted post's that resulted in a error, either an inability to send to a server (network,dns, timeout, etc..) or a response code that is above a 302. This value can be "reset" by setting it to 0 in a update request, but only 0 is allowed value.

posts-countinteger

This is the number of attempted post's in this schedule. This includes error and success attempts. This value can be "reset" by setting it to 0 in a update request, but only 0 is allowed value.

Example response

[
  {
    "post-url": "https://webhook.example.com/event",
    "preferred-server": "core1.example.com",
    "current-active-server": "core1.exmaple.com"
  }
]

Changes