Text Message Report

POST /api/reports/sms-report/{crm_id}

Overview

Returns a paginated log of all text communication—both inbound and outbound—within a specified date range for a given CRM instance. Includes metadata such as message direction, send method, delivery status, sender/recipient details, and message content.

Note: This report is scoped to a single {crm_id}. To retrieve SMS logs across multiple branches, you must call the endpoint for each relevant CRM instance.

Endpoint

  • POST

    https://secure-api.setshape.com/api/reports/sms-report/{crm_id}

Headers

  • Authorization: {SHAPE_API_KEY}

Request Parameters

Send the following parameters in the request body under the filters object:

  • Parameter

    fromDate


    toDate


    slctPerPage


    pn

  • Type

    String


    String


    Number


    Number

  • Description

    Start date of the report (YYYY-MM-DD)

    End date of the report (YYYY-MM-DD)

    Number of results per page


    Page number (for pagination)

Example Request Body

{

  “filters”: {

    “fromDate”: “2025-08-01”,

    “toDate”: “2025-08-08”,

    “slctPerPage”: 3,

    “pn”: 1

  }

}

Sample Response

{

  “status”: 1,

  “msg”: “success”,

  “data”: [

    {

      “templateId”: “”,

      “leadname”: “Mary Reed”,

      “sentto”: “(469) 523-9325”,

      “sentby”: null,

      “sentfrom”: “(770) 436-3877”,

      “senton”: “08/08/2025 11:57 PM”,

      “smsMethod”: “Manual”,

      “direction”: “Inbound”,

      “messageUUID”: “8213e644-733d-48bf-9096-5bdc9e8a69ad”,

      “messageType”: “SMS”,

      “status”: “Success”,

      “remark”: “”,

      “message”: “By law and read it on the paperwork I have 3 days to cancel before it is final and I need to see everything mary”

    }

  ]

}

Key Fields

  • Field

    templateId


    leadname


    sentto


    sentby


    sentfrom


    senton


    smsMethod


    direction


    messageUUID


    messageType


    status


    remark


    message

  • Description

    ID of the SMS template used, if applicable


    Name of the contact or lead associated with the message

    Recipient's phone number


    Name of the user who sent the message (if outbound)

    Phone number the message was sent from


    Timestamp of when the SMS was sent or received

    Indicates how the message was sent (e.g., Manual, Notification, Triggered)

    Message direction (Inbound or Outbound)


    Unique identifier for the message


    Type of message (typically "SMS")


    Delivery status (e.g., Success, Failed


    Any additional notes or system messages (e.g., "SMS sent successfully.")

    Actual body/content of the text message

Get started with Shape today