Text Message

TextMessages.get

Returns the TextMessage record with the given id.

get/entities/TextMessages/{id}

Request

Path parameters

idstring uuid required

Id of the TextMessage record to retrieve.

Query parameters

expandstring

Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts.

Response

The TextMessage record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "chat_conversation_id": "01234567-abcd-dcba-ffff-000000000000",
    "content": "string",
    "datetime_sent": "2019-01-01T00:00:00",
    "direction": 1,
    "message_sid": "string",
    "score": 1,
    "status": 1,
    "text_message_conversation_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "content_as_html": "string",
    "data": "blob",
    "topic_prompts": "blob"
  }
}

Changes

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