Endpoint	/subscriptions
Method	POST
Scopes	calls.events
	calls.events.personal
	calls.events.presence

Requests a new subscription according to the settings provided in the request body. Settings include filters to specify which types and for which agents you would like to receive.

The available parameters are:

Parameter	Type	Pattern	Description
id	string	[a-f0-9]{32}	A 128 bits hex describing the subscription
event_types	array		Optional. A list of events to which you are subscribed. Default is ["created", "ringing", "answered", "terminated"]. Also refer to “Available events”.
agents	array		Optional. A list of agents (extensions) to which you are subscribed. Default is [{"number": "*"}].
agents[].field	enum	*\|from\|to	Optional. The field in which to search for the number or extension_id. * means both in from (caller) and to (callee).
agents[].number	string	\d{3, 15}	Optional. The internal number of an extension (user or dialplan) you want to subscribe to. * means all
agents[].extension_id	string	[a-f0-9]{32}	Optional. A 128 bits hex describing the specific extension you want to subscribe to. * means all
mode	enum	(presence\|detailed)	Optional. Default is “presence”. Presence will contain limited information about the calls and is used for BLF functionality. Detailed will contain extended information about the call and parties involved.
callback_url	string	.*	Notifications will be POSTed to this URL. This URL should be a full path, including protocol and domain.
callback_content_type	enum	application/json	Optional. The content type of the notifications. Currently only application/json is supported.

In case of success the response code is 200 OK, 201 Created or 202 Accepted. The body contains the just created subscription.

In case of an error, the response code is anything other than 200 OK. The body may contain a JSON object describing the error:

Parameter	Type	Description
status_code	number	HTTP Status Code
error_code	string	Optional. Error code
message	string	Optional. A description of the error code

Known error codes are:

HTTP code	Error code	Description
400	validation	A validation error on the input occurred
401	invalid_grant	Authorization grant is invalid or expired
403	access_denied	No permission to access the required scopes

Realtime API