BulkGate Helpdesk
  • Languages iconEnglish
    • Czech

›Transactional SMS

Transactional SMS

  • Specification
  • GET Method
  • POST Method - json
  • POST Method - form

Promotional SMS

  • Specification
  • GET Method
  • POST Method - json
  • POST Method - form

Check credit balance

  • Check credit balance
  • Requests

API Administration & Tokens

  • API administration & tokens

Examples of implementation

  • Transactional SMS examples
  • Promotional SMS examples

Error types

  • Error types

Delivery confirmations and incoming SMS

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

Specification

API URL

The URL used to send the HTTP requests:

https://portal.bulkgate.com/api/1.0/simple/transactional

Supported methods

  • GET
  • POST - application/x-www-form-urlencoded
  • POST - application/json

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 encodingYes-
unicodeYes/true/1 for Unicode SMS, no/false/0 for 7bit SMSNofalse
sender_idSender ID, viz 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 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
tagMessage label for subsequent retrieval of the user.No-

Sender ID type sender_id

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

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.

GET Method →
  • API URL
    • Supported methods
    • 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