Start a new phone call

Start a new phone call with the specified parameters. The response includes headers about rate limiting.

Authorizations

X-Api-Key

string

header

required

The API Key created in Rounded Studio.

• You can create it by going to the "API Keys" settings of your profile.
• Need help? You can email us at [e-mail] or join our Discord community.

Body

application/json

from_number

string

required

Phone number emitting the call, in E.164 format. It must be a phone number from your Rounded organization.

Minimum length: 8

Example:

"[phone]"

to_number

string

required

Phone number receiving the call, in E.164 format.

Minimum length: 8

Example:

"[phone]"

agent_id

string

required

Id of the agent making the call. You can get the id from your agent's config page URL, e.g. https://app.callrounded.com/agents/411b82c8-462a-4e1b-89bc-10ab3ce1ed29.

Example:

"411b82c8-462a-4e1b-89bc-10ab3ce1ed29"

dynamic_variables_values

object | null

Values for the variables that should be initialized before call starts, provided as a JSON object.

Show child attributes

dynamic_variables_values.{key}

string

Example:

{ "first_name": "John", "last_name": "Doe" }

Response

201

application/json

Successfully started phone call

message

string

required

data

object

required

Show child attributes

data.call_id

string

required

Unique identifier of the initiated call.

Example:

"411b82c8-462a-4e1b-89bc-10ab3ce1ed29"

error

object | null

Show child attributes

error.message

string

required

error.type

string

required

error.status

integer

required

error.details

object[] | null

Show child attributes

error.details.message

string

required

error.details.field

string | null

Example:

{
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ],
  "message": "An error occurred while processing your request",
  "status": 400,
  "type": "generic_error"
}

status

integer

default:201