There are 4 categories for Incoming leads: chats, forms, sip (call), and mail. The difference between the incoming leads from the four types is in the metadata.
| Parameter | Data type | Description |
|---|
| from | string | Call initiator |
| phone | string | Call recipient |
| called_at | int | Call date and time in Unix Timestamp format |
| duration | int | Call duration |
| link | string | A link to the call recording |
| service_code | string | Service provider code |
| is_call_event_needed | bool | This flag is not returned in the response but can be passed. If the “true” value is passed, the call event will be added to the entity card. |
| Parameter | Data type | Description |
|---|
| form_id | string | Integration’s form ID. |
| form_name | string | Form name |
| form_page | string | Webpage where the form is installed |
| ip | string | The IP address of the request |
| form_sent_at | int | Form submission date and time in Unix Timestamp format |
| referer | string | Webpage the applicant was redirected from to the form page |
| Parameter | Data type | Description |
|---|
| from | string | The name of the user who sent the message |
| to | string | The ID of the page that received the message |
| received_at | int | Message date and time in Unix Timestamp format |
| service | string | Name of the service that delivered the message |
| client | object | Message author data |
| client[name] | string | Message sender name |
| client[avatar] | string|null | Link to the sender’s avatar |
| origin | object | Message source data |
| origin[chat_id] | string | Chat ID in the chats service |
| origin[ref] | string|null | Additional data from the chats service |
| origin[visitor_uid] | string|null | UID of the user who sent the message |
| last_message_text | string|null | The last message from the user |
| source_name | string | Message source name |
| Parameter | Data type | Description |
|---|
| from | object | Email author data |
| from[email] | string | Author email address |
| from[name] | string | Author name |
| received_at | int | Date and time when the email was received in Unix Timestamp format |
| subject | string | Email subject |
| thread_id | int | Thread ID in the mail service |
| message_id | int | Email ID in the mail service |
| content_summary | string | Email content summary |