Skip to navigation
BlasterCalls

Launch a call

Starts an automated phone call to a destination number. The message and audio fields are mutually exclusive: if both are sent, message takes precedence and audio is ignored. An ACCEPTED status only indicates that the request was accepted for processing; it does not imply that the call was answered or completed.

Authentication

x-api-keystring
Account authentication key.
OR
AuthorizationBearer

OAuth 2.0 access token issued by POST /api/oauth/token (client-credentials). Takes precedence over x-api-key when both are sent. See the Authentication section.

Request

This endpoint expects an object.
outbound_routestringRequired

Outbound route identifier obtained through GET /v1/blaster/outbound-routes.

phone_numberstringRequiredformat: "^\d{10}$"

10-digit Mexican phone number, without country code.

messagestringOptional

Text that will be converted to speech (TTS). Required when audio is not sent.

audiostringOptional

Audio identifier obtained through POST /v1/blaster/media/audio. Required when message is not sent.

ringtimeintegerOptional10-30Defaults to 20

Ring time in seconds before the call is considered unanswered. Optional; if not sent, the default value is applied.

transfer_tostringOptional

10-digit phone number to which the call will be transferred once answered.

retryobjectOptional

Automatic retry configuration for the call. Retries are triggered when the call ends with a redialable SIP code (busy, unanswered, voicemail). In the worst case the number is dialed 1 + max_attempts times.

Response

Request accepted for processing.
message_idstringOptional
Unique identifier of the call. It should be kept to correlate subsequent webhook events.
statusenumOptional
Result of the initial validation of the request.
Allowed values:
operatorstringOptional
Phone operator identified for the destination number.
is_mobilebooleanOptional
Indicates whether the number corresponds to a mobile line.
outbound_routestringOptional
phone_numberstringOptional
messagestringOptional
audiostringOptional
ringtimeintegerOptional
retryobjectOptional

Automatic retry configuration for the call. Retries are triggered when the call ends with a redialable SIP code (busy, unanswered, voicemail). In the worst case the number is dialed 1 + max_attempts times.

transfer_tostringOptional