Messages

Gets the messages for a specific subscriber

Retrieves any messages sent / received for a specific subscriber. The messages will be ordered by date descending, so the newest messages will appear at the top.

get/endpoints/messages/{phoneNumber}

Request

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

Path parameters

phoneNumberstring required

The phone number of the member

Query parameters

limitinteger

Response

OK

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)

deliveryStatus'FAILED' | 'ACCEPTED' | 'DELIVERED' | 'ISSUED' | 'REJECTED' | 'UNKNOWN' | 'PENDING' | 'STAGING' | 'N/A'

The status of the message (read only).

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.