Dialout Object

This section describes the elements of the Dialout object.

Dialout Object Attributes

These fields and values make up the JSON object that gets returned with successful requests.

The second table in this section provides information about optional fields that can be added to further customize dialouts. These fields can be added when initially creating the dialout or later using PATCH or PUT requests.

Attribute	Data Type	Description
account_sid read only	string	The secure ID of the account to which the dialout belongs.
attributes createupdate	object	Optional fields and values added to a dialout. Refer to the table below for information on built-in attributes. Custom fields can be added in the same manner as built-in attributes.
date_created read only	string	The date and time when the dialout was created.
delay createupdate	integer	The delay (in seconds) before both parties are contacted. The default value is 0.
dialout_sid read only	string	The dialout secure ID.
redirect_did createupdate	string	The DID that dials out to the stage_one_destination_did and stage_two_destination_did.
stage_one_destination_did createupdate	string	The first DID that Mediator dials out to. If the first DID is reached successfully, the redirect_did attempts to reach stage_two_destination_did.
stage_two_destination_did createupdate	string	The second DID, which Mediator dials out to upon successfully reaching the stage_one_destination_did. If the second DID is reached successfully, a connection between both parties is established.

Attributes Object

Below are additional fields that can be added to further customize dialouts. All of these attributes are optional. Custom attributes can be added to the JSON object in the same way as built-in attributes. Add these attributes as a nested object.

Attribute	Data Type	Description
announce createupdate	string	The audio file played to stage_one_destination_did before they are connected to the stage_two_destination_did. Accepted file formats: .wav and .mp3.
cnam createupdate	string	The CNAM for outbound calls. Note that this may not be preserved for calls terminated through the PSTN.
fix_anonymous_cid createupdate	boolean	Determines whether a blocked or unavailable caller ID will be replaced with the redirect_did. Set to true to display the redirect_did instead of blocked numbers.
hide_origination_did createupdate	string	Determines whether to hide one or all of the caller's phone numbers. Possible values: true: The redirect_did is displayed to both parties instead of the stage_one_destination_did or stage_two_destination_did. false: Both DIDs are displayed to each other. The first party sees the stage_two_destination_did, and the second party sees the stage_one_destination_did. stage_one: Hides the second DID for the stage_one_destination_did. The first party sees the redirect_did, while the second party sees the first party's DID. stage_two: Hides the first DID for the stage_two_destination_did. The second party sees the redirect_did, while the first party sees the second party's DID. The default value is true. To change this value, contact support@carrierx.com.
ringback createupdate	string	Customizes what stage_one_destination_did hears while stage_two_destination_did is being dialed. Set to false to disable ringing (caller hears silence), moh for hold music, or passthrough to defer to the behavior of stage_two_destination_did.
sip_header_* createupdate	string	Values sent as extra SIP headers in the SIP invite. Header names must start with X-.
use_call_confirmation createupdate	string	A URL to the sound file played when stage_one_destination_did answers. The default value is null. If the URL is null or invalid, the default file will play.

Sample Dialout Object

{
    "account_sid": "13e156f7-0d21-4ba6-9e32-c56dc2c6098f",
    "attributes": {
        "hide_origination_did": "true"
    },
    "date_created": "2025-04-09T20:40:57.675Z",
    "delay": 0,
    "dialout_sid": "15e93c0c-a0eb-4c5d-9b92-f8fd60b2def6",
    "redirect_did": "15162065337",
    "stage_one_destination_did": "15162065339",
    "stage_two_destination_did": "15162065338"
}