Batches API | Tyxter WhatsApp API Docs

Create a batch

POST/v1/batches202 Accepted

Request body

Field	Type	Notes
No fields.

Response

Field	Type	Notes
`id`required	string
`object`required	"message_batch"
`status`required	"pending" \| "enqueuing" \| "sending" \| "paused" \| "completed" \| "failed" \| "cancelled"
`environment`required	"sandbox" \| "production"
`name`required	string \| null
`template_name`required	string \| null
`recipient_count`required	integer	range 0..9007199254740991
`enqueued_count`required	integer	range 0..9007199254740991
`sent_count`required	integer	range 0..9007199254740991
`failed_count`required	integer	range 0..9007199254740991
`error_message`required	string \| null
`trace_id`required	string
`scheduled_for`required	string<ISO-8601> \| null
`started_at`required	string<ISO-8601> \| null
`completed_at`required	string<ISO-8601> \| null
`created_at`required	string<ISO-8601>	pattern: ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\d\|30)\|(?:02)-(?:0[1-9]\|1\d\|2[0-8])))T(?:(?:[01]\d\|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z\|([+-](?:[01]\d\|2[0-3]):[0-5]\d)))$
`updated_at`required	string<ISO-8601>	pattern: ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\d\|30)\|(?:02)-(?:0[1-9]\|1\d\|2[0-8])))T(?:(?:[01]\d\|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z\|([+-](?:[01]\d\|2[0-3]):[0-5]\d)))$

Retrieve a batch

GET/v1/batches/{'{id}'}

Response

Field	Type	Notes
`id`required	string
`object`required	"message_batch"
`status`required	"pending" \| "enqueuing" \| "sending" \| "paused" \| "completed" \| "failed" \| "cancelled"
`environment`required	"sandbox" \| "production"
`name`required	string \| null
`template_name`required	string \| null
`recipient_count`required	integer	range 0..9007199254740991
`enqueued_count`required	integer	range 0..9007199254740991
`sent_count`required	integer	range 0..9007199254740991
`failed_count`required	integer	range 0..9007199254740991
`error_message`required	string \| null
`trace_id`required	string
`scheduled_for`required	string<ISO-8601> \| null
`started_at`required	string<ISO-8601> \| null
`completed_at`required	string<ISO-8601> \| null
`created_at`required	string<ISO-8601>	pattern: ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\d\|30)\|(?:02)-(?:0[1-9]\|1\d\|2[0-8])))T(?:(?:[01]\d\|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z\|([+-](?:[01]\d\|2[0-3]):[0-5]\d)))$
`updated_at`required	string<ISO-8601>	pattern: ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\d\|30)\|(?:02)-(?:0[1-9]\|1\d\|2[0-8])))T(?:(?:[01]\d\|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z\|([+-](?:[01]\d\|2[0-3]):[0-5]\d)))$

List batches

GET/v1/batches

Response

Field	Type	Notes
`object`required	"list"
`data`required	object[]
`has_more`required	boolean
`next_cursor`required	string \| null

Control a batch

POST/v1/batches/{'{id}'}/pause

POST/v1/batches/{'{id}'}/resume

POST/v1/batches/{'{id}'}/cancel

Response

Field	Type	Notes
`id`required	string
`object`required	"message_batch"
`status`required	"pending" \| "enqueuing" \| "sending" \| "paused" \| "completed" \| "failed" \| "cancelled"
`environment`required	"sandbox" \| "production"
`name`required	string \| null
`template_name`required	string \| null
`recipient_count`required	integer	range 0..9007199254740991
`enqueued_count`required	integer	range 0..9007199254740991
`sent_count`required	integer	range 0..9007199254740991
`failed_count`required	integer	range 0..9007199254740991
`error_message`required	string \| null
`trace_id`required	string
`scheduled_for`required	string<ISO-8601> \| null
`started_at`required	string<ISO-8601> \| null
`completed_at`required	string<ISO-8601> \| null
`created_at`required	string<ISO-8601>	pattern: ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\d\|30)\|(?:02)-(?:0[1-9]\|1\d\|2[0-8])))T(?:(?:[01]\d\|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z\|([+-](?:[01]\d\|2[0-3]):[0-5]\d)))$
`updated_at`required	string<ISO-8601>	pattern: ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\d\|30)\|(?:02)-(?:0[1-9]\|1\d\|2[0-8])))T(?:(?:[01]\d\|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z\|([+-](?:[01]\d\|2[0-3]):[0-5]\d)))$

Export failures

GET/v1/batches/{'{id}'}/failures

Response

Field	Type	Notes
`object`required	"message_batch_failure_export"
`batch_id`required	string
`generated_at`required	string<ISO-8601>	pattern: ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\d\|30)\|(?:02)-(?:0[1-9]\|1\d\|2[0-8])))T(?:(?:[01]\d\|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z\|([+-](?:[01]\d\|2[0-3]):[0-5]\d)))$
`rows`required	object[]