HTTP API v1 (Legacy)

Legacy integration interface. For new integrations, use REST API v2.

Authentication

The v1 API receives username and password as query parameters. HTTP Basic Authentication and POST requests are not supported. Because v1 places the password in the URL, new integrations should use REST API v2.

Submit one SMS

GET /v1/send

Parameters

Field Required Description
username Yes SMPP account system ID, maximum 30 characters.
password Yes SMPP account password.
to Yes One destination number, optionally beginning with +.
from No Sender ID, maximum 20 characters. The account default is used when omitted.
content Conditional Text message. Mutually exclusive with hex-content.
hex-content Conditional Even-length hexadecimal binary content. Mutually exclusive with content.
coding No SMPP data_coding. Omit it to automatically select GSM-7 or UCS-2 for text.
priority No Priority from 0 to 3. Default: 0.
sdt No SMPP scheduled-delivery time, maximum 16 characters.
validity-period No Relative validity period in minutes, from 1 to 525600.
dlr No yes or no. Default: no.
dlr-url Conditional HTTP or HTTPS callback URL. Required when dlr=yes.
dlr-level No 1, 2, or 3. Default: 1.
dlr-method No Customer callback method: GET or POST. Default: GET.
tags No Comma-separated routing or audit tags, maximum 20 tags.

Exactly one of content and hex-content must be supplied.

Example

curl --get 'https://sms.notrel.net/v1/send' \
  --data-urlencode 'username=YOUR_SYSTEM_ID' \
  --data-urlencode 'password=YOUR_PASSWORD' \
  --data-urlencode 'to=243816888222' \
  --data-urlencode 'from=NOTICE' \
  --data-urlencode 'content=Your verification code is 482901'

Successful response

Success "550e8400-e29b-41d4-a716-446655440000"

The response is plain text. The UUID is the Notrel Messaging submission ID.

Check balance

GET /v1/balance?username=...&password=...

Example response

{
    "balance": 100.0,
    "sms_count": "ND"
}

The balance is shared by all SMPP accounts belonging to the customer and is expressed in the customer's configured currency.

Get a rate

GET /v1/rate

Parameters

Field Required Description
username Yes SMPP account system ID.
password Yes SMPP account password.
to Yes Destination number.
content No Text used to calculate the segment count.
coding No Explicit SMPP data_coding.

Example response

{
    "submit_sm_count": 2,
    "unit_rate": 0.028
}

submit_sm_count is the estimated number of billable SMS segments and unit_rate is the price per segment.

v1 errors

Errors are returned as plain text:

Error "Error description"
Status Meaning
400 Missing, invalid, conflicting, or unknown parameter.
403 Authentication, authorization, account state, pricing, or credit rejection.
412 No active route or effective customer rate is available.
500 Internal gateway error.

Base URL: https://sms.notrel.net. Use the SMPP account system ID and password from the customer portal. See credentials and shared behavior and delivery receipts.