×

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

GET

https:/<sub_domain>/v2/integrations/call/inbound_call/{appId}

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

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

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

 

 

 

Payload sent to App Setting API based upon call status:

{
  "CustomerId": "5f05a1ba-5564-4dfd-ac43-3e1f3e47c23d",
  "AppId": "977b0073-c11f-4bdd-ba8a-5c040a103d47",
  "CallSid": "500eac55f3d358ebaacb2b065ffc173r",
  "ExotelAccountSid": "exotel535",
  "DialWhomNumber": "07251937261",
  "VirtualNumber": "04448134021",
  "Direction": "incoming",
  "CallStatus": "busy", //CallStatus will be "free" once call is completed
  "CallState": "",
  "ToNumber": "04448134021",
  "FromNumber": "09938883886",
  "TotalDuration": "",
  "CallRecordings": "",
  "AccountDomain": "singapore",
  "TicketId": "",
  "CallDetail": null,
  "CreatedAt": "0001-01-01T00:00:00Z",
  "UpdatedAt": "0001-01-01T00:00:00Z"
}
  • Incoming Call Hangup
{
  "CustomerId": "5f05a1ba-5564-4dfd-ac43-3e1f3e47c23d",
  "AppId": "977b0073-c11f-4bdd-ba8a-5c040a103d47",
  "CallSid": "500eac55f3d358ebaacb2b065ffc173r",
  "ExotelAccountSid": "exotel535",
  "DialWhomNumber": "07251937261",

 

  "VirtualNumber": "04448134021",
  "Direction": "incoming",
  "CallStatus": "",
  "CallState": "",
  "ToNumber": "04448134021",
  "FromNumber": "09938883886",
  "TotalDuration": "",
  "CallRecordings": "https://s3-ap-southeast-1.amazonaws.com/exotelrecordings/exotel535/500eac55f3d358ebaacb2b065ffc173r.mp3",
  "AccountDomain": "singapore",
  "TicketId": "",
  "CallDetail": null,
  "CreatedAt": "0001-01-01T00:00:00Z",
  "UpdatedAt": "0001-01-01T00:00:00Z"
}

{
  "CustomerId": "5f05a1ba-5564-4dfd-ac43-3e1f3e47c23d",
  "AppId": "977b0073-c11f-4bdd-ba8a-5c040a103d47",
  "CallSid": "0123a667c9d4e7fb82d7317e4aeb173r",
  "ExotelAccountSid": "exotel535",
  "DialWhomNumber": "07251937261",
  "VirtualNumber": "04448134021",
  "Direction": "incoming",
  "CallStatus": "",
  "CallState": "",
  "ToNumber": "04448134021",
  "FromNumber": "09938883886",
  "TotalDuration": "31",
  "CallRecordings": "",
  "AccountDomain": "singapore",
  "TicketId": "",
  "CallDetail": null,
  "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.