Skip to content
Home/
REST API Reference
/
/
Register Fin Voice Call R...

Register Fin Voice Call Request Payload

Register a Fin Voice call with Intercom

phone_numberstringrequired

Phone number in E.164 format for the call

Example:"+1234567890"
call_idstringrequired

External call identifier from the call provider

Example:"call-123-abc"
sourcestring

Source of the call. Can be "five9", "zoom_phone", "nice_cxone", "dialpad", "generic", or "aws_connect". Defaults to "aws_connect", and any other value is treated as "aws_connect".

Enum:"five9""zoom_phone""nice_cxone""dialpad""generic""aws_connect"
Example:"aws_connect"
vendor_internal_idstring or null

Optional vendor-supplied identifier for linking the Fin Voice session to records in the vendor's own systems. Stored as-is and returned on every lookup.

Example:"vendor-internal-abc-123"
dataobject or null

Additional metadata about the call

Example:
{
  "key": "value"
}
{
  "phone_number": "+1234567890",
  "call_id": "call-123-abc",
  "source": "aws_connect",
  "vendor_internal_id": "vendor-internal-abc-123",
  "data": {
    "key": "value"
  }
}