Msg4

Msg4

HTTP API Specifications Document


  1. Send Single SMS
    Parameter Name, Value and Description
    Parameter Description
    apikey User Msg4 Account Api key
    sid Sender Id of the message
    to Destination mobile no.
    msg Message to be sent
    tmpid DLT Template Id
    Response: The customer would get following response values for sending messages.
    Inputs Return values <STATUS>OK</STATUS><MESSAGE>SMS SENT</MESSAGE>

  2. Check Account Balance
    Parameter Name, Value and Description
    Parameter Description
    apikey User Msg4 Account Api key

  3.  API parameters in details
    • Api Key (apikey)
      The user api key parameter value is passed for authentication purposes. The user api (apikey) parameter generated from Robeeta Cloud Console

    • Mobile Number (to)
      The mobile number parameter refers to the destination mobile number to which the message is to be sent. However, the mobile number is required to be in a specific format. Any error in this parameter value would lead to non-delivery of the message. The mobile number should contain only numbers. It must also include the country code at the start beginning. It should not contain any symbols (+) or 00 etc.

    • Message Parameter (msg)
      The message parameter refers to the actual message that is to be sent to the destination mobile (msg). The behavior of the message parameter differs depending on the type of message being sent.

      The message parameter may consist of up to 160 characters belonging to the following set:
              • A…Z a…z 0…9
              • Blank space
              • The meta characters \ (line feed)

      Due to restrictions in the HTTP protocol format, the following special characters must be encoded in order not to collide with reserved HTTP characters:

      Character must be encoded as:

      Character Hexa-decimal Encoded String
      & %26
      + %2B
      % %25
      # %23
      = %3D

      For simple text messages, the message can contain numbers, alphabets, spaces and certain special characters.

      However, the message can contain a maximum of 160 characters, including spaces.

      In case of Unicode messaging, the message can contain only numbers in the form of Unicode digits. Further, it can be a maximum of 70 characters i.e. 70 x 4 Unicode digits for each character = 280 digits.

      In case of binary messaging, the message can contain only valid 8-bit data string. The binary message can be maximum of 140 characters only (i.e. one SMS). However, Ring tones, operator logos & Pictures that exceed one SMS can also be sent in form of concatenated SMS.

    • Sender Id (sid)
      The sender Id parameter refers to the message dispatcher or from clause (THE SENDER), from whom the message is sent.

      The sender Id cans either be a valid international number up to fifteen characters long or an eleven character alphanumeric string.