logo
Documentation Powered by ReDoc

Evt's SMS Messaging Service (v1.0)

Download OpenAPI specification:Download

This API is meant to provide a centralized sms messaging service to our core business and other desired integrations.

For now there's only possible endpoint POST /busDelivery which is further documented later on the page.

Errors

All of the error handling of this API is done with status codes and error messages according to the following structure:

{
  "error": "Missing parameters"
}

Versioning

This documentation regards version v1.0 of the SMS Messaging Service.

Authentication

Authentication for registries is handled client side. The client has to send authentication details on all calls. The required authorization key must be sent as Authorization header as string with the following structure:

{
  "Authorization": "string",
}

Callback

In case of providing a callback , the returned params will be always return the status code 2xx in case of success or one HTTP code 4xx or 5xx and the payload with a statusMessage property.The returned object have the follwing schema:

processingId
required
string <hex> (ID of the message)

The same ID returned the first time the message was delivered to the queue

status
required
number (HTTP Status Code of the response)

200 in case of success, and 4XX 5XX in case of error

statusMessage
string (Error message)

In case of an error, this property will contain the raw error thrown

{
  • "processingId": "604791e3246f1c143210ceac",
  • "status": 400,
  • "statusMessage": "Your message quota has exceeded"
}

SMS

SMS payload request, in posession of that information this service can actually do the heavy-lifting for you.

Send SMS

Send SMS

Request Body schema: application/json
to
required
string <phone number>

The target phone, with DDD and 9 numbers after it, otherwise the system will throw an error. Ideally with country code such as 55, although not necessary.

shouldPreserveMessage
boolean <boolean>
Default: false

Should save the message content on the log

message
required
string <plain text>

The actual content of the sms to be sent, is expected a regular text

callback
string <url>

The callback endpoint you want our system to communicate in case of a failure or success. This procs after the delivery to queue stage

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
text/plain
604791e3246f1c143210ceac