POST
/
v1
/
calls
/
single-phone-call
curl --request POST \
  --url https://api.contactship.ai/v1/calls/single-phone-call \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "from_number": "+12124567890",
  "to_number": "+12124567890",
  "full_name": "Jhon Doe",
  "agent_id": "string",
  "email": "example@mail.es",
  "country": "Mexico",
  "additional_data": [
    {
      "key": "amount_debt",
      "value": "14058"
    },
    {
      "key": "due_date",
      "value": "2024-09-30"
    },
    {
      "key": "currency",
      "value": "USD"
    },
    {
      "key": "payment_status",
      "value": "pending"
    }
  ]
}'
{
  "statusCode": 123,
  "data": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "provider_agent_id": "<string>",
    "additional_data": {},
    "webhook_url": "<string>",
    "call_id": "<string>",
    "contact_id": "<string>"
  }
}

Headers

​
x-api-key
string
required

x-api-key

Body

application/json
Make an AI phone call with your Agent ID
​
agent_id
string
required

The ID of the agent making the call

​
from_number
string
required

The number from which the call is made

​
to_number
string
required

The number to which the call is made

​
full_name
string
required

The full name of the person being called

​
country
string
required

The country of the person being called

​
email
string

The email of the person being called

​
additional_data
object[]

Additional data for the call

Response

200
application/json
AI phone call response
​
statusCode
integer

The status code of the response

​
data
object