SMS Service API
 1.0.0 
OAS3

/atlas-sms-api.yaml

An API for sending and checking SMS message delivery

Parameters

No parameters

Request body

{
                                     "auth": "67ae1e21-25ba-4e82-99be-c0a49e9a",
                                      "sender": "555555555",
                                      "receiver": "555555666",
                                      "text": "Hello%20World",
                                      "dcs": "GSM"
                                    }

Responses

CodeDescriptionLinks
200

SMS sent successfully

Media type
Controls Accept header.
{
                                      "msgId": "abc123",
                                      "numParts": 1,
                                      "totalCost": 0.25,
                                      "clientBalance": 50
                                    }
No links
400

Bad request

Media type
{
                                      "code": 400,
                                      "message": "Unable to send message"
                                    }
No links
403

Unauthorized request

Media type
{
                                      "code": 403,
                                      "message": "Unauthorized request"
                                    }
No links

Parameters

NameDescription
auth *
string
(query)

Unique client token for authentication

messageId *
string
(query)

ID of the SMS message to check

Responses

CodeDescriptionLinks
200

Delivery status retrieved successfully

Media type
Controls Accept header.
{
                                      "msgId": "abc123",
                                      "event": "delivered",
                                      "numParts": 1,
                                      "sendTime": "2023-08-12T14:00:00Z",
                                      "dlrTime": "2023-08-12T15:30:00Z"
                                    }
No links
400

Bad request

Media type
{
                                      "code": 400,
                                      "message": "Unable to send message"
                                    }
No links
403

Unauthorized request

Media type
{
                                      "code": 400,
                                      "message": "Unable to send message"
                                    }
No links
404

Message not found

Media type
{
                                      "code": 400,
                                      "message": "Unable to send message"
                                    }
No links

auth*string
example: 67ae1e21-25ba-4e82-99be-c0a49e9a

Unique client token for authentication

sender*string
example: 555555555

Sender's phone number

receiver*string
example: 555555666

Receiver's phone number

textstring
example: Hello%20World

SMS message content. Must be URL encoded.

dcs*string
example: GSM

Data Coding Scheme for the message

Enum:
}

msgIdstring
example: abc123
numPartsinteger
example: 1
totalCostnumber
example: 0.25
clientBalancenumber
example: 50
}

msgIdstring
example: abc123
eventstring
example: delivered
numPartsinteger
example: 1
sendTimestring($date-time)
example: 2023-08-12T14:00:00Z
dlrTimestring($date-time)
example: 2023-08-12T15:30:00Z
}