BulkGate Helpdesk
  • Languages iconEnglish
    • Czech

›Transactional SMS

Transactional SMS

  • Specification 2.0
  • Specification 1.0
  • Sending message to notification admin

Promotional SMS

  • Specification 2.0
  • Specification 1.0
  • Sending messages to groups from address book
  • Sending messages to notification admins

Check credit balance

  • Check credit balance

API Administration & Tokens

  • API administration & tokens

Error types

  • Error types

Delivery confirmations and incoming SMS

  • Delivery confirmations and incoming SMS
  • Bulk delivery confirmation of incoming SMS

Specification 1.0

API URL

URL used to send HTTP requests:

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

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

Parameters table

PARAMETER NAMEVALUEMANDATORYDEFAULT VALUE
application_idApplication IDYes-
application_tokenApplication tokenYes-
numberRecipient numberYes or admin-
adminNumber of BulkGate administrator receiving notification. More infoYes or number-
textText of the SMS message (max. 612 characters, or 268 characters, if Unicode is activated), 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[]
unicodeYes/true/1 for Unicode SMS, no/false/0 for 7bit SMSNofalse
sender_idSender ID, see Sender ID typeNogSystem
sender_id_valueSender value - gOwn (e.g. "420 777 777 777"), gText (e.g. "BulkGate"), gProfile (e.g. "423"), gMobile or gPush (KEY)Nonull
countryProvide recipient numbers in international format (with prefix, for e.g 44), or add country code (7820125799 + GB = 447820125799). See the example of a country requirement. If the value is null, your set time zone will be used to fill in 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 mins. If off no duplicates will be removed.Nooff
tagMessage label for subsequent retrieval of the user.No-

Sender ID type sender_id

VALUEMEANING
gSystemSystem number
gShortShort Code
gTextText sender
gMobileMobile Connect
gPushMobile Connect push - Sends a notification to the Mobile Connect app
gOwnOwn number (requires number verification)
gProfileBulkGate Profile ID
<int>BulkGate Profile ID

Example of full request:

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

{
    "application_id": "APPLICATION_ID",
    "application_token": "APPLICATION_TOKEN",   
    "number": "447820125799",
    "unicode": true,
    "text": "Hello, <first_name> <last_name>",
    "variables": {"first_name": "John", "last_name": "Doe"},
    "sender_id": "gText",
    "sender_id_value": "BulkGate",
    "country": "cz",
    "schedule": "2018-05-14T18:30:00-01:00"
}

Response to this command may be:

In case of success:

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

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.

← Specification 2.0Sending message to notification admin →
  • API URL
  • Parameters table
    • Sender ID type sender_id
  • Response to this command may be:
SolutionsSMS GatewayViber for BusinessBroadcastBulk SMSSMS NotificationsTwo-way SMSMobile ConnectWeb Portal
Partners & DevelopersSMS APIIntegrationsAffiliate programWhite label
SourcesBlogYouTubeFacebookLinkedInTwitterGitHubPackagist
CompanyContactPrivacyTerms and Conditions
Price listsPrice list SMSPrice list ViberPrice list Mobile Connect
SMS GatewayTOPefekt s.r.o. © 2023