api:pbx:app:notification-send-callerid
Table of Contents
API : PBX : APP : Notification send caller ID
Introduction
This request is invoked by PBX servers to inform app clients that a call is about to arrive. Used to relay the callers name.
Request
| URL | https://api.telecomx.dk/pbx/app/notification/send/callerid | ||
|---|---|---|---|
| Method | POST | ||
| Access level | PBX servers only | ||
| Body | queue | Object | Present if call is handled by a queue |
| queue.id | Id | Id of queue the call is handled by. | |
| queue.name | String | Name of queue the call is handled by. | |
| mvnoAccount | Id | Id of the MVNO account that this call is for. | |
| extension | Id | Id of the PBX extension this call is for. | |
| callerNumber | String | Phone number of the caller - E.164 format. | |
| callerName | String | Name of the caller - if available. | |
Request example
{ "queue": { "id": "12345678901234567890AAAA", "name": "Support queue" }, "mvnoAccount": "12345678901234567890BBBB", "extension": "12345678901234567890CCCC", "callerNumber": "+4570305050", "callerName": "Telecom X" }
Response
| Json object | ||
|---|---|---|
| success | Boolean | True on success |
Example
{ "success": true }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/pbx/app/notification-send-callerid.txt · Last modified: 2019/08/09 09:53 by Per Møller