{"$id":"https://events-schemas.twilio.com/VoiceInsights.CallSummary/1","$schema":"http://json-schema.org/draft-07/schema#","title":"CallSummary","type":"object","description":"The call summary update event provides an overview of metadata and quality metrics for a single call.","required":["call_sid","account_sid","parent_call_sid","parent_account_sid","start_time","end_time","duration","connect_duration","call_type","call_state","processing_state","processing_version","tags"],"additionalProperties":false,"properties":{"call_sid":{"type":"string","description":"SID for the call"},"account_sid":{"type":"string","description":"The account SID this call belongs to"},"parent_call_sid":{"default":"","type":"string","description":"Parent call SID"},"parent_account_sid":{"default":"","type":"string","description":"Parent account SID"},"start_time":{"default":"","type":"string","format":"date-time","description":"Call start time"},"end_time":{"default":"","type":"string","format":"date-time","description":"Call end time"},"duration":{"default":0,"type":"integer","description":"Duration between when the call was initiated and the call was ended"},"connect_duration":{"default":0,"type":"integer","description":"Duration between when the call was answered and when it ended"},"call_type":{"default":"unknown_call_type","type":"string","description":"Describes the call type; client, carrier, sip, trunking"},"call_state":{"default":"undialed","type":"string","description":"Status of the call; completed, failed, etc."},"from":{"$ref":"#/definitions/ParticipantInfo"},"to":{"$ref":"#/definitions/ParticipantInfo"},"processing_state":{"default":"unknown_processing_state","type":"string","description":"Represents the summarization state of the resource; partial and complete"},"processing_version":{"default":0,"type":"integer","description":"Processing version"},"sip_edge":{"$ref":"#/definitions/EdgeInfo"},"carrier_edge":{"$ref":"#/definitions/EdgeInfo"},"sdk_edge":{"$ref":"#/definitions/EdgeInfo"},"client_edge":{"$ref":"#/definitions/EdgeInfo"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality."},"attributes":{"$ref":"#/definitions/Attributes"},"properties":{"$ref":"#/definitions/Properties"}},"definitions":{"ParticipantInfo":{"type":"object","description":"To/From object properties","required":["caller","callee","carrier","connection","number_prefix","city","country_code","country_subdivision","ip_address"],"additionalProperties":false,"properties":{"caller":{"default":"","type":"string","description":"Caller ID of calling party"},"callee":{"default":"","type":"string","description":"Dialed destination"},"carrier":{"default":"","type":"string","description":"Serving carrier of destination"},"connection":{"default":"unknown_connection_type","type":"string","description":"landline, mobile, voip"},"number_prefix":{"default":"","type":"string","description":"E.164 country code + three digits"},"location":{"$ref":"#/definitions/Location"},"city":{"default":"","type":"string","description":"City name based on lat/long or IP address"},"country_code":{"default":"","type":"string","description":"Two-letter ISO country code"},"country_subdivision":{"default":"","type":"string","description":"Additional location details; e.g. California"},"ip_address":{"default":"","type":"string","description":"Public IP of Client user"},"sdk":{"$ref":"#/definitions/TwilioSDK"}}},"Location":{"type":"object","description":"Location definition","required":["lat","lon"],"additionalProperties":false,"properties":{"lat":{"type":"number","description":"Latitude"},"lon":{"type":"number","description":"Longitude"}}},"TwilioSDK":{"type":"object","description":"Twilio SDK","required":["type","version","platform","region","selected_region"],"additionalProperties":false,"properties":{"type":{"default":"","type":"string","description":"Version of Twilio SDK; e.g. twilio-js-sdk. twilio-voice-android"},"version":{"default":"","type":"string","description":"Twilio SDK version"},"platform":{"default":"","type":"string","description":"WebRTC, android, iOS"},"region":{"default":"unknown_realm","type":"string","description":"The Twilio region the device registered to"},"selected_region":{"default":"","type":"string","description":"The region specified in the device setup"},"browser":{"$ref":"#/definitions/Browser"},"os":{"$ref":"#/definitions/Os"},"device":{"$ref":"#/definitions/Device"},"engine":{"$ref":"#/definitions/Engine"}}},"Browser":{"type":"object","description":"Browser","required":["name","major","version"],"additionalProperties":false,"properties":{"name":{"default":"","type":"string","description":"Name of browser for calls placed using JavaScript SDK"},"major":{"default":"","type":"string","description":"Major version of browser"},"version":{"default":"","type":"string","description":"Full version of browser"}}},"Os":{"type":"object","description":"Operating System","required":["name","version"],"additionalProperties":false,"properties":{"name":{"default":"","type":"string","description":"Operating system name as reported to the SDK"},"version":{"default":"","type":"string","description":"Operating system version as reported to the SDK"}}},"Device":{"type":"object","description":"Device definition","required":["model","type","vendor","arch"],"additionalProperties":false,"properties":{"model":{"default":"","type":"string","description":"Mobile SDKs only: model name/number reported to the SDK"},"type":{"default":"","type":"string","description":"Device type"},"vendor":{"default":"","type":"string","description":"Mobile SDKs only: hardware manufacturer reported to the SDK"},"arch":{"default":"","type":"string","description":"Processor architecture of machine running the Client app; e.g. amd64"}}},"Engine":{"type":"object","description":"Engine definition","required":["name","version"],"additionalProperties":false,"properties":{"name":{"default":"","type":"string","description":"JavaScript SDK only: browser engine as detected by the SDK"},"version":{"default":"","type":"string","description":"JavaScript SDK only: browser engine version detected by the SDK"}}},"EdgeInfo":{"type":"object","description":"EdgeInfo definition","required":["tags"],"additionalProperties":false,"properties":{"properties":{"$ref":"#/definitions/Properties"},"metrics":{"$ref":"#/definitions/MetricsContainer"},"tags":{"type":"array","items":{"type":"string"},"description":"EdgeInfo tags"},"events":{"$ref":"#/definitions/Events"}}},"Properties":{"type":"object","description":"Properties definition","required":["q850_cause","last_sip_response_num","pdd_ms","route_id","media_region","signaling_region","twilio_media_ip","twilio_signaling_ip","external_media_ip","external_signaling_ip","sip_call_id","user_agent","selected_region","region","trunk_sid","disconnected_by","direction"],"additionalProperties":false,"properties":{"q850_cause":{"default":0,"type":"integer","description":"ITU-T Q.850 standard definition of telephony disconnect cause. Not available for all edge types or all calls."},"last_sip_response_num":{"default":0,"type":"integer","description":"The numeric value of the last SIP response received for the call"},"pdd_ms":{"default":0,"type":"integer","description":"Post-dial delay in milliseconds"},"route_id":{"default":"","type":"string","description":"Route ID"},"media_region":{"default":"unknown_realm","type":"string","description":"The Twilio region where media was handled."},"signaling_region":{"default":"unknown_realm","type":"string","description":"The Twilio region where signaling was handled."},"twilio_media_ip":{"default":"","type":"string","description":"The IP address for Twilio's media gateway. Not available for carrier_edge."},"twilio_signaling_ip":{"default":"","type":"string","description":"The IP address for Twilio's signaling gateway. Not available for carrier_edge."},"external_media_ip":{"default":"","type":"string","description":"The IP address Twilio received media from. Not available for carrier_edge."},"external_signaling_ip":{"default":"","type":"string","description":"The IP address Twilio received signaling from. Not available for carrier_edge."},"sip_call_id":{"default":"","type":"string","description":"SIP call ID for the call between Twilio & your SIP infrastructure. Present on SIP Interface and trunking calls only."},"user_agent":{"default":"","type":"string","description":"Available for trunking calls only"},"selected_region":{"default":"unknown_realm","type":"string","description":"Available for Client calls only."},"region":{"default":"unknown_realm","type":"string","description":"Available for Client calls only."},"trunk_sid":{"default":"","type":"string","description":"The trunk SID for this call. Present on trunking calls only."},"disconnected_by":{"default":"unknown_disconnected_by","type":"string","description":"Available for Client calls only. Identifies if Twilio.Device.disconnect() was called in the local application or if the call was ended by remote party"},"direction":{"default":"unknown_call_direction","type":"string","description":"Direction of media flow from the perspective of the edge. Inbound or outbound."},"settings":{"$ref":"#/definitions/Settings"}}},"Settings":{"type":"object","description":"Settings definition","required":["ice_restart_enabled","dscp","edge","selected_edges"],"additionalProperties":false,"properties":{"ice_restart_enabled":{"default":false,"type":"boolean","description":"Indicates if ICE restart was enabled."},"dscp":{"default":false,"type":"boolean","description":"Indicates whether DSCP was enabled."},"edge":{"default":"","type":"string","description":"Twilio Edge Location that was used for this call"},"selected_edges":{"type":"array","items":{"type":"string"},"description":"Prioritized list of Edge Locations provided during Twilio.Device.setup();"}}},"MetricsContainer":{"type":"object","description":"Metrics container definition","additionalProperties":false,"properties":{"inbound":{"$ref":"#/definitions/Metrics"},"outbound":{"$ref":"#/definitions/Metrics"}}},"Metrics":{"type":"object","description":"Metrics definitions","required":["codec_name"],"additionalProperties":false,"properties":{"codec":{"type":"integer","minimum":-2147483648,"maximum":2147483647,"description":"RTP profile number for the media codec"},"codec_name":{"default":"unknown_codec_name","type":"string","description":"Name of the media codec"},"packets_received":{"type":"integer","minimum":-2147483648,"maximum":2147483647,"description":"Count of packets received; inbound container only"},"packets_sent":{"type":"integer","minimum":-2147483648,"maximum":2147483647,"description":"Count of packets sent; outbound container only"},"packets_lost":{"type":"integer","minimum":-2147483648,"maximum":2147483647,"description":"Count of packets lost"},"packets_loss_percentage":{"type":"number","description":"Percentage of packets lost"},"jitter":{"$ref":"#/definitions/Stats"},"rtt":{"$ref":"#/definitions/Stats"},"mos":{"$ref":"#/definitions/Stats"},"audio_in":{"$ref":"#/definitions/Stats"},"audio_out":{"$ref":"#/definitions/Stats"},"latency":{"$ref":"#/definitions/Stats"},"bytes_received":{"type":"integer","minimum":-2147483648,"maximum":2147483647,"description":"Bytes received"},"bytes_sent":{"type":"integer","minimum":-2147483648,"maximum":2147483647,"description":"Bytes sent"},"packet_delay_variation":{"$ref":"#/definitions/PacketDelayVariation"}}},"Stats":{"type":"object","description":"Stats definition","required":["min","max","avg"],"additionalProperties":false,"properties":{"min":{"default":0,"type":"number","description":"Min"},"max":{"default":0,"type":"number","description":"Max"},"avg":{"default":0,"type":"number","description":"Average"},"value":{"type":"number","description":"Value"}}},"PacketDelayVariation":{"type":"object","description":"Distribution of packets delayed by a certain value","required":["d50","d70","d90","d120","d150","d200","d300"],"additionalProperties":false,"properties":{"d50":{"default":0,"type":"integer","description":"number of packets delayed by more than 50 ms"},"d70":{"default":0,"type":"integer","description":"number of packets delayed by more than 70 ms"},"d90":{"default":0,"type":"integer","description":"number of packets delayed by more than 90 ms"},"d120":{"default":0,"type":"integer","description":"number of packets delayed by more than 120 ms"},"d150":{"default":0,"type":"integer","description":"number of packets delayed by more than 150 ms"},"d200":{"default":0,"type":"integer","description":"number of packets delayed by more than 200 ms"},"d300":{"default":0,"type":"integer","description":"number of packets delayed by more than 300 ms"}}},"Events":{"type":"object","description":"Events definition","required":["groups","levels","errors"],"additionalProperties":false,"properties":{"groups":{"type":"object","additionalProperties":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"description":"Count of events by the event group."},"levels":{"type":"object","additionalProperties":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"description":"Count of events by severity for the call."},"errors":{"type":"object","additionalProperties":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"description":"Error code and number of occurrences."},"feedback":{"$ref":"#/definitions/Feedback"}}},"Feedback":{"type":"object","description":"User feedback gathered from the SDK.","required":["reason","score"],"additionalProperties":false,"properties":{"reason":{"default":"unknown","type":"string","description":"Reason"},"score":{"default":0,"type":"integer","description":"Score"}}},"Attributes":{"type":"object","description":"Attributes definition","additionalProperties":false,"properties":{"conference_participant":{"type":"boolean","description":"Indicates if primary media source was a Twilio conference mixer."}}}}}