Transactional campaign send (CSV)

post

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

Sends a campaign to the specified contacts via CSV. Duplicated and disabled contacts will be removed. Not existing contacts will be created. The type of campaign can be overridden with the sendTypeOverride parameter.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

campaignId

integer

required

Campaign ID

scheduleAt

date-time

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

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:

fieldDelimiter

string

CSV file delimiter. If not indicated, it is assumed ,

fieldPhone

string

Phone number field name. If not indicated, the phone field will be used

fieldCustomData

string

Field used to later refer to that message in the statistics. By default the customData field is used

fieldCountryCode

string

Country code field name. If not indicated, the countryCode field will be used

fieldExternalCode

string

External code field name. If not indicated, the externalCode field will be used

fieldPhoneE164

string

E.164 phone number field name. If not indicated, the phoneE164 field will be used.

flash

boolean

Defaults to false

indicates if the shipment is flash type

sendTypeOverride

string

enum

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

Allowed:

allowDuplicates

boolean

If 'true', allows sending duplicate sms to the same phone number. If not specified, the project configuration will be used. If not configured in the project, defaults to false (no duplicates allowed).

Body Params

csv

file

required

A .csv file with a list of contacts. The header must contain columns for ONE of the following identification methods:

An E.164 phone number (default column name 'phoneE164').
A pair of country code and phone number (default names 'countryCode' and 'phone').
An external code (default name 'externalCode').

Extra variables will be considered custom vars to replace in the campaign message template.

Do not include BOM.

Example, by country code and phone, no custom variables:

countryCode,phone
34,666112233
34,666112244
34,666112255
....

Example, by externalCode, no custom variables:

externalCode
id1111
id1112
id1113
....

Example, by phoneE164, no custom variables:

phoneE164
+34666112233
+447700900123
....

Example, with custom variables:

countryCode,phone,name,discount
34,666112233,ana,20
34,666112244,sara,25
34,666112255,lucia,30
....

Responses

200Success

defaultError 5XX, 4XX