Since 1.0.36 (Release 10.2)
Event filter /restapi/v1.0/account/{accountId}/telephony/sessions enables notifications in case of change of session information for any extension assigned to the current account.
The client receives the detailed call notification payload as a JSON object.
Required Permissions
| Permission |
Description |
CallControl |
Creating and managing telephony sessions |
Query Parameters
| Parameter |
Type |
Description |
direction |
'Outbound' or 'Inbound' |
Allows to send notifications only on call(s) with a specified direction |
missedCall |
boolean |
Allows to send notifications only on missed call(s) event |
phoneNumber |
string |
Allows to send notifications only on call(s) to/from a certain phone number; e.164 format with '+' sign is supported |
sipData |
boolean |
Enables detailed notifications with SIP information |
statusCode |
'Setup' or 'Proceeding' or 'Answered' or 'Disconnected' or 'Gone' or 'Parked' or 'Hold' or 'VoiceMail' or 'FaxReceive' or 'VoiceMailScreening' |
Enables notifications on call sessions with a particular status. It is possible to subscribe to multiple statuses via different event filters |
withRecordings |
boolean |
Allows to filter and return telephony sessions with recordings only |
Event payload
| Parameter |
Type |
Description |
sequence |
integer |
Order number of a notification to state the chronology |
sessionId |
string |
Legacy identifier of a call session |
telephonySessionId |
string |
Call session identifier, required for Telephony API |
serverId |
string |
Identifier of a server |
eventTime |
string |
The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z |
origin |
Session Origin Details |
Session Origin Details |
parties |
Session Parties Details |
Call participants details |
Session Origin Details
| Parameter |
Type |
Description |
type |
string |
The reason of Session creation. Could be 'Call' or 'RingOut' or 'RingMe' or 'Conference' or 'GreetingsRecording' or 'VerificationCall' or 'TestCall' |
Session Parties Details
| Parameter |
Type |
Description |
accountId |
string |
Internal identifier of an account |
extensionId |
string |
Internal identifier of an extension |
id |
string |
Internal identifier of a party, globaly unique |
direction |
'Inbound' or 'Outbound' |
Technical call direction. 'Inbound' direction often means the call in the party context is initiated from RC to Customer endpoint. 'Outbound' is vice versa, e.g. User make outbound call from any of RC application. |
to |
Callee Info |
Callee Info |
from |
Caller Info |
Caller Info |
status |
Session Status Info |
Session Status Info |
missedCall |
boolean |
If 'True' means the call was missed by the party |
standAlone |
boolean |
Indicates whether the call party is standalone or not |
muted |
boolean |
If 'True' means the party is muted |
conferenceRole |
'Host' or 'Participant' |
Defines party role in Server Side Conference |
sipData |
SIP Info |
SIP (Session Initiation Protocol) information. Returned if query parameter sipData is set to 'True' |
Callee Info
| Parameter |
Type |
Description |
phoneNumber |
string |
Callee Phone number in E.164 (with '+' sign) format |
name |
string |
Callee Name |
extensionId |
string |
Internal identifier of a Callee extension |
deviceId |
string |
Internal identifier of a device |
Caller Info
| Parameter |
Type |
Description |
phoneNumber |
string |
Caller Phone number in E.164 (with '+' sign) format |
name |
string |
Caller Name |
extensionId |
string |
Internal identifier of a Caller extension |
deviceId |
string |
Internal identifier of a device |
Session Status Info
| Parameter |
Type |
Description |
code |
string |
State Code for the party |
reason |
'Pickup' or 'Supervising' or 'TakeOver' or 'Timeout' or 'BlindTransfer' or 'RccTransfer' or 'AttendedTransfer' or 'CallerInputRedirect' or 'CallFlip' or 'ParkLocation' or 'DtmfTransfer' or 'AgentAnswered' or 'AgentDropped' or 'Rejected' or 'Cancelled' or 'InternalError' or 'NoAnswer' or 'TargetBusy' or 'InvalidNumber' or 'InternationalDisabled' or 'DestinationBlocked' or 'NotEnoughFunds' or 'NoSuchUser' or 'CallRedirected' or 'CallReplied' or 'CallFinished' or 'CallDropped' or 'Voicemail' |
Reason for a call status, might be specified for some codes |
parkData |
string |
Appears in 'Parked' state. |
peerId |
Linked Session Details |
Contains details of the 'linked' session. Appears in 'Gone' state code |
mobilePickupData |
Mobile Pickup Data |
Appears if the user configured to answer the call via Desktop/Mobile application |
SIP Info
| Parameter |
Type |
Description |
toTag |
string |
Recipient data |
fromTag |
string |
Sender data |
callId |
string |
SIP call identifier |
Linked Session Details
| Parameter |
Type |
Description |
sessionId |
string |
Legacy identifier of a linked call session |
telephonySessionId |
string |
Call session identifier, required for Telephony API |
partyId |
string |
Party identifier of a linked call session |
Mobile Pickup Data
| Parameter |
Type |
Description |
ccMailboxes |
string |
List of extension IDs, configured to pick a call from Desktop/Mobile applications |
to |
string |
SIP proxy registration name |
sid |
string |
User data |
srvLvl |
string |
User data |
srvLvlExt |
string |
User data |
Example
{
"uuid": "837270960869181944",
"subscriptionId": "5c37f936-fa66-4b4b-95af-1e94b51a748d",
"ownerId": "400144455008",
"pn_apns": {
"aps": {
"content-available": 1
},
"uuid": "837270960869181944",
"event": "/restapi/v1.0/account/400144452008/extension/400144455008/telephony/sessions",
"timestamp": "2018-06-05T00:14:50.181Z",
"subscriptionId": "5c37f936-fa66-4b4b-95af-1e94b51a748d",
"ownerId": "400144455008",
"body": {
"sequence": 5,
"sessionId": "402936341008",
"telephonySessionId": "Y3MxNzE4NDE5MDM0MzQwMTgzODRAMTAuNjIuMjUuMTEx",
"serverId": "10.62.25.111.TAM",
"eventTime": "2018-06-05T00:14:50.147Z",
"accountId": "400144452008",
"parties": [{
"sipData": {
"callId": "555555555555",
"toTag": "123",
"fromTag": "456"
},
"extensionId": "400144455008",
"id": "cs171841903434018384-2",
"direction": "Inbound",
"to": {
"phoneNumber": "102",
"name": "Tom Sawyer",
"extensionId": "400144455008"
},
"from": {
"phoneNumber": "103",
"name": "TheCat Jerry",
"extensionId": "400144457008"
},
"status": {
"code": "Proceeding",
"mobilePickupData": {
"ccMailboxes": [
"400144455008"
],
"to": "#[email protected]:5060",
"sid": "402936472080",
"srvLvl": "-149699523",
"srvLvlExt": "390"
}
},
"missedCall": false,
"standAlone": false,
"muted": false
}],
"origin": {
"type": "Call"
},
"extensionId": "400144455008"
}
}
}
