Messages

Send a message

Allows messages to be sent to members. Members must be fully opted-in in order to be sent a message, otherwise this operation will reject the call. If a message is longer than 160 characters - using the GSM character set (https://en.wikipedia.org/wiki/GSM_03.38) - then the message will be split into multiple 140 character parts.

If any characters fall outside of the supported GSM character set then the message will be converted to UTF-16 (https://en.wikipedia.org/wiki/UTF-16) and split into multiple 70 character parts. The parts will be reconstructed and displayed to the member as a single message on their handset.

post/endpoints/messages

Request

Base URL: https://app.hullo.me/api
URL: https://app.hullo.me/api/endpoints/messages
Auth: API key in header X-API-KEY

Request body

idstring

The unique ID for the message once submitted

issueDatestring date-time

The date the message was will be / was issued. When sending a message this date should be at least 2 minutes in the future

phoneNumberstring phone-number required

The phone number the message was sent to / received from

messageTextstring required

The message text to send / was sent to the member

fullNamestring

The full name of the member the message was sent to (read only)

inboundboolean

If the message was received from a members phone then this will be marked as true (read only)

The status of the message (read only).

Example request

{
  "messageText": "messageText",
  "phoneNumber": "phoneNumber",
  "inbound": true,
  "fullName": "fullName",
  "id": "id",
  "issueDate": "2000-01-23T04:56:07.000+00:00",
  "deliveryStatus": null
}

Response