Create Dialout

This request creates a Dialout object.

post

/dialouts

Sample

A sample POST request to create a dialout:

curl -X POST \
'https://api.carrierx.com/mediator/v1/dialouts' \
-H 'Content-Type: application/json' \
--data-binary '{"stage_one_destination_did":"15162065339", "stage_two_destination_did":"15162065338", "redirect_did":"15162065340", "attributes": {"ringback":"false"}}' \
-u 'mediator_user_123:qwerty123'

Response

200 status code with a serialized copy of the Dialout object:

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

Workflow

The typical workflow for a dialout is as follows:

1. The redirect_did dials the stage_one_destination_did.
2. When the first call is answered, the redirect_did dials the stage_two_destination_did.
3. If the second call is also answered, a bridge is established between both parties.
4. The Dialout object is deleted once the call is set up.

Key parameters

• delay: The number of seconds before the redirect_did contacts the two phone numbers. If not defined, the default value is 0, meaning dialing starts immediately after the Dialout object is created.

• stage_one_destination_did, stage_two_destination_did, and redirect_did: These parameters must be unique for each Dialout object. Two Dialout objects cannot have the same phone numbers simultaneously. Ensure each dialout has unique values for these fields when scheduling multiple dialouts.

Additional attributes

Additional attributes can be added to a dialout to customize the Dialout object. Refer to the Dialout Object Attributes object for a list of available built-in attributes. Custom attributes can also be included in the same way as the built-in attributes.

Body Arguments

JSON representation of the fields and values of the Dialout object to be created.

Required fields to create a dialout are:

• stage_one_destination_did
• stage_two_destination_did

For a complete list of Dialout object attributes, refer to this section.