Skip to main content
POST
/
text
/
segments
curl --request POST \ --url https://collectwiseapi.com/text/segments \ --header 'Content-Type: application/json' \ --header 'collectwise_key: <api-key>' \ --data ' { "message": "Hi Jane, your balance is $430.10. Reply STOP to opt out." } '
{
  "encoding": "GSM-7",
  "characterCount": 57,
  "gsm7Length": 57,
  "segmentCount": 1,
  "maxCharsPerSegment": 160,
  "messageSizeBits": 399
}
{
  "error": "Provide either message or templateId"
}
{
  "error": "Too many requests"
}

Authorizations

​
collectwise_key
string
header
required

Body

application/json
​
message
string

A raw message to measure. Provide this OR templateId.

​
templateId
integer

A template to render and measure. Provide this OR message.

​
variables
object

Values substituted into the template's placeholders (when using templateId).

Response

Segment usage for the message.

​
encoding
enum<string>
required

Encoding the message is sent with. Any non-GSM-7 character (emoji, smart quotes, most CJK) forces the whole message to UCS-2.

Available options:
GSM-7,
UCS-2
​
characterCount
integer
required

Number of characters in the message.

​
segmentCount
integer
required

Number of SMS segments the message will use.

​
maxCharsPerSegment
integer
required

Max characters per segment for the chosen encoding (160 GSM-7, 70 UCS-2).

​
gsm7Length
integer

Length in GSM-7 units (extended characters such as { } [ ] ~ \ | ^ € cost 2).

​
messageSizeBits
integer

Total message size in bits.