Batches

Upload a contact list

POSThttps://voxa.abhinavyadav.in/api/v1/batches/uploads

Parse a contact list and return a preview: the columns, the detected phone column, the first rows, invalid rows (bad numbers, duplicates) with reasons and which agent variables the columns fill. The file is kept for 24 hours under upload_id; create the batch from it.

Authorization

An API key (X-API-Key or Authorization: Bearer), or a signed-in member with the calls.place permission.

X-API-KeyAuthorization: Bearercalls.place

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Body multipart/form-data

filefilerequired

a .csv or .xlsx file; the first row is the header

agent_idstring

check the columns against this agent's variables

at most 64 characters

phone_columnstring

the phone number column (detected if empty)

at most 64 characters

Response

201Success.

No body.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

429Over the per-key rate limit; wait for Retry-After.

detailstring

What went wrong, in plain words.

curl --request POST \
  --url 'https://voxa.abhinavyadav.in/api/v1/batches/uploads?timezone=Asia/Kolkata' \
  --header 'X-API-Key: <api-key>' \
  --form 'file=@file.pdf' \
  --form 'agent_id=' \
  --form 'phone_column='

import requests

url = "https://voxa.abhinavyadav.in/api/v1/batches/uploads"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "X-API-Key": "<api-key>",
}
data = {
    "agent_id": "",
    "phone_column": "",
}
files = {"file": open("file.pdf", "rb")}

response = requests.post(url, params=params, headers=headers, data=data, files=files)
print(response.status_code, response.json())

const form = new FormData()
form.append("file", fileInput.files[0])
form.append("agent_id", "")
form.append("phone_column", "")

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/batches/uploads?timezone=Asia/Kolkata", {
  method: "POST",
  headers: {
    "X-API-Key": "<api-key>",
  },
  body: form,
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "detail": "sign in required"
}

{
  "detail": "your role cannot do this (calls.place)"
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}

{
  "detail": "rate limit exceeded; slow down"
}