Email

Overview

The VoIPBin’s email API delivers a powerful, flexible email service designed to simplify the integration of email communication into your applications. Whether you need to send transactional notifications, marketing emails, or alerts, this feature provides a reliable and scalable solution to meet your needs.

Email and Mailbox

The email functionality enables applications to both send and manage emails with ease.

Developers can leverage this service to automate communication flows, ensuring timely delivery of critical messages. The API supports a variety of email-related operations including composing new messages, managing attachments, and scheduling email dispatches. This flexibility is key for maintaining effective user engagement and operational efficiency.

Email Message

The Email Message object encapsulates all components of an email, ensuring each message is constructed accurately for successful delivery.

Key elements include: * From: The sender’s email address. * To: One or multiple recipient email addresses. * Subject: The email’s subject line, summarizing the content. * Content: The main content of the email, supporting both plain text and HTML formats. * Attachments: Optional files to be sent along with the email.

These attributes ensure that every email sent through the API is complete and conforms to modern email standards.

By integrating the Email API, organizations can streamline communication processes, automate notifications, and significantly enhance user interaction. This feature aligns with VoIPBin’s commitment to providing a comprehensive suite of communication tools that improve connectivity and collaboration across platforms.

Email

{
    "id": "<uuid>",
    "customer_id": "<uuid>",
    "source": {
        ...
    },
    "destinations": [
        {
            ...
        },
        ...
    ],
    "status": "<string>",
    "subject": "<string>",
    "content": "<string>",
    "attachments": [
        {
            ...
        },
        ...
    ],
    "tm_create": "<string>",
    "tm_update": "<string>",
    "tm_delete": "<string>"
},

id: Email’s ID.
customer_id: Customer’s ID.
source: Source address info. See detail here.
destinations: List of destination addresses info. See detail here.
status: Email’s deliverence status. See detail here.
subject: Email’s subject.
content: Email’s content.
attachments: List of attachments. See detail here.

Example

{
    "id": "1f25e6c9-6709-44d1-b93e-a5f1c5f80411",
    "customer_id": "5e4a0680-804e-11ec-8477-2fea5968d85b",
    "source": {
        "type": "email",
        "target": "[email protected]",
        "target_name": "voipbin service",
        "name": "",
        "detail": ""
    },
    "destinations": [
        {
            "type": "email",
            "target": "[email protected]",
            "target_name": "",
            "name": "",
            "detail": ""
        }
    ],
    "status": "delivered",
    "subject": "test email 7",
    "content": "test email from voipbin.",
    "attachments": [],
    "tm_create": "2025-03-14 19:04:01.160250",
    "tm_update": "2025-03-14 19:04:11.509512",
    "tm_delete": "9999-01-01 00:00:00.000000"
}

Status

Email’s status.

Status	Description
“”	None
initiated	The email has been initiated.
processed	The email has been received is being processed.
delivered	The email has been successfully delivered to the recipient’s inbox (or spam folder).

Attachment

{
    "reference_type": "<string>",
    "reference_id": "<uuid>"
}

reference_type: Attachment’s reference type.
reference_id: Attachment’s reference id.

Type

Attachment’s type.

Type	Description
“”	None
recording	Recording.

Tutorial

Get list of emails

Example

$ curl --location 'https://api.voipbin.net/v1.0/emails?accesskey=your_accesskey'

{
    "result": [
        {
            "id": "1f25e6c9-6709-44d1-b93e-a5f1c5f80411",
            "customer_id": "5e4a0680-804e-11ec-8477-2fea5968d85b",
            "source": {
                "type": "email",
                "target": "[email protected]",
                "target_name": "voipbin service",
                "name": "",
                "detail": ""
            },
            "destinations": [
                {
                    "type": "email",
                    "target": "[email protected]",
                    "target_name": "",
                    "name": "",
                    "detail": ""
                }
            ],
            "status": "delivered",
            "subject": "test email 7",
            "content": "test email from voipbin.",
            "attachments": [],
            "tm_create": "2025-03-14 19:04:01.160250",
            "tm_update": "2025-03-14 19:04:11.509512",
            "tm_delete": "9999-01-01 00:00:00.000000"
        },
        ...
    ],
    "next_page_token": "2025-03-14 18:04:41.998152"
}