SMS
Updated at January 7th, 2025
Sending customers SMS messages (Texting) requires an initial opt-in step, which is not offered by Cirrus and is the sole responsibility of the sending entity (Business).
POST: Send Initial SMS
This API sends the initial conversation text message to the user
https://api.commbox.io/sms/sendinitialtext/{ENCRYPTED_STREAM_ID}/{PHONE_NUMBER}
path Parameters
|
ENCRYPTED_STREAM_ID required
|
string
Cirrus generated encryption for the channel |
|
PHONE_NUMBER required
|
integer <int64>
A valid phone number for the customer |
Response Schema: application/json
| status | string
|
| description | string
|
| response_time | string
|
| data | string |
POST: Sends SMS
This API sends SMS (Texting) to the customer.
Required body parameters include the phone number with country code and the message.
https://api.commbox.io/sms/sendsms/{ENCRYPTED_STREAM_ID}
path Parameters
|
ENCRYPTED_STREAM_ID required
|
string
Cirrus generated encryption for the channel |
Request Body schema: application/json
Optional description for new mail object in Markdown
object
|
|||||
| |||||
Response Schema: application/json
| status | integer
|
| description | string
|
| response_time | string
|
| data | string |
