Read Event Subscriptions

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200OK

application/json

Body

array of:

string

required

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

model

enum<string>

optional

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

Allowed values:

agentauditlogauditlog_litecallcall_origidcdrmessagemessagesessionsubscriberpresencevoicemail

post-url

string <url>

optional

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.

Example:

https://webhook.example.com/event

subscription-geo-support

enum<string>

optional

Enable this setting to allow the subscription to fail over to a different server if the cluster bleieves it to be offline.

Allowed values:

yesno

Default:

yes

user-scope

enum<string>

optional

This is the scope that should be enforced in combination with the reseller, domain and user fields. it will be set using the scope used to create the subscription.

Allowed values:

Basic UserSimple UserAdvanced UserCall Center AgentSite ManagerCall Center SupervisorOffice ManagerResellerSuper UserNDPNo Portal

Default:

Basic User

reseller

string

optional

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.

domain

string

optional

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

Default:

user

string

optional

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

Default:

subscription-creation-datetime

string <date-time>

optional

This is a timestamp of creation of the event subscrtipion.

subscription-expires-datetime

string <date-time>

optional

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-server

string <hostname>

optional

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.

Example:

core1.example.com

current-active-server

string <hostname>

read-onlyoptional

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.

Example:

core1.exmaple.com

status

enum<string>

read-onlyoptional

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.

Allowed values:

pendingactiveerror

error-count

integer

optional

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-count

integer

optional

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

[
  {
    "id": "string",
    "model": "agent",
    "post-url": "https://webhook.example.com/event",
    "subscription-geo-support": "yes",
    "user-scope": "Basic User",
    "reseller": "string",
    "domain": "*",
    "user": "*",
    "subscription-creation-datetime": "2019-08-24T14:15:22Z",
    "subscription-expires-datetime": "2019-08-24T14:15:22Z",
    "preferred-server": "core1.example.com",
    "current-active-server": "core1.exmaple.com",
    "status": "pending",
    "error-count": 0,
    "posts-count": 0
  }
]

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required

Request

Request samples

Responses