Texts
Send Texts
Send texts to recipients.
URL
/messages
Method
POST
Data parameters
message=[string]
A message to text to a recipient.
recipients=[[string]]
A list of phone numbers to send to. International calling code required.
attachments=[{name: image.jpg, data: abc123 }]
A list of hashes where 'name' is desired File Name and 'data' is strict encoded base64.
Success Response
Code: 200
Content:
{
"tracking_id": "123f2db6-4558-46f9-90d8-8e6765c5b857"
}
Fetch a Text
Return json data about a text.
URL
/messages/:id
Method
GET
Success Response
Code: 200
Content:
{
"message": "Hello World!",
"customer_id": "1",
"priority": "medium",
"id": "123f2db6-4558-46f9-90d8-8e6765c5b857"
}
Fetch Texts
Return json data about texts scoped by customer.
URL
/messages
Method
GET
Data parameters
page=[integer]
Page number to return.
items=[integer]
How many items per page.
order=[string]
Direction to sort.
order_by=[string]
Field to sort on.
Success Response
Code: 200
Content:
{
"data": [{
"message": "Hello World!",
"customer_id": "1",
"priority": "medium",
"id": "123f2db6-4558-46f9-90d8-8e6765c5b857"
}]
}