Detect Scam Call metadata

The initial text frame sent by the client after initiating the connection on the Detect Scam Call API.

---

sampleRateintegerrequired
The sample rate of the audio stream.
Format: int32
Possible values: [8000, 16000, 24000, 44100, 48000, 64000]
Example: 8000

---

subjectAudioChannelinteger
The index of the audio channel that contains the audio of the non-user party. (The caller in the inbound case, the recipient in the outbound case.)
Format: int32
Possible values: [0, 1]
Default value: 0
Example: 0

---

phonestringrequired
The phone number of the non-user party in E.164 format.
Example: +15555550000

---

userPhonestring
The phone number of the user in E.164 format.
Example: +15555550001

---

directionstring
Whether the user is the recipient or the caller party.
Format: CallDirection (string)
Possible values: [Incoming, Outgoing]
Default value: Incoming
Example: Incoming

---

isContactboolean
Whether the user has the other party in their contact list.
Example: true

---

sipMethodstringrequired
The method in the SIP request that initiated the phone call.
Example: INVITE

---

sipHeaders

object

required

The headers in the SIP request that initiated the phone call.

---

property name*string

Detect Scam Call metadata

{
  "sampleRate": 8000,
  "subjectAudioChannel": 0,
  "phone": "+15555550000",
  "userPhone": "+15555550001",
  "direction": "Incoming",
  "isContact": true,
  "sipMethod": "INVITE",
  "sipHeaders": {
    "Via": "SIP/2.0/UDP 10.0.0.0:5060;branch=z9hG4bK000000000",
    "Max-Forwards": "70",
    "From": "\"Alice\" <sip:+15555550000@example.com>",
    "To": "\"Bob\" <sip:+15555550001@example.com>",
    "Call-ID": "4a32e052-3024-4e9b-919b-0b9b543c4730",
    "CSeq": "1 INVITE",
    "Diversion": "<sip:+15555550010@example.com>",
    "Contact": "\"Alice\" <sip:+15555550000@10.0.0.0:5060>",
    "P-Asserted-Identity": "\"Alice\" <sip:+15555550000@example.com>",
    "Content-Length": "0"
  }
}