Skip to main content
POST
/
sms
Start outbound SMS conversation
curl --request POST \
  --url https://api.helloannie.com/v1/sms \
  --header 'Content-Type: application/json' \
  --data '
{
  "fromNumber": "+15551234567",
  "toNumber": "+15559876543",
  "message": "Hi Sarah, this is Annie from Bright Smiles Dental. We wanted to reach out about scheduling your next cleaning appointment.",
  "patientInfo": {
    "firstName": "Sarah",
    "lastName": "Johnson",
    "dateOfBirth": "1988-03-22T00:00:00.000Z",
    "patientId": "PAT-10432"
  },
  "appointmentInfo": {
    "startTime": "2025-03-10T15:00:00-06:00",
    "endTime": "2025-03-10T15:30:00-06:00",
    "appointmentTypeId": "apt-type-cleaning",
    "appointmentDescription": "6-month routine cleaning and exam",
    "appointmentId": "81260683"
  },
  "context": "Confirming upcoming cleaning appointment scheduled for March 10th at 3:00 PM"
}
'
{
  "success": true,
  "data": {
    "conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Body

Request body for starting an outbound SMS conversation

​
fromNumber
string
required

The Annie phone number to send SMS from (must be configured in the system)

Example:

"+15551234567"

​
toNumber
string
required

The phone number to send SMS to

Example:

"+15559876543"

​
message
string
required

The initial SMS message to send to the patient

Required string length: 1 - 500
Example:

"Hi Sarah, this is Annie from Bright Smiles Dental. We wanted to reach out about scheduling your next cleaning appointment. Would you like to set something up?"

​
patientInfo
object

Patient information for the call

Example:
{
  "firstName": "Sarah",
  "lastName": "Johnson",
  "dateOfBirth": "1988-03-22T00:00:00.000Z",
  "patientId": "PAT-10432"
}
​
appointmentInfo
object

Appointment information for context during the call

Example:
{
  "startTime": "2025-03-10T15:00:00-06:00",
  "endTime": "2025-03-10T15:30:00-06:00",
  "appointmentTypeId": "apt-type-cleaning",
  "appointmentDescription": "6-month routine cleaning and exam",
  "appointmentId": "81260683"
}
​
context
string

Context about the SMS conversation being initiated

Maximum string length: 500
Example:

"Confirming upcoming cleaning appointment scheduled for March 10th at 3:00 PM"

Response

Response returned when an outbound SMS conversation is successfully initiated

​
success
enum<boolean>
required
Available options:
true
​
data
object
required

Data returned when an outbound SMS conversation is successfully initiated