sms

Embed

<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-sms"><img src="https://hermetica.15.204.158.166.sslip.io/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/9005a6e7-ead4-47c5-8f24-45fd392fda3a/social-card.svg?v=3e7ae33eec8b" alt="sms" width="600" height="315"></a>

POSThttps://hermetica.15.204.158.166.sslip.io/v1/sms/estimate

Segments, encoding warnings and cost for an SMS/MMS send

Request body

application/json

bodystringrequired

mediaCountinteger

= 0

recipientsobjectrequired

Recipient count per country (ISO 3166-1 alpha-2), e.g. { "US": 1200, "GB": 300 }

shortenLinksboolean

= true

{
  "body": "string",
  "mediaCount": 0,
  "recipients": {},
  "shortenLinks": true
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/sms/estimate" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"string","mediaCount":0,"recipients":{},"shortenLinks":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "encoding": "GSM-7",
  "segments": 0,
  "unicodeChars": [
    "string"
  ],
  "gsmSegments": 0,
  "mms": true,
  "warnings": [
    "string"
  ],
  "recipients": 0,
  "billableSegments": 0,
  "estimatedCostUsd": 0,
  "perCountry": [
    {
      "country": "string",
      "recipients": 0,
      "costUsd": 0
    }
  ]
}

Schema

encodingstringrequired

GSM-7 | UCS-2

segmentsintegerrequired

unicodeCharsstring[]required

gsmSegmentsintegerrequired

mmsbooleanrequired

warningsstring[]required

recipientsintegerrequired

billableSegmentsintegerrequired

estimatedCostUsdnumberrequired

perCountryobject[]required

Show child parameters

countrystringrequired

recipientsintegerrequired

costUsdnumberrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/sms/estimate

POSThttps://hermetica.15.204.158.166.sslip.io/v1/sms/quiet-hours

Recipient-local quiet-hours preview per country

Request body

application/json

countriesstring[]required

{
  "countries": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/sms/quiet-hours" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"countries":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "country": "string",
      "zone": "string",
      "allowed": true,
      "nextSendAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Schema

itemsobject[]required

Show child parameters

countrystringrequired

zonestringrequired

allowedbooleanrequired

nextSendAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/sms/estimate

5XX Default Response

Same as 4XX · POST /v1/sms/estimate

POSThttps://hermetica.15.204.158.166.sslip.io/v1/sms/media/validate

Request body

application/json

itemsobject[]required

Show child parameters

urlstringrequired

contentTypestringrequired

sizeBytesintegerrequired

{
  "items": [
    {
      "url": "string",
      "contentType": "string",
      "sizeBytes": 0
    }
  ]
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/sms/media/validate" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"items":[{"url":"string","contentType":"string","sizeBytes":0}]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true,
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "totalBytes": 0
}

Schema

okbooleanrequired

errorsstring[]required

warningsstring[]required

totalBytesintegerrequired

4XX Default Response

Same as 4XX · POST /v1/sms/estimate

5XX Default Response

Same as 4XX · POST /v1/sms/estimate

GEThttps://hermetica.15.204.158.166.sslip.io/v1/sms/carrier-errors

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/sms/carrier-errors" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "code": "string",
      "title": "string",
      "guidance": "string",
      "retryable": true
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

codestringrequired

titlestringrequired

guidancestringrequired

retryablebooleanrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/sms/estimate

5XX Default Response

Same as 4XX · POST /v1/sms/estimate

GEThttps://hermetica.15.204.158.166.sslip.io/v1/sms/carrier-errors/{code}

Parameters

codestringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/sms/carrier-errors/{code}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "code": "string",
  "title": "string",
  "guidance": "string",
  "retryable": true
}

Schema

codestringrequired

titlestringrequired

guidancestringrequired

retryablebooleanrequired

4XX Default Response

Same as 4XX · POST /v1/sms/estimate

5XX Default Response

Same as 4XX · POST /v1/sms/estimate

GEThttps://hermetica.15.204.158.166.sslip.io/v1/sms/registrations

Parameters

limitintegerquery

= 50

cursorstringquery

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/sms/registrations" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "kind": "tendlc_brand",
      "connectionId": "string",
      "status": "draft",
      "parentId": "string",
      "externalId": "string",
      "payload": {},
      "errorCode": "string",
      "errorMessage": "string",
      "guidance": "string",
      "submittedAt": "2024-01-01T00:00:00Z",
      "lastPolledAt": "2024-01-01T00:00:00Z",
      "history": [
        {
          "at": "string",
          "status": "draft",
          "note": "string",
          "errorCode": "string"
        }
      ],
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

kindstringrequired

tendlc_brand | tendlc_campaign | toll_free | short_code

connectionIdstringrequired

statusstringrequired

parentIdstringrequired

externalIdstringrequired

payloadobjectrequired

errorCodestringrequired

errorMessagestringrequired

guidancestringrequired

submittedAtstringrequired

lastPolledAtstringrequired

historyobject[]required

Show child parameters

atstringrequired

statusstringrequired

notestring

errorCodestring

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/sms/estimate

5XX Default Response

Same as 4XX · POST /v1/sms/estimate

POSThttps://hermetica.15.204.158.166.sslip.io/v1/sms/registrations

Request body

application/json

kindstringrequired

tendlc_brand | tendlc_campaign | toll_free | short_code

connectionIdstringrequired

parentIdstring

payloadobjectrequired

{
  "kind": "tendlc_brand",
  "connectionId": "string",
  "parentId": "string",
  "payload": {}
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/sms/registrations" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"tendlc_brand","connectionId":"string","parentId":"string","payload":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "kind": "tendlc_brand",
  "connectionId": "string",
  "status": "draft",
  "parentId": "string",
  "externalId": "string",
  "payload": {},
  "errorCode": "string",
  "errorMessage": "string",
  "guidance": "string",
  "submittedAt": "2024-01-01T00:00:00Z",
  "lastPolledAt": "2024-01-01T00:00:00Z",
  "history": [
    {
      "at": "string",
      "status": "draft",
      "note": "string",
      "errorCode": "string"
    }
  ],
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

kindstringrequired

tendlc_brand | tendlc_campaign | toll_free | short_code

connectionIdstringrequired

statusstringrequired

parentIdstringrequired

externalIdstringrequired

payloadobjectrequired

errorCodestringrequired

errorMessagestringrequired

guidancestringrequired

submittedAtstringrequired

lastPolledAtstringrequired

historyobject[]required

Show child parameters

atstringrequired

statusstringrequired

notestring

errorCodestring

createdAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/sms/estimate

5XX Default Response

Same as 4XX · POST /v1/sms/estimate

GEThttps://hermetica.15.204.158.166.sslip.io/v1/sms/registrations/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/sms/registrations/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sms/registrations

4XX Default Response

Same as 4XX · POST /v1/sms/estimate

5XX Default Response

Same as 4XX · POST /v1/sms/estimate

Next part

Updated Nov 3, 2026

Was this page helpful?