/pps/services/phone/private/calls/call_id

Call status attributes (private)

Publishers
Phone service
Subscribers
Clients of the phone service that have permission to access the private control object. Attributes published to /pps/services/phone/public/calls/call_id are also published here.

Attributes

Attribute Data type Values Description
call_actions JSON array
An array of one or more of the following values:
  • mute_call—mute the call
  • unmute_call—unmute the call
  • answer_call—answer an incoming call
  • reject_call—reject an incoming call
  • end_call—end the call
 An array of the available actions for the current call. The actions correspond to the PPS messages.
starttime Numeric A positive integer representing the time in seconds. The time (in seconds) relative to device startup time that the call is moved to a connected state.
endtime Numeric A positive integer representing the time in seconds. The time (in seconds) relative to device startup time that the call is moved to a disconnected state.
ended_by_user Boolean true (call ended by user) or false (call ended remotely). The default is false. This attribute is published only when its value is true. Indicates whether the call was ended by the user. This flag is not set before the call is disconnected.
callernumber String A phone number (maximum 80 digits). The incoming call's phone number (the originating phone number).
privacy_indicator String
Possible values are:
  • unknown (the originating phone number is unknown)
  • private (the originating phone number is private)
 Indicate that the incoming caller number is unknown or private.
error_code String Possible values are listed in the Error codes section. The cause of a call failure.
callername String The caller's name. The caller name presentation (CNAP) data provided by the network.
muted String true (the call is muted) or false (the call isn't muted). The default is false. This attribute is published only when its value is true. Indicates whether the call is muted.
msd_status String For an eCall, indicates whether the minimum set of data (MSD) buffer was successfully uploaded to the public-safety answering point (PSAP).
  • success—The MSD buffer successfully encoded and uploaded.
  • failed—The MSD buffer was not uploaded to the PSAP.
  • invalid parameters—The encoder failed due to invalid parameters.

Error codes

general_error
There was a general call failure.
subscriber_busy
The subscriber is busy.
congestion
There is network congestion.
radio_path_unavail
The radio path is not available.
num_unobtainable
The caller number can't be obtained.
auth_failure
There was an authentication failure.
emergency_calls_only
Only emergency call can be placed from this phone.
emergency_call_not_allowed
The use of emergency calls is restricted.
outgoing_call_barred
The outgoing call was barred.
service_not_available
The network service is not available.
fdn_mismatched
There was an FDN (Fixed Dialing Number) mismatch error.
incoming_call_barred
The incoming call was barred.
call_replaced_by_stk
The call was placed by the STK (SIM toolkit).
stk_call_not_allowed
STK calls are not allowed.
no_user_responding
The user didn't respond.
user_alerting_no_answer
The user is alerting but there is no answer.
facility_clir_not_subscribed
The client isn't subscribed to CLIR (Calling Line Identification Restriction).
imsi_not_in_vlr_cause_4
The IMSI (International Mobile Subscriber Identity) isn't in the VLR (Visitor Location Register).
imei_not_accepted_cause_5
The IMEI (International Mobile Station Equipment Identity) was not accepted.
gan_error_no_mobile_nw
There is no mobile network available.
gan_error_wifi_lost
The Wi-Fi connection was lost.
gan_error_isp_issue
A failure was caused by the ISP (Internet Service Provider).
gan_error_gan_xfer_unsupported
The requested transfer operation is not supported.
redial
The redial indicator.
otasp_opr_not_allowed
The requested OTASP (Over-The-Air Service Provisioning) operation is not allowed.
outgoing_call_superseded
An incoming call took precedence over the outgoing call.
must_end_current_session
The current session must be ended before starting a call.
unknown_error
An unknown error occurred.