submission/send_batch

Allows you to send multiple messages to one or more recipients in a single submission.

Note on HTTP connections: please limit yourself to one concurrent connection, i.e., in your code, send with only one thread/process. If you feel that you have latency problems (if your computer is far away from our server in network terms), you could consider using HTTP KeepAlive.

URL

«EAPI URL»/submission/send_batch/1/1.0

Example

«EAPI URL»/submission/send_batch/1/1.0?username=john&password=abcd1234&batch_data=msisdn,message%0a%22111111111%22,%22Hi+there%22%0a%22333333333%22,%22Hello+again%22

This example is so simple that it can be pasted into a browser’s location bar. However, please do not use HTTP GET in production - use only POST. To ensure that you are using POST correctly, please use the Code Samples as a basis. You should also consider using a library to encode the CSV rather than trying to escape it correctly yourself. Although there is no official standard for CSV, most common formats should be supported.

The batch_data CSV field looks like this unencoded:

msisdn,message
"111111111","Hi there"
"333333333","Hello again"

Example which shows how to escape newlines and double quotes (with a backslash: %5C)

«EAPI URL»/submission/send_batch/1/1.0?username=john&password=abcd1234&batch_data=msisdn,message%0a%22111111111%22,%22Hi+there%22%0a%22333333333%22,%22Hello+again.+Here+is+some+%5C%22quoted+text%5C%22.%5C%0aThis+text+follows+a+newline%22

HTTP parameters

(Parameter values should be encoded in ISO-8859-1)

parameter required default description
username    
password    
batch_data   your submission in CSV format (current maximum size: 30,000 messages)
sender     sender id / origin address (if alphanumeric, max 11 characters). This facility becomes available after credits have been purchased for the first time. To request a sender id, log into your account, go to User Account and click Change Sender ID. Alphanumeric sender id is a route-specific feature.
msg_class   2 currently 0 (flash SMS) or 2 (normal SMS), default 2
dca   7bit Data Coding Alphabet: 7bit,8bit or 16bit, default 7bit (normal text message). For 8bit (ringtones,logos) or 16bit (Unicode), a message containing only hexadecimal octets, to a maximum of 140 octets (where an octet is e.g. ff), must be submitted (the UDHI is always set for 8-bit messages). 16-bit is a route-specific feature.
want_report   1 0 or 1, default 1
routing_group     (previously known as cost_route, which still works to be backwards compatible) - possible values are 1,2,3 (it is possible but unlikely that these values could change - if they do, you should be contacted first). The current default is 2, but you would be wise to not depend on this remaining so. Routing groups group delivery routes by cost or quality.
source_id     an alphanumeric (plus other common characters) id, for your own accounting purposes (e.g. useful if you have subaccounts that you send messages on behalf of, or even if you have your own unique id that you want to associate with the message). Max 20 characters. Reply messages that are pushed to you will include this parameter, based on the original message that they are in reply to.
repliable     1 to enable, 0 to disable, default is not set, which means that your User Profile’s default repliable setting will prevail. Also see discussion on repliability below.
stop_dup_id     see section on eliminating duplicates below.
send_time     scheduled send time (see section on scheduling below), in format yyyy-mm-dd hh:mm:ss, relative to the time zone specified for your account.
send_time_unixtime     scheduled send time in integer format. This is an alternative to send_time, and represents the number of seconds since 1 Jan 1970 UTC (GMT+0), also known as unixtime.
send_time_seconds     a flawed version of send_time_unixtime, provided only for backwards compatibility to clients already using it.
scheduling_description     if using scheduling, you could provide a description of the scheduled job here to later help identify it.
test_always_succeed   0 for testing purposes - if set to 1, does basic validation (username, password, etc) of your submission, but stops short of actually submitting the messages, and returns a successful status code as if it had submitted them successfully.
test_always_fail   0 as for test_always_succeed, but after basic validation, always returns a failure code.

Any of the above parameters which relate to message settings (e.g. routing_group or sender) will, if specified, form a default for the whole batch, which can be overridden on a message-by-message basis by the optional CSV columns specified later in this document (although not all parameters can be overridden).

CSV columns

column required description
msisdn the recipient mobile number
message the message body
sender    
msg_class    
dca    
routing_group    
source_id    
repliable    

Returns:

status_code|status_description|batch_id

(where batch_id is optional, depending on the error)

Possible values for status_code are:

status_code description
0 In progress (a normal message submission, with no error encountered so far).
1 Scheduled (see Scheduling below).
22 Internal fatal error
23 Authentication failure
24 Data validation failed
25 You do not have sufficient credits
26 Upstream credits not available
27 You have exceeded your daily quota
28 Upstream quota exceeded
40 Temporarily unavailable
201 Maximum batch size exceeded (current maximum size: 30,000 messages)

You should never depend on the value of status_description - only depend on status_code, which is a constant. However, status_description can contain useful information about the nature of failures when you are developing your initial application. batch_id is guaranteed to be a positive integer > 0, if present.

Note: you should attempt to resend if you receive status code 40. You could also do so if you receive 26 or 28, which might have been resolved after several resend attempts. All other errors should be considered fatal.

Any HTTP status code other than 200 should be considered transient, i.e. you should attempt to resend after some interval.

Validation

By default this API, unlike others we offer, tries to parse as much valid data as it can from your submission. Invalid lines that you submit should be ignored; invalid values for fields will be ignored or corrected (e.g. by truncating values that are too long) as far as possible.

Repliability

Repliability is a feature whereby the originating address (sender id) of a message is set to a number at which we will collect replies on your behalf, and make them available to you. The feature of repliability will not necessarily be possible on your account or for your destination(s). Also be aware that we may not have reply numbers available for your specific country, which means that persons who reply may be exposed to higher costs than those of sending SMSs in their own country, and poorer delivery speed may also result. The repliable parameter is incompatible with the sender parameter. Additionally, this parameter will override any default sender id which you may have set up on your account.

Scheduling

Scheduling allows you to specify that a message be sent at a future date. Credits will be deducted immediately from your account, and once submitted, such a message cannot be cancelled. Messages can be scheduled a maximum of two years in advance.

If you specify a date/time in the past, your message will be sent immediately, and a status code of 0 will be returned. If you correctly specify a future date for sending, you will receive a status code of 1. Thereafter, you will not be able to request the status of a scheduled message until after it has actually been sent. The date that you supply must be in the time zone that your account is configured for.

If the destination is a group, the group members will be determined at the time that you submit the message, and not at the time the message is scheduled to be sent.

Please be sure to check our Terms and Conditions for any special conditions that may apply to scheduled messaging, e.g. adjustments that may need to be made for significant price changes where messages are scheduled far into the future.

Eliminating duplicates

Consider the case where you submit a message, but experience a network timeout (or your application crashes). Your application cannot know if we received and processed the message or not, and you are forced to resubmit it, possibly generating duplicates. If the message was to many recipients, this can be serious.
By submitting a unique id of your own along with every message that you submit, you can safeguard against this. The optional parameter stop_dup_id takes an integer as an argument, in the range 1 to 2147483647. If you submit a message with a stop_dup_id that you have recently (within the past few hours) used in another submission, then that submission will not be processed, and you will receive the response to the original submission, e.g.:
0|IN_PROGRESS|30430
(where 30430 is the batch_id that was generated by the original submission)

In other words, the process is entirely transparent to you, and you will never know whether your submission was processed during the first or the second attempt. Failure statuses are not recorded, so resubmitting a message which failed on its first submission will never result in you receiving a cached result.

stop_dup_id’s are shared across send_sms and send_batch, so be sure not use the same id when using both API calls.

Route-specific features

Some features depend on how messages are routes, which again depends on certail pricing options which may have been applied to your account. Please contact us to find if such feature is available to you, if unsure.