Skip to navigation
REST ClientLogsMessage Logs

list

View as MarkdownOpen in Claude

List message log entries.

Query parameters

include_deletedbooleanOptionalDefaults to false
Include logs for deleted activity.
created_beforestringOptional
Return logs for activity prior to this date.
created_onstringOptional
Return logs for activity on this date.
created_afterstringOptional
Return logs for activity after this date.
page_sizeintegerOptional1-1000Defaults to 50
Specify the number of results to return on a single page. The default page size is `50` and the maximum is `1000`.
page_numberintegerOptional>=0Defaults to 0
Page number to retrieve. Requires `page_token` when greater than `0`.
page_tokenstringOptional
Token for cursor-based pagination. Required when `page_number` is greater than `0`. The token is returned in pagination links.

Response

datalist of objectsRequired
Array of message log entries

Response Example

Response
{
  "links": {
    "self": "https://example.signalwire.com/api/messaging/logs?page_number=0&page_size=50",
    "first": "https://example.signalwire.com/api/messaging/logs?page_size=50",
    "next": "https://example.signalwire.com/api/messaging/logs?page_number=1&page_size=50&page_token=PA6ad4c839-9329-43fe-83c6-fbe7c38583ff",
    "prev": "https://example.signalwire.com/api/messaging/logs?page_number=0&page_size=50&page_token=PA6ad4c839-9329-43fe-83c6-fbe7c38583ff"
  },
  "data": [
    {
      "id": "string",
      "from": "+12077447397",
      "to": "+12029921413",
      "status": "failed",
      "direction": "inbound",
      "kind": "sms",
      "source": "laml",
      "type": "relay_message",
      "url": "https://example.signalwire.com/api/laml/2010-04-01/Accounts/c38dacad-2f6c-4de1-93d6-cc732e0c70c5/Messages/9ee38635-899a-490a-bfd1-9e72f5eea53c",
      "number_of_segments": 1,
      "charge": 0,
      "charge_details": [
        {
          "description": "Inbound SMS",
          "charge": 0.00415
        }
      ],
      "created_at": "2024-05-06T12:20:00Z",
      "error_message": "From number is not a SMS-capable phone number.",
      "error_code": "21601"
    }
  ]
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});
const messages = await client.logs.messages.list({ page_size: 20 });
for (const msg of messages.data ?? []) {
    console.log(msg.from, "->", msg.to, msg.status);
}