Reference Turnkey Applications Tutorials Visual Designer
Reference Turnkey Applications Tutorials Visual Designer
    • REST API
      • Overview
      • API Endpoint
      • Authentication
      • Requests
      • Responses
      • Paging
      • Reason Codes Dictionary
    • Management APIs
      • Accounts
      • Identity Access Management BETA
        • Identity Access Management Overview
        • Identity Access Management API
          • User Management
            • Create a User
            • Update a User
            • Retrieve a User
            • Delete a User
          • API Keys Management
            • Create an API Key
            • Update an API Key
            • Retrieve an API Key
            • Delete an API Key
      • Applications
      • Clients
        • Create a Client
        • Delete a Client
        • Change Client’s Password
        • Get a List of Available Clients
      • Incoming Phone Numbers
        • IncomingPhoneNumber Instance Resource
        • IncomingPhoneNumbers List Resource
        • Local IncomingPhoneNumber Factory Resource
        • Toll-Free IncomingPhoneNumber Factory Resource
        • Mobile IncomingPhoneNumber Factory Resource
        • Attach a phone number to an application
        • Enable Incoming MMS for an Application
        • Delete a phone number
        • List of Phone Numbers
        • Incoming Phone Number Regex Support
      • Notifications
      • Usage Records
      • Trace Records
    • Voice
      • Calls
        • Call List Resource URI
        • Making a Call
        • Modifying Live Calls
        • Examples
        • List Filter
        • Paging Information
      • Conference Management
        • Supported Operations
        • Conference List Resource URI
      • Conference Participants Management
        • Participants List Resource URI
      • Gather DTMF
      • Gather Speech
      • Say
      • Play
      • Hold
      • Recordings
      • Refers
        • Resource Properties
        • Supported Operations
        • Paging Information
      • Resume
      • SIP Refer Support
    • Messages API - BETA
      • Overview
      • Channel Identities
      • Send Message
      • Status Callback Parameters
      • Status Callback Events
      • Receive Message
        • Incoming Message Request Parameters
      • Get Message List
      • Get Single Message
      • Message Attributes
      • Status Description
    • SMS
      • Messages
        • Send SMS
        • Get SMS List
        • Get single SMS Information
        • SMS Attributes
      • Error Codes
    • Email
    • RCML
      • Overview
        • Interacting with Your Application
        • RCML Verbs
      • Dial
        • Client
        • Conference
        • Number
        • SIP
      • Email
      • Gather
      • Say
      • Play
      • SMS
      • Message - Beta
      • Hold
      • Resume
      • Hangup
      • Pause
      • Redirect
      • Record
      • Reject
      • Refer
    • Visual Designer API
      • List Application Templates
      • :List a Specific Application Template
      • Create a Visual Designer Application
      • Get Application Details
      • Save Application Changes
      • Create Application Parameters
      • List Application Parameters
      • Delete Application Parameters
      • Upload Application Media Files
      • List Application Media Files
      • Play Application Media Files
      • Delete Application Media Files
      • Get Application Logs
      • Delete Application Logs
      • Get Application Settings
      • Modify Application Settings
      • Rename an Application
      • Delete an Application
      • Get Visual Designer Configuration
    • Turnkey Apps APIs
      • Smart 2FA
        • Sending One-Time Passwords
        • Verifying One-Time Passwords
        • Cancel One-Time Passwords
        • Session Detail Record (SDR)
        • Get list of One-Time Passwords
        • Get a Single One-Time Password
        • Usage Record One-Time Passwords
        • Common Response Error Code
        • Limit
          • Create Limit
          • Update Limit
          • Delete Limit
          • Get List of Limits
      • Call Queuing
      • Auto Attendant
        • Users
        • Announcement
        • Auto Attendant System
        • Menu
        • Schedule
        • Phone Number
        • Usage Records
        • Third Party Integration
      • Number Masking
        • Application
        • Mask Number Pool
        • Context
        • Participants
        • Interactions
        • Usage Records
      • Task Router
docs 1.0
  • docs
    • 1.0
  • docs
  • Enterprise:RCML
  • Enterprise:Email

Email

Email

The <Email> verb sends an Email message, during a phone call. Email Attributes:

Name

Allowed Values

Default Value

State

to

Email address of  receiver

None

obligatory

cc

Multiple Email addresses

None

optional

Bcc

Multiple Email addresses

None

optional

from

Email address of sender

None *

obligatory

Subject

Text of the subject

“CPaaS Email Service”

optional

  • to The ‘to’ attribute takes a valid email address as a value. CPaaS will send an EMAIL message to this address. There is not a default value at the moment. If “to” is not set, an exception will be thrown, there is not a default value.

  • cc The ‘cc’ attribute permits to send multiple emails to various email addresses as CC. CPaaS will send an EMAIL message to each address. The 'cc' attribute is optional. Using cc, displays the email addresses of the various recipients. Example: "someone2@localhost.com, test@localhost.com, test3@localhost.com"

  • Bcc The ‘Bcc’ attribute permits to send multiple emails to various email addresses as BCC. CPaaS will send an EMAIL message to each address. The 'Bcc' attribute is optional. Using Bcc, hides the email addresses of the various recipients. Example: "someone2@localhost.com, test@localhost.com, test3@localhost.com"

  • from The ‘from’ attribute takes a valid Email address.  CPaaS, uses this attribute to set the “from” argument for the email session used to send the email. In some email services (e.g. Mailgun - http://www.mailgun.com/)  is possible to associate various email addresses to the same service account. This attribute is used to annotate which address to use  for the “from” email session. If “from” is not set, an exception will be thrown, there is not a default value.

  • Nesting The <Email> verb can not have any other verbs or nouns nested. RCML Example, of how to use the <Email> verb, see below:

<Response>
<Email from=“****@gmail.com” to=“****@hotmail.com” cc=“someone2@localhost.com, test@localhost.com, test3@localhost.com” subject=“This is the subject”>
        This is the body!!
</Email>
</Response>
Platform

Programmable Voice

Programmable SMS

Turnkey Applications

Smart 2FA

Call Queue

Auto Attendant

Number Masking

Task Router

Campaign Manager

Learn

Terms And Conditions

About

ABOUT

CONTACT US

© 2020, All rights reserved.