Reference Documentation

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

• https://developers.smswithoutborders.com:14000

API V1 Endpoints

Action	Endpoint	Parameters	Request body
Send SMS	POST /v1/sms	None	auth_id = STRING data = [{text = STRING, number = STRING, operator_name = STRING}] callback_url = STRING uuid = STRING
Get Phone number operator name	POST /v1/sms/operators	None	[{text = STRING, number = STRING, operator_name = STRING}]

Warning

We advise you to use this endpoint safely in the back-end to avoid exposing your developer’s token to unauthorized persons.

Examples using curl

Send single SMS message

Note

The uuid key is any random string provided by the user used to identify the request. If left empty, OpenAPI will populate the uuid key with a randomly generated uuid.

The callback_url will be invoked after the request is complete with a POST in the form:

{
    "errors": [{
        "operator_name":"",
        "number":"",
        "error_message": "",
        "timestamp": ""
        }],
    "uuid": ""
}

• If the errors array is empty all messages were sent out successfully.

curl --location --request POST 'https://developers.smswithoutborders.com:14000/v1/sms' \
--header 'Content-Type: application/json' \
--data-raw '{
"auth_id":"",
"data": [{
    "operator_name":"",
    "text":"",
    "number":""
    }],
"callback_url": "",
"uuid": ""
}'

Send bulk SMS messages

curl --location --request POST 'https://developers.smswithoutborders.com:14000/v1/sms' \
--header 'Content-Type: application/json' \
--data-raw '{
"auth_id":"",
"data": [{
    "operator_name":"",
    "text":"",
    "number":""
    },
    {
    "operator_name":"",
    "text":"",
    "number":""
    },
    {
    "operator_name":"",
    "text":"",
    "number":""
    }],
"callback_url": "",
"uuid": ""
}'

Get Phone Number operator name

If the operator_name key is an empty string or not present in the request, It will be generated and populated in the response. But if the operator_name key is present it won’t be modified in the response.

curl --location --request POST 'https://developers.smswithoutborders.com:14000/v1/sms/operators' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
    "operator_name":"",
    "text":"",
    "number":""
    },
    {
    "operator_name":"",
    "text":"",
    "number":""
    },
    {
    "operator_name":"",
    "text":"",
    "number":""
    }
]'

Note

The phone number format to be used in the request bodies of the API calls should be E.164.