Specification 2.0

API URL

The URL used to send the HTTP requests:

https://portal.bulkgate.com/api/2.0/advanced/transactional

POST /api/2.0/advanced/transactional HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache

Documentation of a previous version can be found here

It is strictly prohibited to exploit transactional SMS for promotional/marketing uses. It must be used for notification purposes only - as an SMS notification.

Parameters table

PARAMETER NAMEVALUEMANDATORYDEFAULT VALUE
application_idApplication indentificatorYes-
application_tokenApplication authentication tokenYes-
numberRecipient numberYes-
textText of SMS message (max. 612 characters, or 268 characters if Unicode is used), UTF-8 encoding. It is possible to add variables to the template from the variables array (another parameter) Hello <first_name> <last_name> ....Yes-
variablesAssociative array to add variables to text, for e.g.: {"first_name": "John", "last_name": "Doe"}No[]
channelAlternative channels. Channels are listed in a cascade, if we are unable to deliver your message via highest priority channel, channels lower in the cascade list will be used. If none of them manages to deliver sms will be used instead.NoSMS object
countryProvide the recipients' numbers in an international format (with prefix, e.g. 44) or add the country code in ISO 3166-1 alpha-2 format (7820125799 + GB = 447820125799). See the country example request. If null, your set timezone will be used to fill the informationNonull
scheduleSchedule the sending time and date in unix timestamp, or ISO 8601.NoNow
duplicates_checkSelect on to prevent sending duplicate messages to the same phone number. Messages with the same text sent to the same number will be removed if there is a time interval shorter than 5 minutes. If off no duplicates will be removed.Nooff

SMS object parameters table

PARAMETER NAMEVALUEMANDATORYDEFAULT VALUE
textText of SMS message (max. 612 characters, or 268 characters if Unicode is used), UTF-8 encoding. It is possible to add variables to the template from the variables array (another parameter) Hello <first_name> <last_name> ....Yes, if general text isn't used. If SMS object contains text parameter as well as general text parameter, SMS text will be used instead-
sender_idSender ID, see sender ID typeNogSystem
sender_id_valueSender value of gOwn, gText, gMobile, gProfile or gPush (if gMobile, or gPush used, please supply mobile connect key as sender_id_value)Nonull
unicodeYes/true/1 for Unicode SMS, no/false/0 for 7bit SMSNofalse

Sender ID type sender_id

VALUEDESCRIPTION
gSystemSystem number
gShortShort Code
gTextText sender
gMobileMobile Connect - Sends SMS message through Mobile Connect app
gPushMobile Connect push - Sends a notification to the Mobile Connect app
gOwnOwn Number (number verification required)
gProfileBulkGate Profile ID
<int>BulkGate Profile ID

Viber object parameters table

PARAMETER NAMEVALUEMANDATORYDEFAULT VALUE
textText of SMS message (max. 612 characters, or 268 characters if Unicode is used), UTF-8 encoding. It is possible to add variables to the template from the variables array (another parameter) Hello <first_name> <last_name> ....Yes, if general text isn't used. If Viber object contains text parameter as well as general text parameter, Viber text will be used instead-
senderSenderNo""
expirationTime limit after which alternative channel will be usedNo120

Example of full request:

POST /api/2.0/advanced/promotional HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache

{
    "application_id": "****",
    "application_token": "******************************",
    "application_product": "http-advanced",
    "number": "420111222333",
    "text": "example text <first_name>",
    "variables": {"first_name": "Lt. Mosley"},
    "country": "cz",
    "schedule": "2018-05-14T18:30:00-01:00",
    "channel": {
      "viber": {
        "sender": "Lt. Hagan",
        "expiration": 100,
        "text": "example text"
      },
      "sms": {
        "sender_id": "gText",
        "sender_id_value": "Lt-Hagan",
        "unicode": true,
        "text": "example text"
      }
    }
}

Response to this command may be:

In case of success:

{
    "data": {
        "status": "accepted",
        "sms_id": "tmpde1bcd4b1d1",
        "price": 0.02,
        "credit": 215.81380,
        "number": "447700900000"
    }
}

In case of error:

{
    "type": "invalid_phone_number",
    "code": 400,
    "error": "Invalid phone number",
    "detail": null
}

{
    "type": "unknown_identity",
    "code": 401,
    "error": "Unknown identity / unauthorized / empty application_id",
    "detail": null
}

Where:

  • type and error (description of the error) can be found in the error types table,
  • code represents http error
  • detail is an additional info about the error

See all the error types for Simple API and Advanced API here.

Next →