Table of Contents

API : Customer Call Notifier List

Introduction

This request will return the list of endpoints that gets notified about call events.

Request

URL https://api.telecomx.dk/customer/CUSTOMER_ID/callnotify
Method GET
Access level VIEWER, MANAGER or OWNER if user belongs to the customer.
RESELLER if customer belongs to the reseller.
ADMIN
Param CUSTOMER_ID Id of the customer, (24 hex-char string).

Query examples

https://api.telecomx.dk/customer/1234567890ABCDEF12345678/callnotify

Response

The response is an array of call notify items. Each item has the following properties.

JSON object
_id Id Unique call notify id
url String URL to call on event Format: <protocol>://<host>:<port>/<path>?<args>
Protocols: http, https, tcp or udp
Host: hostname or IP address
Port: port number (not required for http and https)
Path: URI Path, if required (does not apply to tcp and udp)
Args: if additional args are needed e.g. for authentication (does not apply to tcp and udp)
method String Method for sending data to the subscriber:
POSTARGS: Send as POST/body data, e.g. a=1&b=2.
POSTXML1: Send as POST/body XML in common telecom provider format.
POSTXML2: Send as POST/body XML in common telecom provider format with additional data.
POSTJSON: Send as POST/body JSON data.
GET1: Send as URI arguments in common telecom provider format.
GET2: Send as URI arguments in common telecom provider format with additional data.
selection String Which type of calls to send events on: SIP, MVNO or ALL.

Note that properties holding no value may be omitted from the object.

Example - normal

[
  {
    _id: '52f4fd7734697b2800000001',
    url: 'http://100.64.123.100:4000/call',
    method: 'POSTXML1',
    selection: 'MVNO'
  },
  {
    _id: '52f4fd7734697b2800000002',
    url: 'tcp://100.64.123.103:4010',
    method: 'POSTJSON',
    selection: 'ALL'
  }
]

Errors

Error code Message Description
403 access_denied Insufficient access level
404 customer Customer not found
500 internal_error <unspecified>