New inbound email
Inbound Email
Submit incoming email messages and webform submissions into a project via API, including attachments, and trigger configured project email workflows.
| Request | |
|---|---|
| Method | POST |
| Resource | https://[customer].asp.virtual-call-center.eu/v2/projects/[projectid]/inboundEmail |
| Options | N/A |
| Body | Inbound email object, encoded in JSON. |
| Response | |
| Body | Status response object, encoded in JSON. |
Request
Resource parameters
| Name | Type | Mandatory | Comment |
|---|---|---|---|
| projectid | integer | yes | Project unique identifier |
Body parameters
| Name | Type | Mandatory | Comment |
|---|---|---|---|
| from | string | yes | Sender name and/or email address (e.g. "John Doe <[email protected]>" or "[email protected]"). |
| to | string | yes | Recipient email address matching an active email account assigned to the project. |
| subject | string | yes | Subject of the email message. |
| body | string | yes | Body text of the email message (supports plain text or multiline text with line breaks). |
| cc | string | no | Carbon copy (CC) recipient email addresses. |
| replyTo | string | no | Reply-to email address where agent replies should be directed. |
| attachments | array of objects | no | List of file attachments associated with the email. Maximum decoded total size is 20 MB. |
Attachments object
| Name | Type | Mandatory | Comment |
|---|---|---|---|
| filename | string | yes | Name of the file attachment including extension (max 255 characters). Cannot be empty or relative paths. |
| content | string | yes | File content encoded in Base64. Inline attachments are not supported; all files are treated as regular attachments. |
Response
Response object
| Name | Type | Comment |
|---|---|---|
| response | object | Contains the execution result and details of the received email. |
| errors | array | Array of error messages, if any occurred. |
Response details object
| Name | Type | Comment |
|---|---|---|
| success | boolean | Indicates whether the inbound email was successfully received and queued. |
| emailId | integer | Unique identifier assigned to the created email. |
Example
Submitting a contact webform with a customer query and a text attachment into project 130.
Request
POST https://customer.asp.virtual-call-center.eu/v2/projects/130/inboundEmail HTTP/1.1
{
"from": "John Doe <[email protected]>",
"to": "[email protected]",
"cc": "[email protected]",
"replyTo": "[email protected]",
"subject": "Webform submission - Inquiry",
"body": "Name: John DoernPhone: +36 1 234 5678rnrnMessage: Please find the attached document regarding my inquiry.",
"attachments": [
{
"filename": "note.txt",
"content": "aGVsbG8gUUEK"
}
]
}
Response body
{
"response": {
"success": true,
"emailId": 12345
},
"errors": []
}
Comments
Can’t find what you need? Use the comment section below to connect with others, get answers from our experts, or share your ideas with us.
There are no comments yet.