Skip to main content
POST
/
batch_dial_jobs
Create Batch Job
curl --request POST \
  --url https://api.vogent.ai/api/batch_dial_jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "callAgentId": "<string>",
  "maxConcurrentDials": 123,
  "name": "<string>",
  "fromPhoneNumberIds": [
    "<string>"
  ],
  "schedule": {
    "days": [
      {
        "dayOfWeek": 123,
        "timeSlots": [
          {
            "startTime": "<string>",
            "endTime": "<string>"
          }
        ]
      }
    ],
    "timezone": "<string>",
    "disableSchedule": true
  },
  "rows": [
    {
      "toNumber": "<string>",
      "inputs": {}
    }
  ]
}'
{
  "id": "<string>",
  "maxConcurrentDials": 123,
  "name": "<string>",
  "status": "INIT",
  "fromPhoneNumberIds": [
    "<string>"
  ],
  "schedule": {
    "days": [
      {
        "dayOfWeek": 123,
        "timeSlots": [
          {
            "startTime": "<string>",
            "endTime": "<string>"
          }
        ]
      }
    ],
    "timezone": "<string>"
  },
  "callAgentId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

In the form Bearer <api_key_here>. You can find your api key in your dashboard.

Body

application/json
callAgentId
string
required
maxConcurrentDials
integer
required
name
string
required
rows
object[]
required
fromPhoneNumberIds
string[]
schedule
object

Response

Successful operation

id
string
required
maxConcurrentDials
integer
required
name
string
required
status
enum<string>
required
Available options:
INIT,
ACTIVE,
PAUSED,
COMPLETE,
CANCELLED
callAgentId
string
required
createdAt
string<date-time>
required
fromPhoneNumberIds
string[]
schedule
object