sms

Embed

<a href="https://hermeticor.com/docs/ref-sms"><img src="https://hermeticor.com/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>

GEThttps://hermeticor.com/v1/sms/configuration

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/sms/configuration" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "defaultSenderId": "string",
  "sendingStartMin": 0,
  "sendingEndMin": 0,
  "timezone": "string",
  "company": {
    "name": "string",
    "website": "string",
    "address": "string",
    "contactEmail": "string",
    "phone": "string"
  },
  "templates": {
    "help": "string",
    "stop": "string",
    "start": "string",
    "optIn": "string"
  },
  "countryRules": [
    {
      "country": {},
      "enabled": true,
      "quietStartMin": 0,
      "quietEndMin": 0,
      "senderId": "string"
    }
  ],
  "configured": true,
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

defaultSenderIdstringrequired

sendingStartMinintegerrequired

sendingEndMinintegerrequired

timezonestringrequired

companyobjectrequired

Show child parameters

namestring

websitestring

addressstring

contactEmailstring

phonestring

templatesobjectrequired

Show child parameters

helpstringrequired

stopstringrequired

startstringrequired

optInstringrequired

countryRulesCountryRulesItem[]required

Show child parameters

countryrequired

enabledbooleanrequired

= true

quietStartMininteger

quietEndMininteger

senderIdstring

configuredbooleanrequired

updatedAtstringrequired

4XX Default Response

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/sms/configuration

PUThttps://hermeticor.com/v1/sms/configuration

Request body

application/json

defaultSenderIdstring

sendingStartMininteger

sendingEndMininteger

timezonestring

companyobject

Show child parameters

namestring

websitestring

addressstring

contactEmailstring

phonestring

templatesobject

Show child parameters

helpstring

stopstring

startstring

optInstring

countryRulesobject[]

Show child parameters

countrystringrequired

enabledboolean

= true

quietStartMininteger

quietEndMininteger

senderIdstring

{
  "defaultSenderId": "string",
  "sendingStartMin": 0,
  "sendingEndMin": 0,
  "timezone": "string",
  "company": {
    "name": "string",
    "website": "string",
    "address": "string",
    "contactEmail": "string",
    "phone": "string"
  },
  "templates": {
    "help": "string",
    "stop": "string",
    "start": "string",
    "optIn": "string"
  },
  "countryRules": [
    {
      "country": "string",
      "enabled": true,
      "quietStartMin": 0,
      "quietEndMin": 0,
      "senderId": "string"
    }
  ]
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/sms/configuration" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"defaultSenderId":"string","sendingStartMin":0,"sendingEndMin":0,"timezone":"string","company":{"name":"string","website":"string","address":"string","contactEmail":"string","phone":"string"},"templates":{"help":"string","stop":"string","start":"string","optIn":"string"},"countryRules":[{"country":"string","enabled":true,"quietStartMin":0,"quietEndMin":0,"senderId":"string"}]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/sms/configuration

4XX Default Response

Same as 4XX · GET /v1/sms/configuration

5XX Default Response

Same as 4XX · GET /v1/sms/configuration

GEThttps://hermeticor.com/v1/sms/links

Parameters

limitintegerquery

= 50

cursorstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/sms/links" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "code": "string",
      "url": "string",
      "shortUrl": "string",
      "profileId": "string",
      "expiresAt": "2024-01-01T00:00:00Z",
      "clickCount": 0,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem122[]required

Show child parameters

idstringrequired

codestringrequired

urlstringrequired

shortUrlstringrequired

profileIdstringrequired

expiresAtstringrequired

clickCountintegerrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/sms/configuration

5XX Default Response

Same as 4XX · GET /v1/sms/configuration

POSThttps://hermeticor.com/v1/sms/links

Request body

application/json

urlstringrequired

profileIdstring

ttlDaysinteger

{
  "url": "string",
  "profileId": "string",
  "ttlDays": 0
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sms/links" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"string","profileId":"string","ttlDays":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "code": "string",
  "url": "string",
  "shortUrl": "string",
  "profileId": "string",
  "expiresAt": "2024-01-01T00:00:00Z",
  "clickCount": 0,
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

codestringrequired

urlstringrequired

shortUrlstringrequired

profileIdstringrequired

expiresAtstringrequired

clickCountintegerrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/sms/configuration

5XX Default Response

Same as 4XX · GET /v1/sms/configuration

GEThttps://hermeticor.com/s/{code}

Short-link redirect (records a click)

Parameters

codestringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/s/{code}"

TypeScript

Python

PHP

Ruby

Java

Responses

302 Default Response

"string"

4XX Default Response

Same as 4XX · GET /v1/sms/configuration

5XX Default Response

Same as 4XX · GET /v1/sms/configuration

GEThttps://hermeticor.com/v1/sms/keywords

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/sms/keywords" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "keyword": "string",
      "replyText": "string",
      "action": "none",
      "tag": "string",
      "active": true
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem123[]required

Show child parameters

idstringrequired

keywordstringrequired

replyTextstringrequired

actionstringrequired

none | grant_consent | add_tag

tagstringrequired

activebooleanrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/sms/configuration

5XX Default Response

Same as 4XX · GET /v1/sms/configuration

POSThttps://hermeticor.com/v1/sms/keywords

Request body

application/json

keywordstringrequired

replyTextstring

actionstring

none | grant_consent | add_tag = none

tagstring

activeboolean

= true

{
  "keyword": "string",
  "replyText": "string",
  "action": "none",
  "tag": "string",
  "active": true
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sms/keywords" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"keyword":"string","replyText":"string","action":"none","tag":"string","active":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "keyword": "string",
  "replyText": "string",
  "action": "none",
  "tag": "string",
  "active": true
}

Schema

idstringrequired

keywordstringrequired

replyTextstringrequired

actionstringrequired

none | grant_consent | add_tag

tagstringrequired

activebooleanrequired

4XX Default Response

Same as 4XX · GET /v1/sms/configuration

5XX Default Response

Same as 4XX · GET /v1/sms/configuration

PUThttps://hermeticor.com/v1/sms/keywords/{id}

Parameters

idstringpathrequired

Request body

application/json

keywordstringrequired

replyTextstring

actionstring

none | grant_consent | add_tag = none

tagstring

activeboolean

= true

{
  "keyword": "string",
  "replyText": "string",
  "action": "none",
  "tag": "string",
  "active": true
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/sms/keywords/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"keyword":"string","replyText":"string","action":"none","tag":"string","active":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sms/keywords

4XX Default Response

Same as 4XX · GET /v1/sms/configuration

5XX Default Response

Same as 4XX · GET /v1/sms/configuration

DELETEhttps://hermeticor.com/v1/sms/keywords/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/sms/keywords/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/sms/configuration

5XX Default Response

Same as 4XX · GET /v1/sms/configuration

Next part

Updated Nov 8, 2026

Was this page helpful?