Transactional campaign send

post

https://api.indigitall.com/v2/sms/send/list

Sends a campaign to the specified contacts. Duplicated and disabled contacts will be removed. Not existing contacts will be created. The type of campaign can be overridden with the sendTypeOverride property. You can specify the contacts using an phoneNumber, an externalCode, or both.

Phone number only: Sends to the provided phoneNumber.
ExternalCode only: Sends to the contact with the externalCode.
Both provided: Sends to the phone number; externalCode is used only to create the contact if needed.

If the contact doesn't exist and includes the required data, it will be created automatically.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

campaignId

integer

required

Campaign's ID to send

scheduleAt

date-time

If specified, the sending will be done at this time. Format is ISO 8601(YYYY-MM-DDThh:mm:ssZ for UTC )

contactIdType

string

enum

Defaults to phone

deprecated

This parameter is deprecated. Use externalCode and phoneNumber inside contacts. If you use them, this field will be ignored

Allowed:

flash

boolean

Defaults to false

indicates if the shipment is flash type

gsmLanguageMode

string

enum

Defaults to auto

Defines the character set when using the GSM-7 encoding and National Language Shift

This feature may not be available with some SMS providers or destination regions

This field is ignored when sending in an encoding other than GSM-7 (for example, USC-2)

auto - The system will select the appropriate mode based on the characters in the message and the availability of the provider of NLS
standard - Forces to send the SMS always using the default charset in GSM-7
spanish - Forces to send the SMS always using the extended spanish charset in GSM-7 - NLS spanish

Allowed:

contacts

array of objects

required

length ≥ 1

Contacts to send the sms campaign

contacts*

contactIdType

string

enum

Defaults to phone

deprecated

This parameter is deprecated. Use externalCode and phoneNumber instead. If you use them, this field will be ignored

Allowed:

string

deprecated

This parameter is deprecated. Use externalCode and phoneNumber instead. If you use them, this field will be ignored

externalCode

string

External identifier for the contact

phoneNumber

string

Phone number for the contact

countryCode

string | null

contact's country code withtout + sign

phoneE164

string

Contact's phone in E.164 format. Takes precedence over phoneNumber/countryCode if present.

customFields

object

Object with campaing's customizable fields, must be one key per field and its value.

customData

string | null

Optional external reference that allows later in the reports to know the status of each sending to each contact

originData

object

sendTypeOverride

string

enum

Override the type of campaign. 'list' for transactional campaign (default), 'all' for massive campaign.

Allowed:

200Sending data

defaultError 5XX, 4XX