/biz/api/voice/task/

This API is used to push new tasks for a particular campaign on SquadVoice Platform.

👍

Data security

Goes without saying your data is secure with us. :)

We call our tele callers via a masked number. This way the phone_number you share with us is never shared with our tele callers.

Multiple tasks per /biz/api/voice/task/ API call

Sample request payload wth multiple tasks per request. You'll receive an identical response in case of success.

Sample request payload

[
  {
    "task_id": 5216,
    "campaign_id": 12,
    "phone_number": "[phone]",
    "meta":
    {
      "order_name" : "Blue Jeans",
      "order_id": 137691334,
    },
    "contact_name": "John Smith"
  },
  {
    "task_id": 5215,
    "campaign_id": 12,
    "phone_number": "[phone]",
    "meta":
    {
      "order_name" : "Black Jeans",
      "order_id": 137673874,
    },
    "contact_name": "John Doe"
  }
]

201 - Sucess response

[
  {
    "task_id": 5216,
    "campaign_id": 12,
    "phone_number": "[phone]",
    "meta":
    {
      "order_name" : "Blue Jeans",
      "order_id": 137691334,
    },
    "contact_name": "John Smith"
  },
  {
    "task_id": 5215,
    "campaign_id": 12,
    "phone_number": "[phone]",
    "meta":
    {
      "order_name" : "Black Jeans",
      "order_id": 137673874,
    },
    "contact_name": "John Doe"
  }
]

Error Responses

Require fields are missing

When not all required keys are given, the error response is similar to

400 - Required fields missing

{
	"phone_number": [
		"This field is required."
	],
	"meta": [
		"This field is required."
	],
	"task_id": [
		"This field is required."
	],
	"campaign_id": [
		"This field is required."
	]
}

headers

HTTP/1.0 400 Bad Request
Allow: POST, OPTIONS
Content-Type: application/json

When the task already exists

This error occurs when this task_id has been used already.

It might even be possible that the task with given id has been inserted before.

400 - duplicate task_id

{
	"non_field_errors": [
		"The field task_id must be unique for this integration."
	]
}