×

It allows users to get a notification on their dashboard screen, whenever any Incoming call comes to their customer-facing Exotel number.

GET

https://integrationscore.mum1.exotel.com/v2/integrations/call/inbound_call/{appId}?type={}

You can use our official postman collection to try out the APIs.

 

Type Purpose
popup To create notification for incoming call pop up
incomingcallhungup To create notification when the incoming call ends
missedcall To create notification for missed call

A sample Type is defined in the below Example request.

  • Example Request
curl --location -g --request GET 'https://integrationscore.mum1.exotel.com/v2/integrations/call/inbound_call/{appId}?type={popup}'
  • Example Response
{
    "RequestId": "5be38737-4a1c-4b29-9ede-b81ad2d702b6",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": "Success"
}

 

Statuscallback sent for Incoming call notification:

{
"CustomerId": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0",
"AppId": "86fb2b8b-da8a-4649-a82c-db976b934c64",
"CallSid": "7bea36f8c95f0fb10027daa6acee17c1",
"ExotelAccountSid": "exotelveenotesting1m",
"DialWhomNumber": "",
"AppUserID": "ajay",
"VirtualNumber": "+912235511457",
"Direction": "inbound",
"CallStatus": "",
"CallState": "active",
"ToNumber": "07251937261",
"FromNumber": "08789489697",
"TotalDuration": 0,
"CallRecordings": "",
"AccountDomain": "mumbai",
"TicketId": "",
"CallDetail": "recording_stop_success",
"CreatedAt": "0001-01-01T00:00:00Z",
"UpdatedAt": "0001-01-01T00:00:00Z"
}
  • IncomingCallHungup
{
  "CustomerId": "4fbf5724-e6e3-4e40-bfc1-70d3ccf64618",
  "AppId": "37b4f1cc-26c7-4fa2-bcd2-c19dbd8099d6",
  "CallSid": "e282636aa9c373307bbd223f6eb417c4",
  "ExotelAccountSid": "exotel535",
  "DialWhomNumber": "sip:victor58e267c1",
  "AppUserID": "92099XXXX",
  "VirtualNumber": "080486XXXXX",
  "Direction": "incoming",
  "CallStatus": "free",
  "CallState": "",
  "ToNumber": "080386XXXXX",
  "FromNumber": "077708XXXX",
  "TotalDuration": 0,
  "CallRecordings": "",
  "AccountDomain": "Mumbai",
  "TicketId": "",
  "CallDetail": "",
  "CreatedAt": "0001-01-01T00:00:00Z",
  "UpdatedAt": "0001-01-01T00:00:00Z"
}

{
  "CustomerId": "4fbf5724-e6e3-4e40-bfc1-70d3ccf64618",
  "AppId": "37b4f1cc-26c7-4fa2-bcd2-c19dbd8099d6",
  "CallSid": "e282636aa9c373307bbd223f6eb417c4",
  "ExotelAccountSid": "exotel535",
  "DialWhomNumber": "sip:victor58e267c1",
  "AppUserID": "92099XXXX",
  "VirtualNumber": "080486XXXXX",
  "Direction": "incoming",
  "CallStatus": "free",
  "CallState": "",
  "ToNumber": "080386XXXXX",
  "FromNumber": "077708XXXX",
  "TotalDuration": 0,
  "CallRecordings": "",
  "AccountDomain": "Mumbai",
  "TicketId": "",
  "CallDetail": "",
  "CreatedAt": "0001-01-01T00:00:00Z",
  "UpdatedAt": "0001-01-01T00:00:00Z"
}

 

Status Codes

Status codes are as follows - 

Status Code

Description

200

Call Intimated successfully.

401

Unauthorized

400

Invalid parameters.

500

Internal server error. There was an issue getting call.

 

Outbound Call notification

Whenever an Outbound call is made callback will be sent on the webhook url under AppSetting with the below details.

{
  "CustomerId": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0",
  "AppId": "86fb2b8b-da8a-4649-a82c-db976b934c64",
  "CallSid": "7bea36f8c95f0fb10027daa6acee17c1",
  "ExotelAccountSid": "exotelveenotesting1m",
  "DialWhomNumber": "",
  "AppUserID": "ajay",
  "VirtualNumber": "+912235511457",
  "Direction": "outbound",
  "CallStatus": "",
  "CallState": "active",
  "ToNumber": "07251937261",
  "FromNumber": "08789489697",
  "TotalDuration": 0,
  "CallRecordings": "",
  "AccountDomain": "mumbai",
  "TicketId": "",
  "CallDetail": "recording_stop_success",
  "StartTime": "2023-12-04T23:02:19Z",
  "EndTime": "2023-12-04T23:02:19Z",
  "CreatedAt": "0001-01-01T00:00:00Z",
  "UpdatedAt": "0001-01-01T00:00:00Z"
}