v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
calls

Add recipients to a call broadcast

Use this API to add the recipients to an existing voice broadcast. Post a list of Recipient objects to be added to the voice broadcast campaign. These contacts will not go through validation process, and will be acted upon as they are added. Recipients may be added as a list of contact ids, or list of numbers

post/calls/broadcasts/{id}/recipients

Path parameters

idinteger required

An id of a call broadcast

Query parameters

fieldsstring

Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at partial response page.

strictValidationboolean

Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation

Request body

phoneNumberstring

A recipient's phone number in E.164 format (11-digit) or short code. Example: 12132000384, 67076

fromNumberstring

~

contactIdinteger

An id of existing contact used as recipient

attributesobject

Map of user-defined string attributes associated with recipient

Response

successful operation