Call Status

This method provides insights about call details and will be sent to your statusURL. Your statusURL will be configured on the sub-account level as a part of the provisioning process.

When receiving status updates for ongoing calls, the 8x8 platform will POST a JSON object to your statusURL.

The JSON object will contain the following values:

sessionId

String

Unique id that represents call masking session [UUID]

callId

String

Id unique to a one call leg of the number masking session [UUID]

eventType

String

Event type represents the life cycle status of the call. CALL_RECEIVED or DTMF_RECEIVED

sourceMsisdn

String

Number of the calling party in E.164 format. This should be the Virtual Number allocated to your sub-account

targetMsisdn

String

Number of the called party in E.164 format (The second user's number).

direction

Number

0 for Inbound call, 1 for Outbound call

referenceId

String

The referenceId that you want set up for the number masking session.

timestamp

Timestamp

Timestamp of a call event

status

String

“call status, CONNECTED / NOT_CONNECTED”,

duration

Integer

Call duration in seconds

dtmf

String

Calling user's dial-pad inputs in the number masking session.

sipStatus

Integer

Final Sip status code for the call leg(s) defined by RFC 3261

Additional parameters could be included depending on individual destination or account requirements.
Example of a JSON object sent to your handleURL:

{
  "callId": "a595f7d6-efec-11e9-b999-7bd38233f548", 
  "sessionId": "a1d6a5e2-efec-11e9-b999-efc71013a78f",
   "eventType": "CALL_INITIATED",
  "direction": 1,
  "timestamp": "2019-10-16T08:12:02Z", 
  "sourceMsisdn": "6512345678", 
  "targetMsisdn": "6587654321",
   "country": "SG",
  "status": "NOT_CONNECTED", 
  "duration": 7,
  "sipStatus": 200,
}

Response

Your endpoint should respond with 200 OK status.