api:customer:callnotify-get
Table of Contents
API : Customer Call Notifier Get
Introduction
This request will return a single call notify item.
Request
| URL | https://api.telecomx.dk/customer/CUSTOMER_ID/callnotify/CALL_NOTIFY_ID | |
|---|---|---|
| Method | GET | |
| Access level | VIEWER, MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller or a sub reseller. RESELLER_ADMIN. ADMIN. |
|
| Param | CUSTOMER_ID | Id of the customer, (24 hex-char string). |
| CALL_NOTIFY_ID | Id of the call notify item (24 hex-char string). | |
Query examples
https://api.telecomx.dk/customer/1234567890ABCDEF12345678/callnotify/154364657846352345323534
Response
| 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": "650000000000000000000701", "url": "https://api.example.dk/call-events", "method": "POSTJSON", "selection": "ALL" }
Errors
| Error code | Message | Description |
|---|---|---|
| 422 | customer | Customer id is invalid |
| 422 | id | Call notify id is invalid |
| 403 | access_denied | Insufficient access level |
| 404 | not_found | Call notify not found |
| 500 | internal_error | <Unspecified> |
api/customer/callnotify-get.txt · Last modified: by Mikkel Meerwaldt Jørgensen