Send Single SMS Message

This document will describe how to send a singular SMS message using our API.

POST /send/single

Send a single SMS message to recipient.

Curl

curl -X POST \
"http://api.mobivatebulksms.com/send/single" \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer [API Key]' \
-d '{ "originator": "Test", "recipient": "44700011122", "body": "This is a test message", "routeId": "mglobal" }'

Python

import requests

headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer [API Key]',
}

json_data = {
    'originator': 'Test',
    'recipient': '44700011122',
    'body': 'This is a test message',
    'routeId': 'mglobal',
}

response = requests.post('http://api.mobivatebulksms.com/send/single', headers=headers, json=json_data)

# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{ "originator": "Test", "recipient": "44700011122", "body": "This is a test message", "routeId": "mglobal" }'
#response = requests.post('http://api.mobivatebulksms.com/send/single', headers=headers, data=data)

Send a single SMS message with reference

Curl

curl -X POST \
"https://api.mobivatebulksms.com/send/single" \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer [API Key]' \
-d '{ "originator": "Test", "recipient": "44700011122", "body": "This is a test message", "routeId": "mglobal", "reference": "my-reference-1234" }'

Python

import requests

headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer [API Key]',
}

json_data = {
    'originator': 'Test',
    'recipient': '44700011122',
    'body': 'This is a test message',
    'routeId': 'mglobal',
    'reference': 'my-reference-1234',
}

response = requests.post('https://api.mobivatebulksms.com/send/single', headers=headers, json=json_data)

# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{ "originator": "Test", "recipient": "44700011122", "body": "This is a test message", "routeId": "mglobal", "reference": "my-reference-1234" }'
#response = requests.post('https://api.mobivatebulksms.com/send/single', headers=headers, data=data)

Send a single SMS message with campaign id

Curl

curl -X POST \
"https://api.mobivatebulksms.com/send/single" \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer [API Key]' \
-d '{ "originator": "Test", "recipient": "44700011122", "body": "This is a test message", "routeId": "mglobal", "reference": "myref", "campaignId": "abc-123" }'

Python

import requests

headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer [API Key]',
}

json_data = {
    'originator': 'Test',
    'recipient': '44700011122',
    'body': 'This is a test message',
    'routeId': 'mglobal',
    'reference': 'myref',
    'campaignId': 'abc-123',
}

response = requests.post('https://api.mobivatebulksms.com/send/single', headers=headers, json=json_data)

# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{ "originator": "Test", "recipient": "44700011122", "body": "This is a test message", "routeId": "mglobal", "reference": "myref", "campaignId": "abc-123" }'
#response = requests.post('https://api.mobivatebulksms.com/send/single', headers=headers, data=data)

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer [API Key]

Body

Name	Type	Required?	Description
originator	string	Yes	Originator/SenderID for SMS messages (MaxLength - AlphaNumeric: 11, numeric: 15).
recipient	string	Yes	Recipient of SMS Message (Numeric only, MSISDN format inc international prefix).
body	string	Yes	Message text.
routeID	string	Yes	Specified message route.
campaignId	string	No	Attach message to existing campaignId.
reference	string	No	Your reference, will be provided as part of the delivery receipt for correlation.
shorternUrls	boolean	No	Default: false If set to true, long urls included in the message will be shortened

Response

200

{
   "id":"ef5796ce-e326-4a09-9033-6b457039b1ba",
   "originator":"Test",
   "recipient":"44700011122",
   "body":"This is a test message",
   "routeId":"mglobal",
   "reference":null,
   "campaignId":null
}

401

{
   "code":401,
   "message":"Unauthorized"
}

To see a full list of SMS Responses and examples click here.