Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
SMS

Send to Segment

Send a message to a Segment via SMS.

post/communications/send_sms/segment

Headers

x-api-keystring required

A valid api key. If you don't have one, please request one through the Web Integration screen.

Request body

send_from_group_phone_number_idinteger required

group number id, use the GET group_phone_numbers endpoint to get the list

send_to_segment_idinteger required

segment id

bodystring

message body

Example request

{
  "send_from_group_phone_number_id": 1234567891234567,
  "send_to_segment_id": 1234567891234567
}

Response

send sms to segment response

bodystring required

message body

Example response

{
  "conversations": [
    {
      "sent_datetime": "2014-12-31T23:59:59.938Z"
    }
  ]
}