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/conversations

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/conversations" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "profileId": "string",
      "address": "string",
      "connectionId": "string",
      "lastText": "string",
      "lastAt": "2024-01-01T00:00:00Z",
      "unread": 0,
      "assignedUserId": "string",
      "inboundId": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

profileIdstringrequired

addressstringrequired

connectionIdstringrequired

lastTextstringrequired

lastAtstringrequired

unreadintegerrequired

assignedUserIdstringrequired

inboundIdstringrequired

nextCursorstringrequired

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/conversations

GEThttps://hermeticor.com/v1/sms/conversations/{profileId}

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

profileIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/sms/conversations/{profileId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "kind": "received",
      "id": "string",
      "at": "2024-01-01T00:00:00Z",
      "text": "string",
      "status": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

kindstringrequired

received | sent

idstringrequired

atstringrequired

textstringrequired

statusstringrequired

nextCursorstringrequired

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/sms/conversations/{profileId}/read

Parameters

profileIdstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sms/conversations/{profileId}/read" \
  -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/conversations

5XX Default Response

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

POSThttps://hermeticor.com/v1/sms/conversations/{profileId}/reply

Parameters

profileIdstringpathrequired

Request body

application/json

connectionIdstringrequired

bodystringrequired

idempotencyKeystringrequired

{
  "connectionId": "string",
  "body": "string",
  "idempotencyKey": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sms/conversations/{profileId}/reply" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionId":"string","body":"string","idempotencyKey":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "jobId": "string",
  "status": "queued",
  "reason": "string"
}

Schema

jobIdstringrequired

statusstringrequired

queued | blocked | deferred | duplicate

reasonstring

4XX Default Response

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

5XX Default Response

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

GEThttps://hermeticor.com/v1/sms/canned-replies

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/canned-replies" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "title": "string",
      "body": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem124[]required

Show child parameters

idstringrequired

titlestringrequired

bodystringrequired

nextCursorstringrequired

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/sms/canned-replies

Request body

application/json

titlestringrequired

bodystringrequired

{
  "title": "string",
  "body": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sms/canned-replies" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","body":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "title": "string",
  "body": "string"
}

Schema

idstringrequired

titlestringrequired

bodystringrequired

4XX Default Response

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

5XX Default Response

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

DELETEhttps://hermeticor.com/v1/sms/canned-replies/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/sms/conversations/{profileId}/read

4XX Default Response

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

5XX Default Response

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

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

Text messages sent this month against the plan allowance. Carrier balances stay with the carrier.

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "period": "string",
  "used": 0,
  "limit": 0,
  "remaining": 0
}

Schema

periodstringrequired

usednumberrequired

limitnumberrequired

remainingnumberrequired

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/sms/ai-drafts

Write a text message from a brief; a draft for a person to review, never sent

Request body

application/json

briefstringrequired

tonestring

{
  "brief": "string",
  "tone": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sms/ai-drafts" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"brief":"string","tone":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "brief": "string",
  "tone": "string",
  "channel": "string",
  "text": "string",
  "model": "string",
  "draft": true
}

Schema

idstringrequired

briefstringrequired

tonestringrequired

channelstringrequired

textstringrequired

modelstringrequired

draftbooleanrequired

true

4XX Default Response

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

5XX Default Response

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

GEThttps://hermeticor.com/v1/sms/ai-drafts/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sms/ai-drafts

4XX Default Response

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

5XX Default Response

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

PUThttps://hermeticor.com/v1/sms/ai-drafts/{id}

Write it again from a new brief or tone, replacing this draft

Parameters

idstringpathrequired

Request body

application/json

briefstringrequired

tonestring

{
  "brief": "string",
  "tone": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/sms/ai-drafts/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"brief":"string","tone":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sms/ai-drafts

4XX Default Response

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

5XX Default Response

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

Updated Nov 8, 2026

Was this page helpful?